Skip to content

Commit 52b190e

Browse files
FrancoisTribleFrancoisTrible
committed
Minor fixes
1 parent 4add99b commit 52b190e

File tree

18 files changed

+2144
-2718
lines changed

18 files changed

+2144
-2718
lines changed

‎AAE/platform/README-ROKS.md

Lines changed: 813 additions & 0 deletions
Large diffs are not rendered by default.

‎BACA/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@ For more information, see [IBM Business Automation Content Analyzer: Details](ht
1616

1717
- [Using Kubernetes YAML](k8s-yaml/README.md)
1818

19+
## NOTE:
20+
21+
- We include a sample network policy yaml file (baca-netpol.yaml) inside the `configuration` and `configuration-ha` folder. You can review and further modify to fit your need. To apply the network policy:
22+
```
23+
export KUBE_NAME_SPACE=<namespace that Content Analyzer will be deployed>
24+
cat baca-netpol.yaml | sed s/\$KUBE_NAME_SPACE/"$KUBE_NAME_SPACE"/ | kubectl apply -f -
25+
26+
```
27+
1928

2029
## Completing post deployment configuration
2130

‎BACA/configuration-ha/baca-netpol.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
kind: NetworkPolicy
2+
apiVersion: networking.k8s.io/v1
3+
metadata:
4+
namespace: $KUBE_NAME_SPACE
5+
name: baca-netpol
6+
spec:
7+
ingress:
8+
- {}
9+
podSelector: {}
10+
policyTypes:
11+
- Ingress

‎BACA/configuration/baca-netpol.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
kind: NetworkPolicy
2+
apiVersion: networking.k8s.io/v1
3+
metadata:
4+
namespace: $KUBE_NAME_SPACE
5+
name: baca-netpol
6+
spec:
7+
ingress:
8+
- {}
9+
podSelector: {}
10+
policyTypes:
11+
- Ingress

‎BACA/k8s-yaml/README.md

Lines changed: 91 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,100 @@
11
# Deploying with Kubernetes YAML
22

3-
Use the command line to deploy the IBM Business Automation Content Analyzer images using the parameters in ca-deploy.yml for specific environment and configuration settings. Review the reference topics for these parameters and determine the values for your environment as part of your preparation:
4-
[CA Kubernetes YAML parameters](./ca_deploy_yaml_parameters.md)
3+
If you prefer to use a simpler deployment process that uses a native Kubernetes authorization mechanism (RBAC) instead of Helm and Tiller, use the Helm command line interface (CLI) to generate a Kubernetes manifest. If you choose to use Kubernetes YAML you cannot use certain capabilities of Helm to manage your deployment.
54

6-
## Deploying component images
5+
Before you install make sure that you have prepared your environment.
76

8-
After the parameter values for your environment are configured in the ca-deploy.yml file, deploy IBM Business Automation Content Analyzer by following steps:
7+
## Prepare environment
98

10-
1. Use the deployment file to deploy IBM Business Automation Content Analyzer:
11-
12-
```kubectl apply -f ca-deploy.yml```
13-
14-
Due to the configuration of the readiness probes, after the pods start, it may take up to 10 or more minutes before the pods enter a ready state.
9+
### Prerequisites
10+
1. If the Helm client is not installed in your Kubernetes cluster, install [Helm 2.11.0](https://github.com/helm/helm/releases/tag/v2.11.0).
11+
12+
13+
### Step 1 - Create Content Analyzer Base DB
14+
1. Copy the DB2 folder from https://github.com/icp4a/cert-kubernetes/tree/19.0.2/BACA/configuration/DB2 to your IBM DB2 server
15+
2. cd to DB2 folder and run ./CreateBaseDB.sh script. (Ex. Please run with db2inst1 which has 'sudo' privileges)
16+
3. As prompted, enter the following data:
17+
- Enter the name of the IBM® Business Automation Content Analyzer Base database – (enter a unique name of 8 characters or less and no special characters).
18+
- Enter the name of database user – (enter a database user name that has full permissions to the base database). This can be a new or an existing Db2 user.
19+
- Enter the password for the user – (enter a password) – each time when prompted. If this is an existing user, this prompt is skipped
20+
21+
### Step 2 - Create the Content Analyzer Tenant database
22+
1. Still in the DB2 folder, Run ./AddTenant.sh script on the Db2 server.
23+
For more information, see Creating Content Analyzer Tenant database.
24+
2. As prompted, enter the following parameters:
25+
- Enter the tenant ID – (an alphanumeric value that is used by the user to reference the database)
26+
- Enter the name of the IBM® Business Automation Content Analyzer tenant database - (an alphanumeric value for the actual database name in Db2)
27+
- Enter the host/IP of the database server – (the IP address of the database server)
28+
- Enter the port of the database server – Press Enter to accept default of 50000 (or enter the port number if a different port is needed)
29+
- Do you want this script to create a database user – y (for yes)
30+
- Enter the name of database user – (this is the tenant database user - enter an alphanumeric user name with no special characters)
31+
- Enter the password for the user – (enter an alphanumeric password each time when prompted)
32+
- Enter the tenant ontology name – Press Enter to accept default (or enter a name to reference the ontology by if desired)
33+
- Enter the name of the Base Business Automation Content Analyzer database – (enter the database name given when you create the base database)
34+
- Enter the name of the database user for the Base Business Automation Content Analyzer database – (enter the base user name given when you create the base database)
35+
- Enter the company name – (enter your company name. This parameter and the remaining values are used to set up the initial user in Business Automation Content Analyzer)
36+
- Enter the first name - (enter your first name)
37+
- Enter the last name - (enter your last name)
38+
- Enter a valid email address - (enter your email address)
39+
- Enter the login name – (if you use LDAP authentication, enter your user name as it appears in the LDAP server)
40+
- Would you like to continue – y (for yes)
41+
- Save the tenantID and Ontology name for the later steps.
42+
43+
### Step 3 - download the configuration files
44+
1. Download all the files and folders except DB2 folder from https://github.com/icp4a/cert-kubernetes/tree/19.0.2/BACA/configuration to where you plan to install Content Analyzer. For example, to a system that can be connected to IBM Cloud Private.
45+
46+
### Step 4 - Edit common.sh
47+
1. Edit and populate the /configuration/common.sh that was downloaded from step 3 with the correct values from the [Prerequisite install parameters table](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.ref/topics/ref_baca_common_params.html). (Since helm server is not being used, be sure USING_HELM is set to N)
48+
49+
### Step 5 - Creates prerequisite resources for IBM Business Automation Content Analyzer
50+
1. Run ./init_deployment.sh from `configuration` folder that was downloaded from step 3.
51+
- Required persistent volumes and volume claims, secrets are created during the preparation of the environment
52+
53+
### Step 6 - Update values.yaml
54+
1. Download the Helm Chart to the master node from https://github.com/icp4a/cert-kubernetes/blob/19.0.2/BACA/helm-charts/ibm-dba-baca-prod-1.2.0.tgz
55+
2. Extract the helm chart from ibm-dba-prod-1.2.0.tgz.
56+
3. Proceed to ibm-dba-baca-prod/ibm_cloud_pak/pak_extensions directory and copy template.yaml to ibm-dba-baca-prod/values.yaml
57+
4. Edit the values.yaml file and complete the values mentioned in the [Helm Chart configuration parameter section](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.ref/topics/ref_baca_globaloptions_params.html) for options with the parameters and values.
58+
59+
Note that anything not documented does not need to be changed.
60+
61+
### Step 7 - Download IBM Cloud Pak for Automation V19.0.2 and load IBM Business Automation Content Analyzer base image
62+
63+
1. Please follow the instruction in https://www.ibm.com/support/docview.wss?uid=ibm10958567 to download CC3SEEN package to a server that is connected to your Docker registry.
64+
2. Download the [loadimages.sh](https://github.com/icp4a/cert-kubernetes/blob/19.0.2/scripts/loadimages.sh script from GitHub.
65+
3. Login to the specified Docker registry with the docker login command. This command depends on the environment that you have.
66+
4. Run the loadimages.sh script to load the images into your Docker registry. Specify the two mandatory parameters in the command line.
67+
- Note: The docker-registry value depends on the platform that you are using
68+
69+
```
70+
-p PPA archive files location or archive filename
71+
-r Target Docker registry and namespace
72+
-l Optional: Target a local registry
73+
```
74+
The following example shows the input values in the command line.
75+
```
76+
# scripts/loadimages.sh -p /Downloads/PPA/ImageArchive.tgz -r <DOCKER-REGISTRY>/demo-project
77+
```
78+
### Step 8 - Generate yaml files and deploy
79+
1. Create a chart YAML template file with the configuration parameters defined in values.yaml by using the following command in the ibm-dba-baca-prod directory. The `--name` argument sets the name of the release to install.
80+
81+
```console
82+
$ helm template . -f values.yaml\
83+
--name celery<namespace> \
84+
> generated-k8s-templates.yaml
85+
```
86+
87+
2. Install `celery<namespace>` by using the following command.
88+
89+
```console
90+
$ kubectl -n <namespace> apply -f generated-k8s-templates.yaml
91+
```
1592

16-
2. Run the following command to see that status of the pods. Wait until all pods are running and ready.
93+
3. Run the following command to see that status of the pods. Wait until all pods are running and ready.
1794

18-
```kubectl -n <namespace> get pods```
95+
```$ kubectl -n <namespace> get pods```
96+
97+
Due to the configuration of the readiness probes, after the pods start, it may take up to 10 or more minutes before the pods enter a ready state.
1998

2099
> **Reminder**: After you deploy, return to the instructions for [Completing post deployment tasks for IBM Business Automation Content Analyzer](../docs/post-deployment.md), to review document for further configuration.
21100
@@ -24,7 +103,7 @@ After the parameter values for your environment are configured in the ca-deploy.
24103
To uninstall and delete the IBM Business Automation Content Analyzer release, use the following command:
25104

26105
```console
27-
$ kubectl delete -f <ca-deploy.yml>
106+
$ kubectl delete -f generated-k8s-templates.yaml
28107
```
29108

30109
The command removes all the Kubernetes components associated with the release, except any Persistent Volume Claims (PVCs). This is the default behavior of Kubernetes, and ensures that valuable data is not deleted. To delete the persisted data of the release, you can delete the PVC using the following command:

0 commit comments

Comments
 (0)