~geethas1/charms/trusty/ibm-platform-ac/ibm-pac-fix

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Geetha S
  • Date: 2015-11-04 02:36:10 UTC
  • Revision ID: geethas1@in.ibm.com-20151104023610-vz1kb5vpfysy3dhw
Initial checkin for Platform Application Center

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Charm for IBM Platform LSF Standard Edition V 9.1.3
 
1
Charm for IBM Platform Application Center(PAC) Standard Edition V 9.1.4.1
2
2
 
3
3
Overview
4
4
--------
5
 
 
6
 
IBM Platform LSF Standard Edition
7
 
 
8
 
IBM Platform LSF is a powerful workload management platform for demanding, distributed HPC environments. 
9
 
It provides a comprehensive set of intelligent, policy-driven scheduling features that enable you to utilise
10
 
all of your compute infrastructure resources and ensure optimal application performance.
11
 
 
12
 
For details on Platform LSF, as well as information on purchasing,
13
 
please visit:
14
 
 
15
 
[Product Page] [product-page] and at the [Passport Advantage Site] [passport-lsf].
16
 
 
17
 
More information available at the [IBM Knowledge Center] [platform-lsf-info]
18
 
 
 
5
IBM Platform Application Center available as an add-on module to IBM Platform LSF, Platform Application Center provides a flexible, 
 
6
easy to use interface for cluster users and administrators that is easy to use and manage.
 
7
 
 
8
IBM Platform Application Center(PAC) Standard Edition provides not only basic job submission and job and host monitoring, but also default submission templates,
 
9
role-based access control, reporting, customization, and remote visualization capabilities.
 
10
 
 
11
Platform Application Center allows you to monitor hosts and jobs, as well as submit jobs.
 
12
 
 
13
For details on Platform Application Center(PAC), as well as information on purchasing, please visit:
 
14
 
 
15
[Product Page] [product-page] and at the [Passport Advantage Site] [passport-pac].
 
16
 
 
17
More information available at the [IBM Knowledge Center] [platform-ac-info]
19
18
 
20
19
Usage
21
20
-----
22
 
Download your licensed `IBM Platform LSF Standard 9.1.3` version for Ubuntu and upload it to your apache
23
 
repository.This charm will deploy only the Standard edition for Platform LSF. To download and install the
24
 
code contained in this charm you must agree to the IBM license. You can view the full license for IBM Platform
25
 
LSF by visiting the [Software license agreements search website][license-info]. 
26
 
Search for "IBM Platform LSF, V9.1.3" and choose the license that applies
27
 
to the version you are using.
28
 
 
29
 
For `x86_64 Ubuntu` , the packages and their part numbers are :
30
 
        
31
 
    IBM Platform LSF V9.1.3 Installer Package for Linux x86-64 (CN2PJEN)
32
 
    IBM Platform LSF V9.1.3 Installation Package for LINUX on x86-64 Kernel 2.6 & 3.x English (CN11MEN)
33
 
 
34
 
For `Power Ubuntu` , the packages and their part numbers are :
35
 
 
36
 
    IBM Platform LSF V9.1.3 Installer Package for Linux on Power 8 LE English (CN5AGEN) 
37
 
    IBM Platform LSF V9.1.3 Installation Package for Linux on Power 8 LE English (CN5AHEN ) 
38
 
 
39
 
As the charm will be deploying `LSF Standard Edition`,the `platform_lsf_std_entitlement.dat` file
40
 
will be same accross the LSF Standard Edition packages.Place this file in `/files/archive` folder of 
41
 
platform-lsf charm.The part number for the entitlement file is :
42
 
 
43
 
    IBM Platform LSF V9.1.3 Standard Edition Entitlement File Multiplatform English(CN11PEN ) 
44
 
 
45
 
# Creating the repositories in Apache
46
 
Run steps below with admin access
47
 
 
48
 
Install the required packages
49
 
        apt-get install dpkg-dev apache2
50
 
 
51
 
Create a repository on Apache server under your Apache repository directory.
52
 
    
53
 
        cd <apache-repository-directory>
54
 
        mkdir platform-lsf
55
 
Place the downloaded Platform LSF distribution packages,installation packages and entitlement files in the above directory
56
 
Configure Apache server to allow access to the repository.
57
 
Configure config.yaml with the repository url
58
 
 
59
 
 Example : lsf_url: "http://<server-name>/<REPOSITORY_DIR>/platform-lsf"
60
 
 
61
 
 Verify repository is set correctly otherwise charm might throw errors.
 
21
 
 
22
Download your licensed `IBM Platform Application Center 9.1.4.1` and download `MySQL JDBC Driver` from [mysql-jdbc-jar] and upload it to your SFTP repository.
 
23
 
 
24
To download and install the code contained in this charm you must agree to the IBM license.
 
25
 
 
26
You can view the full license for IBM Platform Application Center by visiting the [Software license agreements search website][license-info].
 
27
Search for "IBM Platform Application Center for POWER" and choose the license that applies to the version you are using.
 
28
 
 
29
For Power (ppcle) Ubuntu, the package is:
 
30
 
 
31
IBM Platform Application Center 9.1.4.1 (pac9.1.4.1_standard_linux-ppc64le.tar.Z)
 
32
 
 
33
MySQL JDBC Driver package is:
 
34
 
 
35
MySQL JDBC Driver(mysql-connector-java-5.1.36.tar.gz)
62
36
 
63
37
 
64
38
Deploy
65
39
------
66
 
For creating IBM Platform LSF cluster , deploy Master host and slave host , as shown below:
67
 
 
68
 
    juju deploy --repository=<path_to_charms_folder> local:trusty/platform-lsf platform-lsf-master 
69
 
    juju deploy --repository=<path_to_charms_folder> local:trusty/platform-lsf platform-lsf-slave
70
 
 
71
 
At this point Platform LSF install will wait for you to accept the License. To install the downloaded binaries
72
 
you must agree to the IBM license. 
73
 
 
74
 
If the URL and package is configured in the config.yaml:
75
 
        
76
 
    juju set platform-lsf-master accept-ibm-lsf-license=True 
77
 
    juju set platform-lsf-slave accept-ibm-lsf-license=True 
78
 
If not,
79
 
        
80
 
     juju set  platform-lsf-master accept-ibm-lsf-license=True lsf_url=<repository URL> cfg_lsfdistribution_pkg_name=<Distribution Package name> cfg_lsfinstall_pkg_name=<Installation package name>
81
 
 
82
 
Once both master and slave are deployed , add relation between the platform-lsf-slave and platform-lsf-master charm
83
 
 
84
 
 Note : Actual installation of slave host takes place in slave-relation-changed hook ,once relation is established
85
 
 
86
 
For adding the relation , run the below command
87
 
 
88
 
    juju add-relation platform-lsf-slave:slave platform-lsf-master
89
 
 
90
 
Removing relation between master and slave
91
 
 
92
 
    juju remove-relation platform-lsf-slave:slave platform-lsf-master
93
 
 
94
 
#If you want to upgrade the LSF with new packages , then
95
 
 
96
 
Remove the relation between slave node and master
97
 
 
98
 
    juju remove-relation platform-lsf-slave:slave platform-lsf-master
99
 
 
100
 
Deploy the master node with updated package as shown below
101
 
 
102
 
    juju set platform-lsf-master cfg_lsfinstall_pkg_name=<Updated Install package name> cfg_lsfdistribution_pkg_name=<Updated Distribution package name>
103
 
 
104
 
Deploy the slave node with updated package as shown below
105
 
      
106
 
    juju set platform-lsf-slave cfg_lsfinstall_pkg_name=<Updated Install package name> cfg_lsfdistribution_pkg_name=<Updated Distribution package name>
107
 
Add the relation between master and slave again
108
 
 
109
 
    juju add-relation platform-lsf-slave:slave platform-lsf-master
110
 
 
111
 
#Growing Cluster
112
 
You can add more slave nodes to the master, by redeploying the charm, as shown below
113
 
 
114
 
    juju deploy platform-lsf platform-lsf-slave1
115
 
    juju deploy platform-lsf platform-lsf-slave2  
116
 
    ....and so on
117
 
 
118
 
If you have added more slave nodes, then accept license for those machines as well:
119
 
 
120
 
    juju set platform-lsf-slave1 accept-ibm-lsf-license=True
121
 
    juju set platform-lsf-slave2 accept-ibm-lsf-license=True
122
 
 
123
 
For each of the added slave, add relation between the platform-lsf-master and new slave node, like 
124
 
 
125
 
    juju add-relation platform-lsf-slave1:slave platform-lsf-master
126
 
    juju add-relation platform-lsf-slave2:slave platform-lsf-master
127
 
 
128
 
 
129
 
 
 
40
To deploy ibm-platform-ac charm, you need MySQL charm, IBM Platform LSF charm and apache2 charm.
 
41
 
 
42
The Platform Application Center(PAC) charm has to be deployed to a container that has the IBM Plaform LSF software installed under the /usr/share/lsf/ directory.
 
43
 
 
44
A separate charm for IBM Platform LSF is available for the same. 
 
45
 
 
46
Deploy MySQL charm in can be deployed in the same container where your Platform Application Center(PAC) and IBM Plaform LSF software are deployed or it can be deployed in a different container.
 
47
 
 
48
Deploy apache2 charm to install Platform Application Center (PAC) with High Availability. 
 
49
 
 
50
 
 
51
###### Steps to deploy ibm-platform-ac charm, If you use `Local DB`:
 
52
 
 
53
        1. juju deploy mysql --to <machine-id>
 
54
        
 
55
Please go through the mySQL README file to deploy MySQL charm.
 
56
        
 
57
        2. juju deploy ibm-platform-ac platform-ac-service --to <machine-id>
 
58
        
 
59
<machine-id> is the container where Platform LSF Master is deployed.
 
60
 
 
61
PAC Charm downloads the install packages from the SFTP server that can be setup in your network. An action called 'download' is provided for the same:
 
62
 
 
63
    juju action do <unit name> download username=<sftp user> password=<sftp password> packagedir=<full path to repository directory> host=<sftp host name>
 
64
 
 
65
The packagedir path should contain full path, So that we could download all the files present in that directory. 
 
66
 
 
67
e.g.
 
68
 
 
69
        juju action do platform-ac-service/0 download username="<sftp user>" password="<sftp password>" host="<ip_address or host_name>" packagedir="/home/charm/repository/platform-ac/*"
 
70
 
 
71
At this point Platform Application Center install will wait for you to accept the IBM License. To install the downloaded binaries you must agree to the IBM license:
 
72
 
 
73
        juju set platform-ac-service accept-ibm-pac-license=True
 
74
        
 
75
Now add the relation between Mysql and platform-ac-service to install PAC.
 
76
 
 
77
        juju add-relation platform-ac-service:db mysql:db
 
78
 
 
79
To remove relation between Mysql and Platform-ac-service, run the below command.
 
80
 
 
81
    juju remove-relation platform-ac-service:db mysql:db
 
82
        
 
83
After installing IBM Platform Application Center(PAC), Use your web browser to start the PAC Console. The URL for the PAC Console is:
 
84
 
 
85
        http://pac_host:8080/platform
 
86
        
 
87
Here pac_host is an ip address where Platform Application Center is installed. Login the Platform Application Center with LSF administrator name and password.
 
88
 
 
89
The default LSF administrator name is `lsfadmin`, and the default password for this account is `lsfadmin`.
 
90
 
 
91
 
 
92
###### Steps to deploy ibm-platform-ac charm with `High Availability` and `Remote DB`:
 
93
 
 
94
It uses NFS for file sharing (Note: No separate NFS charm required, it is handled by PAC code only). 
 
95
 
 
96
If you are deploying the PAC charm on a LXC container, such as the juju local provider, there are additional steps that need to be taken prior to deployment due to NFS limitation on LXC containers.
 
97
 
 
98
 the LXC host:
 
99
 
 
100
       apt-get install nfs-common
 
101
       modprobe nfsd
 
102
       mount -t nfsd nfsd /proc/fs/nfsd
 
103
 
 
104
Edit /etc/apparmor.d/lxc/lxc-default and add the following three lines to it:
 
105
 
 
106
       mount fstype=nfs,
 
107
       mount fstype=nfs4,
 
108
       mount fstype=nfsd,
 
109
       mount fstype=rpc_pipefs,
 
110
 
 
111
after which:
 
112
 
 
113
       sudo /etc/init.d/apparmor restart
 
114
 
 
115
Once this is done, then you can deploy your IBM Platform Application Center(PAC) charm.
 
116
 
 
117
        1. juju deploy ibm-platform-ac platform-ac-master --to <master-machine-id>
 
118
        
 
119
Where <master-machine-id> is the container where Platform LSF Master is deployed.
 
120
 
 
121
        2. juju deploy ibm-platform-ac platform-ac-master-candt --to <master-candt-machine-id1>
 
122
        
 
123
where <master-candt-machine-id> is the container where Platform LSF Master Candidate is deployed.
 
124
 
 
125
Note: To enable High Availability, Select a minimum of two containers that has LSF Master Candidate is installed and run the following command to create multiple instances of PAC.
 
126
 
 
127
        juju add-unit platform-ac-master-candt --to <master-candt-machine-id2>
 
128
        
 
129
        3.juju deploy mysql
 
130
 
 
131
        4. juju deploy ibm-pac-helper
 
132
 
 
133
Please go through the ibm-pac-helper charm README file to deploy ibm-pac-helper charm.
 
134
 
 
135
        5.juju deploy apache2
 
136
 
 
137
Please go through the apache2 charm README file to deploy apache2 charm.
 
138
 
 
139
Now add relations between these charms in the following order:
 
140
 
 
141
        1. juju add-relation ibm-pac-helper mysql       
 
142
        
 
143
        2. juju add-relation platform-ac-master:master platform-ac-master-candt:master-candt
 
144
 
 
145
        3. juju add-relation platform-ac-master-candt:helper ibm-pac-helper:helper
 
146
        
 
147
Once all relations established, run the following commands to enable High Availability.
 
148
 
 
149
        juju set apache2 enable_modules="proxy proxy_http proxy_balancer lbmethod_byrequests slotmem_shm header"
 
150
        
 
151
Login to a container that has `platform-ac-master` installed and copy the `vhost.tmpl` file from `$CHARM_DIR/files` directory to your local host and provide the template file path as follows:
 
152
 
 
153
        juju set apache2 "vhost_http_template=$(base64 < vhost.tmpl)"
 
154
 
 
155
From any browser, check that you have access to Platform Application Center by entering in the URL the apache HTTP Server. 
 
156
 
 
157
        Http://<apache-http-server-host>:8080/platform
 
158
        
 
159
Here apache-http-server-host is an ip address where apache HTTP Server is installed.
 
160
 
 
161
## Removing Relations
 
162
If you want to remove the relations, then follow the below steps:
 
163
 
 
164
        1. juju remove-relation platform-ac-master-candt:helper ibm-pac-helper:helper
 
165
        
 
166
        2. juju remove-relation platform-ac-master:master platform-ac-master-candt:master-candt
 
167
        
 
168
Then remove the relation between "platform-ac-master and pac-helper"
 
169
 
 
170
        3. juju remove-relation platform-ac-master:helper ibm-pac-helper:helper
 
171
 
 
172
        
130
173
Configuration
131
174
-------------
132
175
See config.yaml file for more information.
133
176
 
134
 
`lsf_url`          
135
 
 
136
 
URL to download IBM Platform LSF packages.The url would be in this format  
137
 
http://<server-name>/<REPOSITORY_DIR>/platform-lsf.If not set or set incorrectly, the charm
138
 
cannot install the IBM Platform LSF software.
139
 
 
140
 
`accept-ibm-lsf-license`
141
 
 
142
 
The IBM Platform LSF software can only be used by accepting the terms and conditions for IBM 
143
 
Platform LSF License.Setting this option to True indicates that you have read and accepted the
144
 
IBM Platform LSF terms and conditions found in the license file. The details about accessing the
145
 
license(s) can be found in the README. Do not set this to False if a relation exists.  
146
 
 
147
 
`cfg_lsfdistribution_pkg_name`
148
 
 
149
 
IBM Platform LSF distribution package name
150
 
 
151
 
`cfg_lsfinstall_pkg_name` 
152
 
 
153
 
IBM Platform LSF Installation package name
154
 
 
155
 
`lsfdistribution_pkg_sha`
156
 
 
157
 
Checksum value to check integrity of IBM Platform LSF package. The Charm uses 
158
 
sha1sum to check the integrity. If empty, it does not carry out the integrity check.
159
 
The command to find the checksum is : sha1sum <Package Name> | cut -d" " -f1
160
 
 
161
 
`lsfinstall_pkg_sha`
162
 
 
163
 
Checksum value to check integrity of IBM Platform LSF package. The Charm uses
164
 
sha1sum to check the integrity. If empty, it does not carry out the integrity check.
165
 
The command to find the checksum is : sha1sum <Package Name> | cut -d" " -f1
166
 
 
167
 
 
168
 
IBM Platform LSF Information
 
177
`accept-ibm-pac-license`
 
178
 
 
179
The IBM Platform Application Center software can only be used by accepting the terms and conditions for IBM Platform Application Center License. Setting this option to True indicates that you have read and accepted the IBM Platform Application Center terms and conditions found in the license file. The details about accessing the license(s) can be found in the README. Do not set this to False if a relation exists.
 
180
 
 
181
IBM Platform Application Center Information
169
182
----------------------------
170
183
(1) General Information
171
 
Information on IBM Platform LSF available at the [IBM Knowledge Center] [platform-lsf-info]
 
184
Information on IBM Platform Application Center available at the [IBM Knowledge Center] [platform-ac-info]
172
185
 
173
186
(2) Download Information
174
 
Information on procuring IBM Platform LSF product is available at the 
175
 
[Passport Advantage Site][passport-lsf]
 
187
Information on procuring IBM Platform Application Center product is available at the[Passport Advantage Site][passport-ac]
176
188
 
177
189
(3) Contact Information
178
190
For issues with this charm, please contact IBM Juju Support Team <jujusupp@us.ibm.com>
179
191
 
180
192
<!-- Links -->
181
193
 
182
 
[product-page]: http://www-03.ibm.com/systems/in/platformcomputing/products/lsf/
 
194
[product-page]: http://www-03.ibm.com/systems/platformcomputing/products/lsf/applicationcenter.html
183
195
 
184
 
[passport-lsf]: http://www-01.ibm.com/software/passportadvantage/
 
196
[passport-ac]: http://www-01.ibm.com/software/passportadvantage/
185
197
 
186
198
[license-info]: http://www-03.ibm.com/software/sla/sladb.nsf/search
187
199
 
188
 
[platform-lsf-info]: https://www-01.ibm.com/support/knowledgecenter/SSETD4_9.1.3/lsf_kc_unix_install.dita
189
 
 
190
 
 
 
200
[platform-ac-info]: https://www-01.ibm.com/support/knowledgecenter/SSGSCT_9.1.4/pac_welcome.html
 
201
 
 
202
[mysql-jdbc-jar]: http://www.mysql.com/downloads/connector/j/
191
203