~ibmcharmers/charms/trusty/layer-ibm-platform-lsf-server/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Kevin W. Monroe
  • Date: 2017-01-26 00:37:17 UTC
  • Revision ID: kevin.monroe@canonical.com-20170126003717-iyksv4q8p2gsg1ne
format, whitespace, and test updates

README:
- make consistent with other lsf charms
- whitespace and other formatting fixes

reactive:
- whitespace fixes
- remove superfluous '|| true' calls

tests:
- fix incorrect relation
- sentry on correct status
- skip deployment test since it requires private resource
- chmod tests.yaml to 644

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Charm for IBM Platform LSF Server V9.1.3
2
 
 
3
 
 
4
 
Overview
5
 
--------
6
 
 
7
 
IBM Platform LSF Server
8
 
 
9
 
IBM Platform LSF is a powerful workload management platform for demanding, distributed High Performance Computing (HPC) environments. 
 
1
# Overview
 
2
 
 
3
IBM Platform LSF Server v9.1.3
 
4
 
 
5
IBM Platform LSF is a powerful workload management platform for demanding, distributed High Performance Computing (HPC) environments.
10
6
It provides a comprehensive set of intelligent, policy-driven scheduling features that enable you to utilize
11
7
all of your compute infrastructure resources and ensure optimal application performance.
12
8
 
13
 
A `LSF Server` host is a server host that are capable of submitting and executing jobs. They cannot be selected as LSF Master incase the designated LSF Master goes down.
 
9
A `LSF Server` host is a server that is capable of submitting and executing jobs. They cannot be selected as LSF Master incase the designated LSF Master goes down.
14
10
 
15
11
More information available at the [IBM Knowledge Center] [platform-lsf-info]
16
12
 
17
13
**Please note that the LSF charms (LSF Storage, LSF Master and LSF Server) will create LSF cluster having same host type (either x86 or ppcle). LSF supports different host types to be part of LSF Cluster. But the LSF charms as of now supports same host type model only (So all the hosts ie master, server should have same machine architecture either x86 or ppcle).**
18
14
 
19
15
 
20
 
Usage
21
 
-----
 
16
# Usage
22
17
 
23
 
This charm will not download or requires any LSF product binaries as its being handled by `IBM Platform LSF Storage` charm.
 
18
This charm will not download or require any LSF product binaries as that is being handled by the `IBM Platform LSF Storage` charm.
24
19
The LSF installation/configuration files will be shared when a relation is added between LSF Storage and LSF Server (using NFS).
25
20
 
26
 
Deploy
27
 
------
28
 
 
29
 
This charm will deploy only LSF Server. Functionally this charm will do nothing, to have a working LSF Cluster you need to add relation between LSF Server-LSF Storage charm 
30
 
and between LSF Server-LSF Master charm.
 
21
 
 
22
# Deploy
 
23
 
 
24
This charm will deploy only LSF Server. Functionally this charm will do nothing. To have a working LSF Cluster, you need to add relations between LSF Server and LSF Storage
 
25
and between LSF Server and LSF Master.
31
26
 
32
27
To deploy IBM Platform LSF Server charm, follow the below steps:
33
28
 
34
29
 
35
30
1) Deploy the LSF Storage charm
36
 
    
37
 
       juju deploy ibm-platform-lsf-storage --resource ibm_lsf_installer=</path/to/installer.tar.Z> --resource ibm_lsf_installation_x86=</path/to/installation.tar.Z> --resource ibm_lsf_entitlement_file=</path/to/entitlement.dat>
38
 
**Note**: The resource for getting the Installation/Distribution is different for x86 and Power, so if you are deploying on x86 machines, use resource name as 
 
31
 
 
32
    juju deploy ibm-platform-lsf-storage \
 
33
      --resource ibm_lsf_installer=</path/to/installer.tar.Z> \
 
34
      --resource ibm_lsf_installation_x86=</path/to/distribution.tar.Z> \
 
35
      --resource ibm_lsf_entitlement_file=</path/to/entitlement.dat>
 
36
**Note**: The resource for getting the Installation/Distribution is different for x86 and Power, so if you are deploying on x86 machines, use resource name as
39
37
`ibm_lsf_installation_x86` and for Power as `ibm_lsf_installation_ppcle`
40
 
       
 
38
 
41
39
2) Deploy the LSF Master charm
42
 
       
43
 
       juju deploy ibm-platform-lsf-master 
44
 
 
 
40
 
 
41
    juju deploy ibm-platform-lsf-master
 
42
 
45
43
3) Deploy the LSF Server charm
46
44
 
47
 
       juju deploy ibm-platform-lsf-server 
 
45
    juju deploy ibm-platform-lsf-server
48
46
 
49
47
4) Add a relation between LSF Storage and LSF Master and LSF Storage and LSF Server to share the LSF installation and configuration files
50
48
 
51
 
       juju add-relation ibm-platform-lsf-storage ibm-platform-lsf-server
52
 
       juju add-relation ibm-platform-lsf-storage ibm-platform-lsf-master
53
 
       
 
49
    juju add-relation ibm-platform-lsf-storage ibm-platform-lsf-server
 
50
    juju add-relation ibm-platform-lsf-storage ibm-platform-lsf-master
 
51
 
54
52
5) Add a relation between LSF Master and LSF Server.
55
 
  
56
 
       juju add-relation ibm-platform-lsf-master ibm-platform-lsf-server
57
 
 
58
 
       
59
 
### To add more units of LSF Server
60
 
       juju add-unit ibm-platform-lsf-server
 
53
 
 
54
    juju add-relation ibm-platform-lsf-master ibm-platform-lsf-server
 
55
 
 
56
 
 
57
## Add units of LSF Server
 
58
 
 
59
    juju add-unit ibm-platform-lsf-server
61
60
This will add one more LSF Server host to your existing LSF Cluster.
62
61
 
63
 
 
64
 
### Verification of LSF Cluster
 
62
## Remove units of LSF Server
 
63
 
 
64
    juju remove-unit <unit name of the LSF Server you want to remove>
 
65
This will remove the unit from the existing LSF Cluster. (LSF conf files will be updated and LSF files will be unmounted)
 
66
 
 
67
### Removing Relations
 
68
A LSF Server is related to IBM Platform LSF Storage charm as well as IBM Platform LSF Master charm. In case you want to remove the relation between these, refer to the below steps:
 
69
 
 
70
    juju remove-relation ibm-platform-lsf-master ibm-platform-lsf-server
 
71
This will remove the server host information from the lsf configuration files and the server host will no longer be part of the existing LSF Cluster. The LSF Server Daemons will be stopped.
 
72
 
 
73
    juju remove-relation ibm-platform-lsf-storage ibm-platform-lsf-server
 
74
This will unmount the LSF shared installation files.
 
75
 
 
76
## Verify the LSF Cluster
65
77
Once the IBM Platform LSF Server is deployed successfully and relation is established between LSF Storage and LSF Server and LSF Master and LSF Server, you can verify your LSF cluster by running some lsf commands as mentioned below:
66
78
 
67
79
- Login into the machine where LSF Server is installed as lsf administrator user `lsfadmin`
68
 
 
 
80
 
69
81
- Export the lsf profile path: `. /usr/share/lsf/conf/profile.lsf`
70
82
 
71
 
- Go to the path  `/usr/share/lsf/9.1/linux2.6-glibc2.3-x86_64/bin(the distribution folder will change based upon Operating System, for Power the path would be /usr/share/lsf/9.1/linux3.10-glibc2.17-ppc64le/bin` and you can issue commands like `lsid`, `lshosts`, `bhosts` to verify your cluster is up and fine.
 
83
- Go to the path `/usr/share/lsf/9.1/linux2.6-glibc2.3-x86_64/bin`. The distribution folder will change based upon Operating System, for Power the path would be `/usr/share/lsf/9.1/linux3.10-glibc2.17-ppc64le/bin` and you can issue commands like `lsid`, `lshosts`, `bhosts` to verify your cluster is up and fine.
72
84
 
73
85
- For submitting jobs you can issue command `bsub` `<job>`, for example: `bsub pwd`
74
86
 
75
87
 
76
 
### To remove the units of LSF Server
77
 
    
78
 
     juju remove-unit <unit name of the LSF Server you want to remove>
79
 
This will remove the unit from the existing LSF Cluster. (LSF conf files will be updated and LSF files will be unmounted)
80
 
 
81
 
#### Removing Relations
82
 
A LSF Server is related to IBM Platform LSF Storage charm as well as IBM Platform LSF Master charm. In case you want to remove the relation between these, refer to the below steps:
83
 
      
84
 
     juju remove-relation ibm-platform-lsf-master ibm-platform-lsf-server
85
 
This will remove the server host information from the lsf configuration files and the server host will no longer be part of the existing LSF Cluster. The LSF Server Daemons will be stopped.
86
 
      
87
 
     juju remove-relation ibm-platform-lsf-storage ibm-platform-lsf-server
88
 
This will unmount the LSF shared installation files.
89
 
 
90
 
 
91
 
 
92
 
 
93
 
IBM Platform LSF Information
94
 
----------------------------
 
88
# IBM Platform LSF Information
 
89
 
95
90
(1) General Information
96
91
 
97
92
Information on IBM Platform LSF available at the [IBM Knowledge Center] [platform-lsf-info]
110
105
[license-info]: http://www-03.ibm.com/software/sla/sladb.nsf/search
111
106
 
112
107
[platform-lsf-info]: https://www-01.ibm.com/support/knowledgecenter/SSETD4_9.1.3/lsf_kc_unix_install.dita
113
 
 
114
 
 
115
 
 
116
 
 
117