~ibmcharmers/charms/trusty/ibm-was-base/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Geetha S
  • Date: 2016-08-10 08:55:47 UTC
  • Revision ID: geethas1@in.ibm.com-20160810085547-z6yjc3zgtspdcg8p
Initial code checkin for WAS Base charm

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Charm for IBM WebSphere Application Server Base (WAS Base) 8.5.5.0
2
2
 
3
 
Overview
4
 
--------
 
3
## Overview
5
4
 
6
 
This charm installs IBM Installation Manager and IBM WebSphere Application Server Base software.
 
5
This charm is used ibm-im(IBM Installation Manager) charm as a base layer for installing Installation Manager(IM). This charm is installing IBM Installation Manager and IBM WebSphere Application Server Base software. 
7
6
 
8
7
`IBM WebSphere Application Server Base`
9
8
 
10
9
WebSphere Application Server is a proven, high-performance transaction engine that can help build, run, integrate, and manage dynamic web applications.
11
 
For details on IBM WebSphere Application Server, as well as information on purchasing, please visit:
12
 
[Product Page] [was-product-page] and at the [Passport Advantage Site] [Passport].
 
10
For details on IBM WebSphere Application Server Base, as well as information on purchasing, please visit: [Product Page] [was-product-page] and at the [Passport Advantage Site] [Passport].
13
11
More information available at the [IBM Knowledge Center] [WAS-Infocenter]
14
12
 
15
13
`IBM Installation Manager`
16
14
 
17
 
IBM Installation Manager is a tool that you can use to install and maintain your IBM software packages.
 
15
IBM Installation Manager(IBM IM) is a tool that you can use to install and maintain your IBM software packages.
 
16
 
18
17
In this charm IBM WebSphere Application Server Base software will be installed using IBM Installation Manager tool.
19
18
 
20
 
Usage
21
 
------          
22
 
Download your licensed IBM Installation Manager software, IBM WebSphere Application Server Base software and IBM WebSphere Application Server fixpack 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 Installation Manager` and `IBM WebSphere Application Server Base` by visiting the [Software license agreements search website][license-info].
27
 
 
28
 
Search for "IBM Installation Manager" and "IBM WebSphere Application Server" and choose the license that applies to the version you are using.
29
 
 
30
 
For (x86_64) Ubuntu , The packages are:
31
 
 
32
 
IBM Installation Manager 1.6.2 (Install_Mgr_v1.6.2_Lnx_WASv8.5.5.zip)
 
19
## Prerequisites
 
20
 
 
21
This charm makes use of resources, a feature only available in Juju 2.0. During deploy or upgrade, you will need to specify the installable package(s)
 
22
required by this charm. Download your licensed IBM WebSphere Application Server Base packages from the [Product Page][WAS-8.5.5.0-download].
 
23
 
 
24
### Packages for Ubuntu on AMD64 (x86_64):
 
25
 
 
26
IBM Installation Manager 1.8 (`agent.installer.linux.gtk.x86_64_1.8.3000.20150606_0047.zip`)
33
27
 
34
28
IBM WAS Base 8.5.5 part1 (WAS_V8.5.5_1_OF_3.zip)
35
29
 
37
31
 
38
32
IBM WAS Base 8.5.5 part3 (WAS_V8.5.5_3_OF_3.zip)
39
33
 
40
 
IBM WAS Base fixpack 8.5.5.4 part1 (8.5.5-WS-WAS-FP0000004-part1.zip)
41
 
 
42
 
IBM WAS Base fixpack 8.5.5.4 part2 (8.5.5-WS-WAS-FP0000004-part2.zip)
43
 
 
44
 
For Power (ppcle) Ubuntu, The packages are:
45
 
 
46
 
IBM Installation Manager 1.8 (agent.installer.linux.gtk.ppc64le_1.8.1000.20141126_2002.zip)
 
34
### Packages for Ubuntu on Power (ppc64le):
 
35
 
 
36
IBM Installation Manager 1.8 (`agent.installer.linux.gtk.ppc64le_1.8.3000.20150606_0047.zip`)
47
37
 
48
38
IBM WAS Base 8.5.5 part1 (WAS_V8.5.5_FOR_POWERLE_ML.zip)
49
39
 
50
40
IBM WAS Base 8.5.5 part1 (WAS_V8.5.5_2_OF_2_FOR_POWERLE_ML.zip)
51
41
 
52
 
IBM WAS Base fixpack 8.5.5.6 part1 (8.5.5-WS-WAS-LE-FP0000006-part1.zip)
53
 
 
54
 
IBM WAS Base fixpack 8.5.5.6 part2 (8.5.5-WS-WAS-LE-FP0000006-part2.zip)
55
 
 
56
 
Creating Repositories
57
 
--------------------
58
 
For deploying IBM WAS Base charm the user needs to download the correct packages as mentioned in the 'Usage' section above and keep it in an SFTP server so that the IBM WAS Base charm can connect to the SFTP server and deploy the same. The SFTP server can be any Ubuntu machine and the package needs to be kept in the path like
59
 
`/home/charm/repository/<productname>`. The path where the package is kept is a configurable item and needs to be set before deploying the charm. 
60
 
 
61
 
Memory and Disk Requirements
62
 
-----------------------------
 
42
## Usage
 
43
        
 
44
To use this charm, you must agree to the Terms of Use. You can view the full license for `IBM Installation Manager` and `IBM WebSphere Application Server Base` products by visiting the [im-license-info](http://www-03.ibm.com/software/sla/sladb.nsf/displaylis/39AFC1C1D485C4E085257E7300548B05?OpenDocument) and [was-license-info] [license-info] page.
 
45
 
 
46
Search for "IBM WebSphere Application Server" and choose the license that applies to the version you are using.
 
47
 
 
48
 
 
49
## Memory and Disk Requirements
 
50
 
63
51
Minimum 2.0 GB of disk space for installed image and Minimum 1 GB of physical memory recommended. 
64
52
 
65
53
WebSphere Application Server Charm requires 15 GB of root disk to download packages and install the IBM WebSphere Application Server Base Software. By default available root disk space is 8GB.
68
56
 
69
57
                juju set-constraints root-disk=15G
70
58
 
71
 
Deploy
72
 
------
 
59
### Deploy
 
60
 
73
61
1. Run the following commands to deploy this charm:
74
 
        
 
62
 
 
63
 
 
64
                juju deploy ibm-was-base --resource ibm_im_installer=</path/to/ibm_im_installer.zip> --resource ibm_was_base_installer1=</path/to/ibm_was_base_installer1.zip> --resource ibm_was_base_installer2=</path/to/ibm_was_base_installer2.zip> --resource ibm_was_base_installer3=</path/to/ibm_was_base_installer3.zip> 
 
65
        
 
66
        
 
67
**Note**: This charm requires acceptance of Terms of Use. When deploying from the Charm Store, these terms will be presented to you for your consideration.
 
68
To accept the terms:
 
69
 
 
70
                juju agree ibm-im/1 ibm-was-base/2
75
71
                juju deploy ibm-was-base
76
 
                
77
 
2. At this point WebSphere Application Server install will wait for you to accept the License. To install the downloaded binaries you must agree to the IBM license. If you agree to the license, run the following command (without accepting License WAS Base cannot be installed):
78
 
                
79
 
                juju set ibm-was-base accept-ibm-im-license=True accept-ibm-websphere-license=True
80
 
                
81
 
3. IBM WAS Base charm also needs an SFTP server from where the packages can be downloaded (the user has to keep the Installation Manager package and WAS Base packages on this SFTP server), the directory where the package is kept, user name and password to connect to the SFTP server, Installation Manager Package name and a checksum value for IM package to proceed with the installation. To provide these run the following command:
82
 
 
83
 
                juju set ibm-was-base host=<host-name> package_dir=<package-dir> username=<username> password=<password>
84
 
                juju set ibm-was-base im_file_name=<im-file-name>
85
 
                juju set ibm-was-base sha_im=<checksum-value>
86
 
                
87
 
        For eg:
88
 
        
89
 
                juju set ibm-was-base host="1.2.3.4" package_dir="/home/charm/repository/WAS-BASE" username="user" password="user123"
90
 
                juju set ibm-was-base im_file_name="Install_Mgr_v1.6.2_Lnx_WASv8.5.5.zip"
91
 
                juju set ibm-was-base sha_im="93e6532d2318d8268313ca62a406a23160306f81"
92
 
                
93
 
        The command to find the checksum value is sha1sum <IM Package Name> | cut -d" " -f1. Checksum values for WebSphere packages are provided in config-changed hook.
94
 
 
95
 
4. To create application server profile, `manageprofiles` command needs values for profile name, profile path, admin user name and admin password. To provide these run the following commands:
96
 
 
97
 
                juju set ibm-was-base profile_name=<profile_name>
98
 
                juju set ibm-was-base profile_path=<profile_path>
99
 
                juju set ibm-was-base was_admin_user=<user_name>
100
 
                juju set ibm-was-base was_admin_pw=<password>
101
 
                
102
 
        For eg:
103
 
 
104
 
                juju set ibm-was-base profile_name="profile01"
105
 
                juju set ibm-was-base profile_path="/opt/profiles"
106
 
                juju set ibm-was-base was_admin_user="admin1"
107
 
                juju set ibm-was-base was_admin_pw="admin123"
 
72
 
 
73
                
 
74
2. To create application server profile, `manageprofiles` command needs values for profile name, profile path, user name and password. To provide these run the following command:
 
75
 
 
76
            juju set ibm-was-base profile_name=<profile_name>
 
77
            juju set ibm-was-base profile_path=<profile_path>
 
78
            juju set ibm-was-base was_admin_user=<user_name>
 
79
            juju set ibm-was-base was_admin_pw=<password>
 
80
                
 
81
        For eg:
 
82
 
 
83
            juju set ibm-was-base profile_name="profile01"
 
84
            juju set ibm-was-base profile_path="/opt/profiles"
 
85
            juju set ibm-was-base was_admin_user="admin1"
 
86
        juju set ibm-was-base was_admin_pw="admin123"
108
87
                 
109
 
        If any of the above values is not set, then the charm will use default values for profile creation. Once WAS Base charm deployed successfully, user can also delete existing profile and create new application server profile by setting any of these configuration options. 
110
 
 
111
 
5. To Expose the IBM WAS Base Service to public, run the following command:
112
 
 
113
 
                juju expose ibm-was-base
114
 
                
115
 
6. Setting the accept-ibm-im-license and accept-ibm-websphere-license to False will uninstall the product:
 
88
        If any of these values is not set, then the charm will use default values for profile creation. Once WAS Base charm deployed successfully, user can also delete existing profile and create new application server profile by setting any of these configuration options.
116
89
        
117
 
                juju set ibm-was-base accept-ibm-im-license=False accept-ibm-websphere-license=False
118
 
                
119
 
Installation Verification
120
 
------------------------
121
 
After installing IBM WebSphere Application Server Base, use your web browser to see the WAS admin console. The URLs for WAS Base admin console are:
 
90
3. To Expose the IBM WAS Base Service to public, run the following command:
 
91
 
 
92
            juju expose ibm-was-base
 
93
 
 
94
                
 
95
### Upgrade
 
96
 
 
97
Once deployed, users can install fixpacks by upgrading the charm:
 
98
 
 
99
                juju attach ibm-was-base ibm_im_fixpack=</path/to/fixpack.zip>
 
100
                juju attach ibm-was-base ibm_was_base_fp1=</path/to/ibm_was_base_fp1.zip>
 
101
                juju attach ibm-was-base ibm_was_base_fp2=</path/to/ibm_was_base_fp2.zip>
 
102
                
 
103
                
 
104
### Verification
 
105
 
 
106
After installing IBM WebSphere Application Server Base, use your web browser to see the WebSphere Application Server admin console. The URLs for WAS Base admin console are:
122
107
 
123
108
                http://was-base-host:9060/ibm/console 
124
109
                https://was-base-host:9043/ibm/console
125
110
        
126
 
Here was-base-host represents the public ip address of your container, where WAS Base is installed. 
127
 
 
128
 
To login the WAS Base admin console use userid and password created in step 4.
129
 
 
130
 
Configuration
131
 
-------------
132
 
`host`
133
 
 
134
 
SFTP server where IBM IM and IBM WAS Base packages are kept
135
 
 
136
 
`package_dir`
137
 
 
138
 
Path to find the IBM IM and IBM WAS Base packages on the SFTP server
139
 
 
140
 
`username`
141
 
 
142
 
User name to connect to the SFTP server
143
 
 
144
 
`password`
145
 
 
146
 
Password to connect to the SFTP server
147
 
 
148
 
`accept-ibm-im-license`  
149
 
 
150
 
The IBM Installation Manager software can only be used by accepting the terms and conditions for IBM
151
 
Installation Manager License. Setting this option to True indicates that you have read and accepted the
152
 
IBM Installation Manager terms and conditions found in the license file. 
153
 
 
154
 
`accept-ibm-websphere-license`
155
 
 
156
 
The IBM WebSphere Application Server Base software can only be used by accepting the terms and conditions for IBM
157
 
WebSphere Application Server Base License. Setting this option to True indicates that you have read and accepted the
158
 
IBM WebSphere Application Server Base terms and conditions found in the license file. 
 
111
Here was-base-host represents the public ip address of your machine, where WAS Base is installed. 
 
112
 
 
113
To login the WAS Base admin console use userid and password created in step 2 in `Deploy` section.
 
114
 
 
115
 
 
116
## Relating with IBM HTTP Server charm
 
117
 
 
118
Install a web server, such as IBM Http Server in the machine where IBM WebSphere Application Server Base installed. It provides the more configuration options and additional layer of security for applications deployed on WAS Base. Installing a web server plug-in enables the web server to communicate with the application server.
 
119
 
 
120
Here IBM WAS Base charm is related to IBM HTTP Server(IHS) subordinate charm. To add a relation, run the following command:
 
121
 
 
122
                juju add-relation ibm-was-base ibm-http
 
123
        
 
124
When IBM WAS Base charm is related to IBM HTTP Server charm, 'IBM Http Server', 'Web Server Plug-ins for WebSphere Application Server' and 'WebSphere Customization Toolbox' will be installed and configured. The web server definition is automatically created and configured during the configuration of the plug-in. Once IHS configured and admin server started, server status will be sent to the WAS Base charm to automatically propagate the plugin.xml file to IHS server. This plugin.xml file contains the WAS Base server details to redirect incoming requests to the WAS Base Server.
 
125
 
 
126
### Verification
 
127
 
 
128
After establishing relation between IBM WAS Base and IBM Http Server charm, you can verify by accessing the sample servlet available in WAS Base using IHS URL and IHS running port 80:
 
129
 
 
130
                http://ihs-host-name:80/snoop
 
131
        
 
132
Here ihs-host-name represents the public ip address of your machine, where WAS Base and IHS deployed(IHS is subordinate charm so WAS Base and IHS charms will be deployed on same machine). 'snoop' is the sample servlet on WAS Base server to test the connection between WAS Base and IHS.
 
133
 
 
134
To remove the relation, run the follwing command:
 
135
 
 
136
                juju remove-relation ibm-was-base ibm-http
 
137
        
 
138
 
 
139
## Configuration
159
140
 
160
141
`profile_name`
161
142
 
173
154
 
174
155
The password used to log in WAS admin console.
175
156
 
176
 
`im_file_name`
177
 
 
178
 
Name of the IBM IM package. If not set, the Charm uses a predefined package name for download from the SFTP Server. If the predefined package is not available in SFTP server or if set incorrectly, the charm cannot install the IBM IM software.
179
 
 
180
 
`sha_im`
181
 
 
182
 
Checksum value to check integrity of IBM Installation Manager package. The Charm uses
183
 
sha1sum to check the integrity. If empty, it throws an error and stop the deployment.
184
 
The command to find the checksum is : sha1sum <Package Name> | cut -d" " -f1
185
157
                
186
 
IBM Installation Manager(IM) Information
187
 
-----------------------------------------
 
158
## IBM Installation Manager(IM) Information
 
159
 
188
160
(1) General Information
189
161
Details about IM available at [IBM Knowledge Center][Im-info].
190
162
 
192
164
Information on procuring IM product is available at the [Product Page][im-product-page]
193
165
and at the [Passport Advantage Site][passport]. 
194
166
 
195
 
IBM WebSphere Application Server Base Information
196
 
---------------------------------------------------
 
167
## IBM WebSphere Application Server Base Information
 
168
 
197
169
(1) General Information 
198
170
 
199
171
Details about IBM WAS Base software available at [IBM Knowledge Center] [WAS-Infocenter].
206
178
 
207
179
Information about installation of WAS Base on 'ppc64le' based machine available [here] [WAS-for-ppc64le]  
208
180
 
209
 
Details about WAS 8.5.5.4 fixpack download available [here] [WAS-8.5.5.4-fixpack-download].
210
 
 
211
181
A trial version is available [here] [WAS-trail-version].
212
182
 
213
183
More information about IBM IM Downloadable file and WAS Base Downloadable files available [here] [IBM-IM-more-info]
214
184
 
215
 
Contact Information
216
 
---------------------
 
185
## Contact Information
 
186
 
217
187
For issues with this charm, please contact IBM Juju Support team <jujusupp@us.ibm.com>
218
188
 
219
189
<!-- Links -->
228
198
 
229
199
[WAS-8.5.5.0-download]: http://www-01.ibm.com/support/docview.wss?uid=swg27038625
230
200
 
231
 
[WAS-8.5.5.4-fixpack-download]: http://www-01.ibm.com/support/docview.wss?uid=swg24038539
232
 
 
233
201
[WAS-trail-version]: http://www.ibm.com/developerworks/downloads/ws/was/index.html
234
202
 
235
203
[Passport]: http://www-01.ibm.com/software/passportadvantage/
242
210
 
243
211
[WAS-ppc64le-fixpack-info]: http://www-01.ibm.com/support/docview.wss?uid=swg24040035
244
212
 
245
 
[license-info]: http://www-03.ibm.com/software/sla/sladb.nsf/search
 
213
[license-info]: http://www-03.ibm.com/software/sla/sladb.nsf/lilookup/9FF995C8B656580C85257E66003B3EFC?OpenDocument