Skip to content

Commit 0eeb95b

Browse files
committedAug 20, 2018
Add description and command line detail to readme
1 parent ca252cf commit 0eeb95b

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed
 

‎readme.md

+36-9
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,49 @@
1-
# HPC Pack MESOS framework
1+
# HPC Pack MESOS Framework
22
[![Build Status](https://travis-ci.org/amat27/hpcpack-mesos.svg?branch=master)](https://travis-ci.org/amat27/hpcpack-mesos)
33

4-
A MESOS scheduler framework which accepts offers from MESOS master and builds HPC Pack compute nodes for existing HPC cluster.
4+
A MESOS scheduler framework, which accepts offers from MESOS master and builds HPC Pack compute nodes for existing HPC cluster.
55

6-
## Install
7-
### Dependency
6+
## Why do I need HPC Pack MESOS Framework
7+
With the help of HPC Pack MESOS Framework, resource allocation of Microsoft HPC Pack cluster can be managed by existing MESOS cluster, which increases resource utilization.
8+
9+
## What can HPC Pack MESOS Framework do
10+
HPC Pack Mesos Framework
11+
- Borrows HPC Pack compute nodes from Mesos cluster, if
12+
- HPC Pack has queueing tasks need more resource
13+
- Mesos cluster has available resource for HPC Pack
14+
15+
- Returns HPC Pack compute nodes to Mesos cluster, if
16+
- The node reached idle time out of Mesos framework
17+
18+
## Installation
19+
#### Dependency
820
* Python 2.7
921
* pipenv
1022

11-
### Steps
23+
#### Installation Steps
1224
1. Clone this repository
1325
2. CD to the project folder
14-
3. `pipenv install`
26+
3. Run command `pipenv install`
27+
4. (Optional) You can get Show help info by typing `pipenv run python hpcframework.py -h`
28+
29+
## Command-line usage
30+
usage: hpcframework.py [-h] [-g NODE_GROUP] script_path setup_path headnode ssl_thumbprint client_cert
31+
32+
HPC Pack Mesos framework
33+
34+
positional arguments:
35+
script_path Path of HPC Pack Mesos slave setup script (e.g. setupscript.ps1)
36+
setup_path Path of HPC Pack setup executable (e.g. setup.exe)
37+
headnode Hostname of HPC Pack cluster head node
38+
ssl_thumbprint Thumbprint of certificate which will be used in installation and communication with HPC Pack cluster
39+
client_cert .pem file of client cert used for HPC Management REST API authentication
1540

16-
### Show help info
17-
``` pipenv run python hpcframework.py -h```
41+
optional arguments:
42+
-h, --help show this help message and exit
43+
-g NODE_GROUP, --node_group NODE_GROUP
44+
The node group in which we need to perform grow-shrink.
1845

1946

2047
## FAQ
21-
### Convert .pfx to .pem using [OpenSSL](https://github.com/openssl/openssl)
48+
#### Convert .pfx to .pem using [OpenSSL](https://github.com/openssl/openssl)
2249
```openssl pkcs12 -in file.pfx -out file.pem -nodes```

0 commit comments

Comments
 (0)
Please sign in to comment.