Skip to content

Commit cfded83

Browse files
Release 20.0.1
1 parent 00801c6 commit cfded83

File tree

143 files changed

+9681
-4233
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+9681
-4233
lines changed

AAE/README_config.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Configuring IBM Business Automation Application Engine (App Engine) 19.0.3
1+
# Configuring IBM Business Automation Application Engine (App Engine) 20.0.1
22

33
These instructions cover the basic installation and configuration of IBM Business Automation Application Engine (App Engine).
44

@@ -57,16 +57,16 @@ Follow the OpenShift instructions in [Planning Your Installation 3.11](https://d
5757

5858
Besides the common steps to set up the operator environment, you must do the following steps before you install App Engine.
5959

60-
* Create the App Engine database. See [Creating the database](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_db.html).
61-
* Create secrets to protect sensitive configuration data, See [Creating secrets to protect sensitive configuration data](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_data.html).
60+
* Create the App Engine database. See [Creating the database](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_db.html).
61+
* Create the required secrets. See [Creating secrets to protect sensitive configuration data](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_data.html).
6262

6363
## Step 2: Configuring Redis for App Engine (Optional)
6464

65-
You can configure App Engine with Remote Dictionary Server (Redis) to provide more reliable service. See [Configuring App Engine with Redis](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_redis.html).
65+
You can configure App Engine with Remote Dictionary Server (Redis) to provide more reliable service. See [Configuring App Engine with Redis](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_redis.html).
6666

6767
## Step 3: Implementing storage (Optional)
6868

69-
You can optionally add your own persistent volume (PV) and persistent volume claim (PVC) if you want to use your own JDBC driver or you want Resource Registry to be backed up automatically. The minimum supported size is 1 GB. For instructions, see [Optional: Implementing storage](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_storage.html).
69+
You can optionally add your own persistent volume (PV) and persistent volume claim (PVC) if you want to use your own JDBC driver or you want Resource Registry to be backed up automatically. The minimum supported size is 1 GB. For instructions, see [Optional: Implementing storage](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.install/op_topics/tsk_aeprep_storage.html).
7070

7171

7272
## Step 4: Configuring the custom resource YAML file for your App Engine deployment
@@ -78,12 +78,14 @@ You can optionally add your own persistent volume (PV) and persistent volume cla
7878
a. Uncomment and update the `shared_configuration` section if you haven't done it already.
7979

8080
b. Update the `application_engine_configuration` and `resource_registry_configuration` sections.
81+
* Automatic backup for Resource Registry is recommended. See [Enabling Resource Registry disaster recovery](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.managing/topics/tsk_enabling_disaster_recovery.html) for configuration information.
82+
8183
* If you just want to install App Engine with the minimal required values, replace the contents of `application_engine_configuration` and `resource_registry_configuration` in your copy of the template custom resource YAML file with the values from the [sample_min_value.yaml](configuration/sample_min_value.yaml) file.
8284

8385
* If you want to use the full configuration list and customize the values, update the required values in `application_engine_configuration` and `resource_registry_configuration` in your copy of the template custom resource YAML file based on your configuration.
8486

8587
### Configuration
86-
If you want to customize your custom resource YAML file, refer to the [configuration list](https://www.ibm.com/support/knowledgecenter/SSYHZ8_19.0.x/com.ibm.dba.ref/k8s_topics/ref_ae_params.html) for each parameter.
88+
If you want to customize your custom resource YAML file, refer to the [configuration list](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.ref/k8s_topics/ref_ae_params.html) for each parameter.
8789

8890
## Step 5: Completing the installation
8991

@@ -101,7 +103,7 @@ Update pages:
101103

102104
## Limitations
103105

104-
* After you deploy the App Engine, you can't change App Engine admin user in the admin secret.
106+
* After you deploy the App Engine, you can't change App Engine admin user.
105107

106108
* Because of a Node.js server limitation, App Engine trusts only root CA. If an external service is used and signed with another root CA, you must add the root CA as trusted instead of the service certificate.
107109

AAE/README_migrate.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11

2-
# Migrating from IBM Business Automation Application Engine (App Engine) 19.0.2 to 19.0.3
2+
# Migrating from IBM Business Automation Application Engine (App Engine) 19.0.2 to 20.0.1
33

4-
These instructions cover the migration of IBM Business Automation Application Engine (App Engine) from 19.0.2 to 19.0.3.
4+
These instructions cover the migration of IBM Business Automation Application Engine (App Engine) from 19.0.2 to 20.0.1.
55

66
## Introduction
77

8-
If you install App Engine 19.0.2 and want to continue to use your 19.0.2 applications in App Engine 19.0.3, you can migrate your applications from App Engine 19.0.2 to 19.0.3.
8+
If you install App Engine 19.0.2 and want to continue to use your 19.0.2 applications in App Engine 20.0.1, you can migrate your applications from App Engine 19.0.2 to 20.0.1.
99

1010
## Step 1: Export apps that were authored in 19.0.2
1111

@@ -23,12 +23,12 @@ Log in to your OpenShift environment to stop all the development pods. You can s
2323

2424
Reuse the existing App Engine database. Update the database configuration information under application_engine_configuration in the custom resource YAML file.
2525

26-
## Step 5: Install App Engine 19.0.3
26+
## Step 5: Install App Engine 20.0.1
2727

2828
[Install IBM Business Automation Application Engine](../AAE/README_config.md).
2929

30-
## Step 6: Migrate IBM Business Automation Navigator from 19.0.2 to 19.0.3 to verify your apps
30+
## Step 6: Migrate IBM Business Automation Navigator from 19.0.2 to 20.0.1 to verify your apps
3131

32-
Following the IBM Business Automation Navigator migration instructions(We should add a link to the Navigator migration instructions,once navigator migration link is ready), migrate Business Automation Navigator from 19.0.2 to 19.0.3. Then, test your apps.
32+
Following the IBM Business Automation Navigator migration instructions(We should add a link to the Navigator migration instructions,once navigator migration link is ready), migrate Business Automation Navigator from 19.0.2 to 20.0.1. Then, test your apps.
3333

3434

AAE/README_upgrade.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Upgrading from IBM Business Automation Application Engine (App Engine) 19.0.3 to 20.0.1
2+
3+
These instructions cover the upgrade of IBM Business Automation Application Engine (App Engine) from 19.0.3 to 20.0.1.
4+
5+
## Introduction
6+
7+
If you installed App Engine 19.0.3 and want to continue to use your 19.0.3 applications in App Engine 20.0.1, you can upgrade your applications from App Engine 19.0.3 to 20.0.1.
8+
9+
## Step 1: Update the custom resource YAML file for your App Engine 20.0.1 deployment
10+
11+
Get the custom resource YAML file that you used to deploy App Engine for 19.0.3, and edit it by following these steps:
12+
13+
1. Change the release version from 19.0.3 to 20.0.1.
14+
15+
2. Add `appVersion: 20.0.1` to the `spec` section. See the [sample_min_value.yaml](configuration/sample_min_value.yaml) file.
16+
17+
3. Update the `application_engine_configuration` and `resource_registry_configuration` sections.
18+
* Automatic backup for Resource Registry is recommended. See [Enabling Resource Registry disaster recovery](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.managing/topics/tsk_enabling_disaster_recovery.html) for configuration information.
19+
20+
* If you just want to update App Engine with the minimal required values, use the values in the [sample_min_value.yaml](configuration/sample_min_value.yaml) file.
21+
* Add `admin_user` to the `application_engine_configuration` sections.
22+
* Change the image tags from 19.0.3 to 20.0.1 in all sections.
23+
24+
* If you want to use the full configuration list and customize the values, update the required values in the `application_engine_configuration` and `resource_registry_configuration` sections in your custom resource YAML file based on your configuration. See the [configuration list](https://www.ibm.com/support/knowledgecenter/SSYHZ8_20.0.x/com.ibm.dba.ref/k8s_topics/ref_ae_params.html) for each parameter.
25+
26+
## Step 2: Update the configuration sections for other deployments
27+
28+
To update the configuration sections for other components, such as User Management Service and IBM Business Automation Navigator, go back to the relevant upgrade page to follow their upgrade documents to update your custom resource YAML file.
29+
30+
Upgrade pages:
31+
- [Managed OpenShift upgrade page](../platform/roks/upgrade.md)
32+
- [OpenShift upgrade page](../platform/ocp/upgrade.md)
33+
- [Certified Kubernetes upgrade page](../platform/k8s/upgrade.md)
34+

AAE/configuration/sample_min_value.yaml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,40 @@
22
# This is a YAML-formatted file.
33
# Declare variables to be passed into your templates.
44
spec:
5-
## production configuration
5+
appVersion: 20.0.1
6+
## Production configuration
67
## App Engine configuration
78
application_engine_configuration:
8-
## The application_engine_configuration is a list, you can deploy multiple instances of AppEngine, you can assign different configurations for each instance.
9-
## For each instance, application_engine_configuration.name and application_engine_configuration.name.hostname must be assigned to different values.
9+
## The application_engine_configuration is a list. You can deploy multiple instances of App Engine and assign different configurations for each instance.
10+
## For each instance, application_engine_configuration.name and application_engine_configuration.name.hostname must have different values.
1011
- name: ae_instance1
1112
hostname: <your external app engine host name>
1213
port: 443
1314
admin_secret_name: ae-secret-credential
15+
admin_user: <your default administrator ID>
1416
database:
1517
host: <your database host/IP>
1618
name: <your database name>
1719
port: <your database port>
18-
## If you setup DB2 HADR and want to use it, you need to configure alternative_host and alternative_port, or else, leave is as blank.
20+
## If you set up DB2 HADR and want to use it, you must configure alternative_host and alternative_port. Otherwise, leave them blank.
1921
alternative_host:
2022
alternative_port:
2123
images:
2224
db_job:
2325
repository: cp.icr.io/cp/cp4a/aae/solution-server-helmjob-db
24-
tag: 19.0.3
26+
tag: 20.0.1
2527
solution_server:
2628
repository: cp.icr.io/cp/cp4a/aae/solution-server
27-
tag: 19.0.3
29+
tag: 20.0.1
2830

2931
## Resource Registry Configuration
30-
## Important: if you've already configured Resource Registry before, you don't need to change resource_registry_configuration section in your copy of the template custom resource YAML file.
32+
## Important: If you've already configured Resource Registry, you don't need to change the resource_registry_configuration section in your copy of the template custom resource YAML file.
3133
resource_registry_configuration:
3234
admin_secret_name: resource-registry-admin-secret
3335
hostname: <your external resource registry host name>
3436
port: 443
3537
images:
3638
resource_registry:
3739
repository: cp.icr.io/cp/cp4a/aae/dba-etcd
38-
tag: 19.0.3
40+
tag: 20.0.1
3941

ACA/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Configuring IBM Business Automation Content Analyzer 20.0.1
2+
3+
These instructions cover the basic configuration of Business Automation Content Analyzer.
4+
5+
6+
7+
### Step n Complete the installation
8+
9+
Go back to the relevant install or update page to configure other components and complete the deployment with the operator.
10+
11+
Install pages:
12+
- [Managed OpenShift installation page](../platform/roks/install.md)
13+
- [OpenShift installation page](../platform/ocp/install.md)
14+
- [Certified Kubernetes installation page](../platform/k8s/install.md)
15+
16+
Update pages:
17+
- [Managed OpenShift installation page](../platform/roks/update.md)
18+
- [OpenShift installation page](../platform/ocp/update.md)
19+
- [Certified Kubernetes installation page](../platform/k8s/update.md)

0 commit comments

Comments
 (0)