Skip to content
This repository was archived by the owner on Apr 21, 2024. It is now read-only.

Commit 8264956

Browse files
DilanUADilanUA
authored
Merge pull request #48 from chirangaalwis/cf-is-patterns-readmes
Refine the README.md files
2 parents a30a1b4 + b829033 commit 8264956

File tree

17 files changed

+280
-198
lines changed

17 files changed

+280
-198
lines changed

‎pattern-1/bosh-release/README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,10 @@ In order to create the BOSH release for deployment pattern 1, you must follow th
112112
Property | Description | Default
113113
-------- | ----------- | -------
114114
wso2is.user_ds.url | Connection URL of the user data source. | -
115-
wso2is.user_ds.driver | Database driver class name of the user data source. | -
116115
wso2is.registry_ds.url | Connection URL of the registry data source. | -
117-
wso2is.registry_ds.driver | Database driver class name of the registry data source. | -
118116
wso2is.identity_ds.url | Connection URL of the identity data source. | -
119-
wso2is.identity_ds.driver | Database driver class name of the identity data source. | -
117+
wso2is.bps_ds.url | Connection URL of the BPS data source. | -
118+
wso2is.db.driver | Database driver class name of the data source. | -
120119
wso2is.db.username | Username of the WSO2 Identity Server product database user. | root
121120
wso2is.db.password | Password of the WSO2 Identity Server product database user. | root
122121

‎pattern-1/bosh-release/bosh-lite.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,11 +99,10 @@ for creating a release with BOSH.
9999
Property | Description | Default
100100
-------- | ----------- | -------
101101
wso2is.user_ds.url | Connection URL of the user data source. | -
102-
wso2is.user_ds.driver | Database driver class name of the user data source. | -
103102
wso2is.registry_ds.url | Connection URL of the registry data source. | -
104-
wso2is.registry_ds.driver | Database driver class name of the registry data source. | -
105103
wso2is.identity_ds.url | Connection URL of the identity data source. | -
106-
wso2is.identity_ds.driver | Database driver class name of the identity data source. | -
104+
wso2is.bps_ds.url | Connection URL of the BPS data source. | -
105+
wso2is.db.driver | Database driver class name of the data source. | -
107106
wso2is.db.username | Username of the WSO2 Identity Server product database user. | root
108107
wso2is.db.password | Password of the WSO2 Identity Server product database user. | root
109108

‎pattern-1/bosh-release/jobs/wso2is_1/spec‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,6 @@ packages:
1616
- wso2is
1717

1818
properties:
19-
wso2is.memory.min_heap:
20-
description: Min Heap in MB
21-
default: 2048
22-
wso2is.memory.max_heap:
23-
description: Max Heap in MB
24-
default: 2048
25-
wso2is.memory.max_permgen:
26-
description: Max permgen in MB
27-
default: 1024
28-
2919
wso2is.user_ds.url:
3020
description: Connection URL of the user data source
3121
wso2is.bps_ds.url:

‎pattern-1/bosh-release/jobs/wso2is_1/templates/ctl.erb‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ mkdir -p ${run_dir} ${log_dir}
3434
# provide ownership of the directories 'vcap' user and group
3535
chown -R vcap:vcap ${run_dir} ${log_dir}
3636

37-
# set variables for your software
38-
min_heap=<%=properties.wso2is.memory.min_heap %>
39-
max_heap=<%=properties.wso2is.memory.max_heap %>
40-
max_permgen=<%=properties.wso2is.memory.max_permgen %>
41-
export JAVA_OPTS=" -Xmx${max_heap}m -Xms${min_heap}m -XX:MaxPermSize=${max_permgen}m"
42-
4337
debug_log=${log_dir}/${wso2_product}.log
4438
touch ${debug_log}
4539

‎pattern-1/bosh-release/jobs/wso2is_2/spec‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,6 @@ packages:
1616
- wso2is
1717

1818
properties:
19-
wso2is.memory.min_heap:
20-
description: Min Heap in MB
21-
default: 2048
22-
wso2is.memory.max_heap:
23-
description: Max Heap in MB
24-
default: 2048
25-
wso2is.memory.max_permgen:
26-
description: Max permgen in MB
27-
default: 1024
28-
2919
wso2is.user_ds.url:
3020
description: Connection URL of the user data source
3121
wso2is.bps_ds.url:

‎pattern-1/bosh-release/jobs/wso2is_2/templates/ctl.erb‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ mkdir -p ${run_dir} ${log_dir}
3434
# provide ownership of the directories 'vcap' user and group
3535
chown -R vcap:vcap ${run_dir} ${log_dir}
3636

37-
# set variables for your software
38-
min_heap=<%=properties.wso2is.memory.min_heap %>
39-
max_heap=<%=properties.wso2is.memory.max_heap %>
40-
max_permgen=<%=properties.wso2is.memory.max_permgen %>
41-
export JAVA_OPTS=" -Xmx${max_heap}m -Xms${min_heap}m -XX:MaxPermSize=${max_permgen}m"
42-
4337
debug_log=${log_dir}/${wso2_product}.log
4438
touch ${debug_log}
4539

‎pattern-2/bosh-release/README.md‎

Lines changed: 64 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
# BOSH release for WSO2 Identity Server deployment pattern 2
22

33
This directory contains the BOSH release implementation for WSO2 Identity Server 5.4.0
4-
[deployment pattern 2](https://docs.wso2.com/display/IS541/Deployment+Patterns#DeploymentPatterns-Pattern2-HAclustereddeploymentofWSO2IdentityServerwithWSO2IdentityAnalytics).
4+
[deployment pattern 2](https://docs.wso2.com/display/IS540/Deployment+Patterns#DeploymentPatterns-Pattern2-HAclustereddeploymentofWSO2IdentityServerwithWSO2IdentityAnalytics).
55

66
![WSO2 Identity Server 5.4.0 deployment pattern 2](images/pattern-2.png)
77

8-
The following sections provide step-by-step guidelines for managing the WSO2 Identity Server 5.4.0 deployment pattern 2 BOSH release.
8+
The following sections provide general steps required for managing the WSO2 Identity Server 5.4.0 deployment pattern 2
9+
BOSH release in a BOSH environment deployed in the desired IaaS.
910

10-
For clarity, examples for the relevant steps have been provided for managing the BOSH release in a [BOSH Lite](https://bosh.io/docs/bosh-lite) environment.
11+
For step-by-step guidelines to manage the BOSH release in specific environments, refer the following:
12+
- [In a local environment](bosh-lite.md) (using BOSH Lite)
13+
14+
## Contents
15+
16+
* [Prerequisites](#prerequisites)
17+
* [Create Release](#create-release)
18+
* [Deploy Release](#deploy-release)
19+
* [Output](#output)
20+
* [Delete Deployment](#delete-deployment)
21+
* [BOSH Release Structure](#bosh-release-structure)
22+
* [References](#references)
1123

1224
## Prerequisites
1325

@@ -16,13 +28,15 @@ For clarity, examples for the relevant steps have been provided for managing the
1628
- [BOSH Command Line Interface (CLI) v2+](https://bosh.io/docs/cli-v2.html)
1729
- [WSO2 Update Manager (WUM)](http://wso2.com/wum)
1830
- [Git client](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
31+
- Software requirements specific to the IaaS
1932

2033
2. Obtain the following software distributions.
2134

2235
- WSO2 Identity Server 5.4.0 WUM updated product distribution
2336
- WSO2 Identity Server Analytics 5.4.0 WUM updated product distribution
2437
- [Java Development Kit (JDK) 1.8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
25-
- [MySQL JDBC driver](https://dev.mysql.com/downloads/connector/j/5.1.html)
38+
- Relevant Java Database Connectivity (JDBC) connector (e.g. [MySQL JDBC driver](https://dev.mysql.com/downloads/connector/j/5.1.html)
39+
if the external database used is MySQL)
2640

2741
3. Clone this Git repository.
2842

@@ -32,7 +46,7 @@ For clarity, examples for the relevant steps have been provided for managing the
3246
3347
**Note**: In the remaining sections, the project root directory has been referred to as, **pivotal-cf-is**.
3448
35-
## Create the BOSH Release
49+
## Create release
3650
3751
In order to create the BOSH release for deployment pattern 2, you must follow the standard steps for creating a release with BOSH.
3852
@@ -46,20 +60,14 @@ In order to create the BOSH release for deployment pattern 2, you must follow th
4660
4761
Please refer the [BOSH documentation](http://bosh.io/docs/init.html) for instructions on creating a BOSH environment in the desired IaaS.
4862
49-
**e.g.** Steps to create a BOSH environment with BOSH Lite as Director VM and login to it, can be found from
50-
[here](http://bosh.io/docs/bosh-lite.html#install).
51-
52-
Once you setup the BOSH Lite environment, visit the VirtualBox application to confirm a new VM has been created.
53-
54-
![BOSH Lite VM](images/bosh-lite.png)
55-
5663
3. Move back to the root directory of deployment pattern 2 BOSH release (`<pivotal-cf-is>/pattern-2/bosh-release`).
5764
5865
```
5966
cd ..
6067
```
6168
62-
4. Add the WSO2 Identity Server 5.4.0 and Identity Server Analytics 5.4.0 WUM updated product distributions, JDK distribution and MySQL JDBC driver in the form of release blobs.
69+
4. Add the WSO2 Identity Server 5.4.0 and Identity Server Analytics 5.4.0 WUM updated product distributions, JDK distribution and MySQL JDBC driver
70+
in the form of release blobs.
6371
6472
Here, the **environment-alias** refers to the alias provided when saving the created environment, in step 2.
6573
@@ -70,25 +78,11 @@ In order to create the BOSH release for deployment pattern 2, you must follow th
7078
bosh -e <environment-alias> add-blob <local_system_path_to_WSO2_IS_Analytics_distribution> wso2is_analytics/wso2is-analytics-<version>.zip
7179
```
7280
73-
**e.g.**
74-
Assuming that,
75-
76-
- the created BOSH environment (with BOSH Lite as the Director) was saved with alias `vbox`, in step 2
77-
- the required binaries reside within `~/Downloads` directory
78-
79-
```
80-
bosh -e vbox add-blob ~/Downloads/jdk-8u144-linux-x64.tar.gz oraclejdk/jdk-8u144-linux-x64.tar.gz
81-
bosh -e vbox add-blob ~/Downloads/mysql-connector-java-5.1.34-bin.jar mysqldriver/mysql-connector-java-5.1.34-bin.jar
82-
bosh -e vbox add-blob ~/Downloads/wso2is-5.4.0.zip wso2is/wso2is-5.4.0.zip
83-
bosh -e vbox add-blob ~/Downloads/wso2is-analytics-5.4.0.zip wso2is_analytics/wso2is-analytics-5.4.0.zip
84-
```
85-
8681
5. **[Optional]** If the BOSH release is a final release, upload the blobs (added in step 4). Please refer
8782
[BOSH documentation](https://bosh.io/docs/create-release.html#upload-blobs) for further details.
8883
89-
**e.g.**
9084
```
91-
bosh -e vbox -n upload-blobs
85+
bosh -e <environment-alias> -n upload-blobs
9286
```
9387
9488
6. Create the BOSH release.
@@ -105,34 +99,41 @@ In order to create the BOSH release for deployment pattern 2, you must follow th
10599
```
106100
Please refer [BOSH Documentation](https://bosh.io/docs/create-release.html#final-release) for detailed information on creating a final release.
107101
108-
## Deploy the BOSH Release
102+
## Deploy release
109103
110-
1. Setup and configure external product MySQL database(s).
104+
1. Setup and configure external product database(s).
111105
112-
- Following table shows the external product database configurations, which have been set as properties under WSO2 Identity Server and Analytics job specifications
106+
- Currently, it is expected that the external database holds the user management, registry, identity and workflow feature database tables
107+
for Identity Server and Identity Server Analytics.
108+
Please see WSO2 Identity Server [Documentation](https://docs.wso2.com/display/IS540/Setting+Up+Separate+Databases+for+Clustering)
109+
for further details.
110+
111+
- Following table shows the external product database configurations, which have been set as properties under WSO2 Identity Server job specifications
113112
(**e.g.** see `properties` section under `<pivotal-cf-is>/pattern-2/bosh-release/jobs/wso2is_<job_number>/spec`).
114113
115114
<br>
116115
117116
Property | Description | Default
118117
-------- | ----------- | -------
119-
wso2is.mysql.host | Hostname/IP of the MySQL server in which WSO2 Identity Server product database resides. | 192.168.50.1
120-
wso2is.mysql.product_db | Name of the WSO2 Identity Server product database. | wso2is_db
121-
wso2is.product_db.username | Username of the WSO2 Identity Server product database user. | root
122-
wso2is.product_db.password | Password of the WSO2 Identity Server product database user. | root
123-
124-
If you customize any of the above configurations in following steps, change the default property values to customized values in each job specification.
125-
126-
- Create the product database. For this purpose, execute the `<pivotal-cf-is>/pattern-2/bosh-release/dbscripts/mysql.sql` script.
127-
128-
```
129-
DROP DATABASE IF EXISTS <wso2is.mysql.product_db>; CREATE DATABASE <wso2is.mysql.product_db>;
130-
USE <wso2is.mysql.product_db>; SOURCE /dbscripts/mysql.sql;
131-
```
118+
wso2is.user_ds.url | Connection URL of the user data source. | -
119+
wso2is.registry_ds.url | Connection URL of the registry data source. | -
120+
wso2is.identity_ds.url | Connection URL of the identity data source. | -
121+
wso2is.bps_ds.url | Connection URL of the BPS data source. | -
122+
wso2is.db.driver | Database driver class name of the data source. | -
123+
wso2is.db.username | Username of the WSO2 Identity Server product database user. | root
124+
wso2is.db.password | Password of the WSO2 Identity Server product database user. | root
125+
wso2is_analytics.user_ds.url | Connection URL of the user data source | -
126+
wso2is_analytics.registry_ds.url | Connection URL of the Registry data source | -
127+
wso2is_analytics.event_store_ds.url | Connection URL of the event store data source | -
128+
wso2is_analytics.processed_data_store_ds.url | Connection URL of the processed data store data source | -
129+
wso2is_analytics.db.username | Username of the WSO2 Identity Server Analytics product database user | root
130+
wso2is_analytics.db.password | Password of the WSO2 Identity Server Analytics product database user | root
131+
132+
Among the above, the properties with no default values **must** be set in the deployment manifest,
133+
prior deployment of the release.
134+
If you intend to customize any of the properties with default values, you may set the customized values
135+
in the deployment manifest, prior to deployment of the release.
132136
133-
This will create the tables to hold user management data, identity related data and workflow feature data
134-
(see [Setting Up Separate Databases for Clustering](https://docs.wso2.com/display/IS541/Setting+Up+Separate+Databases+for+Clustering)).
135-
136137
2. Move to the root directory of deployment pattern 2 BOSH release.
137138
138139
```
@@ -150,74 +151,55 @@ In order to create the BOSH release for deployment pattern 2, you must follow th
150151
```
151152
bosh -e <environment-alias> upload-stemcell <URL/local_system_path_to_stemcell>
152153
```
153-
154-
**e.g.** When uploading the stemcell to BOSH Lite environment created in previous section (see example steps under section [Create the BOSH Release](#create-the-bosh-release)),
155-
156-
```
157-
bosh -e vbox upload-stemcell https://bosh.io/d/stemcells/bosh-warden-boshlite-ubuntu-trusty-go_agent
158-
```
159154
160155
5. Upload the deployment manifest.
161156
162157
```
163-
bosh -e <environment-alias> -d wso2is-pattern-2 deploy manifests/wso2is-manifest.yml
164-
```
165-
166-
**e.g.** Uploading the deployment manifest to BOSH Lite environment
167-
168-
```
169-
bosh -e vbox -d wso2is-pattern-2 deploy manifests/wso2is-manifest.yml
158+
bosh -e <environment-alias> -d wso2is-pattern-2 deploy manifests/<deployment-manifest>.yml
170159
```
171160
172161
## Output
173162
174-
To find the IP addresses of created instances via the BOSH CLI and access the WSO2 Identity Server and Analytics management consoles via a web browser,
163+
To find the IP addresses of created instances via the BOSH CLI and access the WSO2 Identity Server management console via a web browser,
175164
176165
1. List all the instances within a deployment.
177166
178167
```
179168
bosh -e <environment-alias> -d wso2is-pattern-2 vms
180169
```
181-
182-
**e.g.** To find the deployed job instances within the deployment in BOSH Lite,
183-
```
184-
bosh -e vbox -d wso2is-pattern-2 vms
185-
```
186-
187-
![Job instances](images/output.png)
188170
189171
2. SSH into an instance.
190172
191173
```
192174
bosh -e <environment-alias> -d wso2is-pattern-2 ssh <instance_id>
193175
```
194176
195-
**e.g.** `bosh -e vbox -d wso2is-pattern-2 ssh wso2is_1/7c3c2498-d9ed-4b58-ad18-85d2c6215311`
196-
197-
3. Access the WSO2 Identity Server management console URL.
177+
3. Access the WSO2 Identity Server management console URL using the static IPs of the created instances.
198178
199179
```
200-
https://10.244.15.2:9443/carbon/
180+
https://<IP_Address_of_IS_instance_1>:9443/carbon
181+
```
182+
or
183+
```
184+
https://<IP_Address_of_IS_instance_2>:9443/carbon
201185
```
202-
4. Access the WSO2 Identity Server Analytics management console URL.
186+
4. Access the WSO2 Identity Server Analytics management console URL using the static IPs of the created instances.
203187
204188
```
205-
https://10.244.15.4:9444/carbon/
189+
https://<IP_Address_of_IS_Analytics_instance_1>:9444/carbon
190+
```
191+
or
192+
```
193+
https://<IP_Address_of_IS_Analytics_instance_2>:9444/carbon
206194
```
207195
208-
## Delete the BOSH release deployment
196+
## Delete deployment
209197
210198
1. Delete the deployment.
211199
212200
```
213201
bosh -e <environment-alias> -d wso2is-pattern-2 delete-deployment
214202
```
215-
216-
**e.g.** To delete the WSO2 Identity Server pattern 2 deployment in the BOSH Lite environment,
217-
218-
```
219-
bosh -e vbox -d wso2is-pattern-2 delete-deployment
220-
```
221203
222204
2. **[Optional]** Cleanup the BOSH release, stemcell, disks and etc.
223205
@@ -239,11 +221,9 @@ Structure of the directories and files of the BOSH release is as follows:
239221
├── manifests
240222
├── wso2is-manifest.yml
241223
├── packages
242-
├── README.md
224+
└── README.md
243225
```
244226
245227
## References
246228
247229
* [BOSH CLI v2 commands](https://bosh.io/docs/cli-v2.html)
248-
* [A Guide to Using BOSH](http://mariash.github.io/learn-bosh/)
249-
* [BOSH Lite](https://bosh.io/docs/bosh-lite.html)

0 commit comments

Comments
 (0)