~ibmcharmers/charms/trusty/ibm-wxs/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: anitanayak at ibm
  • Date: 2017-03-05 12:13:22 UTC
  • Revision ID: anitanayak@in.ibm.com-20170305121322-mwcxubgm9537pae0
deprecating the charm

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Charm for IBM� WebSphere� eXtreme Scale V8.6.0.7
2
 
 
3
 
# Overview
4
 
IBM� WebSphere� eXtreme Scale is an elastic, scalable, in-memory data grid (IMDG). It is designed to help you handle exponential growth of transactions. With WebSphere eXtreme Scale, you can expect an enhanced quality of service in high-performance computing environments.
5
 
 
6
 
For details on IBM Websphere Extreme Scale please visit [WXS Product page][wxs-installation-step]. 
7
 
This charm installs IBM� WebSphere� eXtreme Scale V8.6.0.7 in standalone mode on amd64 architecture.
8
 
 
9
 
# Usage
10
 
Download your licensed IBM� WebSphere� eXtreme Scale software for Ubuntu and put up its contents on a web server like Apache and configure Apache to serve this package.This package can be then accessed using a URL from the web server.
11
 
 
12
 
Download your licensed IBM Installation Manager software version 1.8 and above and upload to your apache repository 
13
 
 
14
 
Download your licensed IBM Websphere eXtreme Scale Base software 8.6.0 and upload to your apache repository 
15
 
 
16
 
Download your licensed IBM Websphere eXtreme Scale software fixpack version 8.6.0.7 version and upload to your apache repository 
17
 
 
18
 
# Creating the repositories in Apache
19
 
Run steps below with admin access
20
 
 
21
 
Install needed packages
22
 
        ```apt-get install dpkg-dev apache2```
23
 
Create a repository on Apache server under your Apache repository directory.
24
 
Configure Apache server to allow access to the repository.
25
 
 
26
 
To install IBM Websphere Extreme Scale you need to install IBM Installation Manager software as prerequisite.
27
 
To install IBM Installation Manager you need to get the packages for ubuntu, for information about the software and builds please visit 
28
 
[IBM Installation Manager Steps][im-installation-step].
29
 
 
30
 
To install IBM products you must agree to the license. License information can be found [WXS Software license agreement][wxs-license].
31
 
 
32
 
To install Websphere Extreme Scale product you need to get the packages for ubuntu, please visit
33
 
[WXS Installation Steps][wxs-installation-step].
34
 
 
35
 
Deploy charms as below:  
36
 
```juju deploy ibmwxs``` This will execute Websphere Extreme Scale software install prerequisite steps(it will install IBM Installation Manager) and install Websphere Extreme Scale product
37
 
 
38
 
At this point the charm will wait until the user accepts the license. If you agree to the license for IBM Installation Manager and IBM Websphere Extreme Scale products, run the following commands:
39
 
 
40
 
If host,package_dir,username and password is configured in the config.yaml
41
 
 
42
 
```juju set ibmwxs accept-ibm-im-license=True```
43
 
 
44
 
```juju set ibmwxs accept-ibm-wxs-license=True```
45
 
 
46
 
If not,
47
 
 
48
 
``` 
49
 
juju set ibmwxs host=<Web Server host name>
50
 
juju set ibmwxs package_dir=<Fully qualified Package path, do not add the package name >
51
 
juju set ibmwxs username=<User name of the Web Server host>
52
 
juju set ibmwxs password=<Password of the Web Server host>
53
 
juju set ibmwxs accept-ibm-im-license=True
54
 
juju set ibmwxs accept-ibm-wxs-license=True
55
 
```
56
 
 
57
 
In case after installing the product if you set license to "False", Product will get uninstalled and to reinstall the product you need to accept the license first using ```juju set wxs accept-ibm-wxs-license=True``` command.
58
 
 
59
 
If you need a relation between the WXS charm, add a unit on different container as 
60
 
```juju add-unit ibmwxs``` but adding a unit on the same container can not be done.
61
 
 
62
 
# Configuration
63
 
 
64
 
See config.yaml file for more information.
65
 
 
66
 
        `accept-ibm-wxs-license`
67
 
Before you can use or install IBM Websphere Extreme Scale,
68
 
you must accept the terms of International License
69
 
Agreement for Non-Warranted Programs and additional license information.
70
 
Please read the license agreement carefully.
71
 
 
72
 
Set the value of accept-ibm-wxs-license to True if you agree to IBM Websphere Extreme Scale license.
73
 
 
74
 
**The IBM Websphere Extreme Scale software cannot be installed until the terms and
75
 
conditions are accepted.  The charm will not function correctly until
76
 
this configuration option is set to True.**
77
 
 
78
 
`host`:
79
 
The web server host name from which IBM IM, IBM WXS base and fixpack install packages can be downloaded.
80
 
 
81
 
`package_dir`:
82
 
The package directory path in the web server.
83
 
 
84
 
`username`: User name of the webserver host.
85
 
 
86
 
`password`: Password of the webserver host.
87
 
 
88
 
`im_file_name`:
89
 
The IBM Installation Manager Package name. If not set, it is assigned the value "agent.installer.linux.gtk.x86_64_1.8.2000.20150303_1526.zip" for x86_64 based machine.
90
 
 
91
 
`wxs_base_file_name`:
92
 
The WXS Base Package name. If not set, it is assigned the value "WS_XSCALE_V8.6_MP_ML.zip" for x86_64 based machine.
93
 
 
94
 
`wxs_fixpack_file_name`:
95
 
The WXS Base Package name. If not set, it is assigned the value "8.6.0-WS-WXS-FP0000007.zip" for x86_64 based machine.
96
 
 
97
 
`sha_im`:
98
 
Checksum value to check integrity of IBM IM package. The Charm uses sha1sum to check the integrity. For example, run the command:
99
 
<sha1sum agent.installer.linux.gtk.x86_64_1.8.2000.20150303_1526.zip | cut -d " " -f1> to get the checksum value for IBM Installation Manager package. This parameter having a default value "f35653e20c7925d43007a1cff83623c979109ac5". The user should not change this value unless the corresponding installer package changes.
100
 
 
101
 
`sha_base`:
102
 
Checksum value to check integrity of IBM WXS base package. The Charm uses sha1sum to check the integrity. For example, run the command: <sha1sum WS_XSCALE_V8.6_MP_ML.zip | cut -d " " -f1> to get the checksum value for IBM WXS base package. This parameter having a default value "801bb88913e90413a271b6102d67276a9129dcf3". The user should not change this value unless the corresponding installer package changes.
103
 
 
104
 
`sha_fixpack`:
105
 
Checksum value to check integrity of IBM WXS fixpack package. The Charm uses sha1sum to check the integrity. For example, run the command: <sha1sum 8.6.0-WS-WXS-FP0000007.zip | cut -d " " -f1> to get the checksum value for IBM WXS fixpack package. This parameter having a default value "6e99ec379ed99521a184fbe0086c9d16055a67db". The user should not change this value unless the corresponding installer package changes.
106
 
 
107
 
After deploying IBMWXS, to test whether the product is working or not, run the runclient.sh command which is present in /opt/ibm/WXS/ObjectGrid/gettingstarted/. Now run the script as below
108
 
 
109
 
for insertion of the record
110
 
 
111
 
./runclient.sh i key value
112
 
 
113
 
to get the record
114
 
 
115
 
./runclient.sh g key
116
 
 
117
 
when you run the above script, you will get the corresponding value from the grid.
118
 
 
119
 
IBM WXS Information
120
 
-------------------
121
 
 
122
 
(1) General Information 
123
 
 
124
 
Information on IBM WXS available at the [WXS Infocenter][product-page]
125
 
 
126
 
(2) Download Information
127
 
 
128
 
Information on procuring WXS product is available at the [Passport Advantage Site][passport-wxs]
129
 
 
130
 
(3) Peer Relation Information
131
 
 
132
 
Information on peer relation for catalogServer and containerServer at the [WXS Infocenter][wxs-relation]
133
 
 
134
 
(4) Contact Information
135
 
 
136
 
For issues with this charm, please contact IBM Juju Support Team <jujusupp@us.ibm.com>
137
 
 
138
 
 
139
 
<!-- Links -->
140
 
 
141
 
[product-page]: http://www-01.ibm.com/support/knowledgecenter/SSTVLU_8.6.0/com.ibm.websphere.extremescale.doc/kc_welcome-xs.html
142
 
 
143
 
[passport-wxs]: http://www-01.ibm.com/software/passportadvantage/
144
 
 
145
 
[wxs-relation]: http://www-01.ibm.com/support/knowledgecenter/SSTVLU_8.6.0/com.ibm.websphere.extremescale.doc/cxscatservbp.html?lang=en
146
 
 
147
 
[wxs-installation-step]: http://www.ibm.com/software/products/en/websphere-extreme-scale
148
 
 
149
 
[im-installation-step]:http://www-01.ibm.com/support/docview.wss?uid=swg27025142
150
 
 
151
 
[wxs-license]: http://www-03.ibm.com/software/sla/sladb.nsf/lilookup/53D234CCEB5C2EC585257E3C0062B9F6?OpenDocument
 
1
# DEPRECATED
 
2
 
 
3
This charm is no longer being maintained. Please use `ibm-wxs-catalog`, `ibm-wxs-container` and `ibm-wxs-client` instead.