Skip to content

Commit 2af042e

Browse files
update README.md
1 parent 4d820d6 commit 2af042e

File tree

2 files changed

+94
-6
lines changed

2 files changed

+94
-6
lines changed

charts/tibco-cp-bw/README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,53 @@
1-
# TIBCO CP base for BW Capability
1+
# TIBCO CP BW Chart
22

33
## Installation
44

5-
Since this chart is using the same values as the `tibco-cp-base` chart, you can re-use the same values file. The chart will install the platform prerequisites for BW capability.
5+
1. Update your local Helm repository with the latest charts:
66

77
```bash
8-
helm get values -n <CP Namespace> tibco-cp-base -o yaml | helm upgrade --install -n <CP Namespace> tibco-cp-bw tibco-platform-public/tibco-cp-bw -f -
8+
helm repo update
9+
```
10+
11+
2. Extract the values from your existing `platform-base` release into a new file. The `tibco-cp-bw` chart uses the common values from the `platform-base` chart.
12+
13+
```bash
14+
helm get values -n <control_plane_namespace> platform-base > tibco-cp-bw-values.yaml
15+
```
16+
17+
3. Review the generated `tibco-cp-bw-values.yaml` file and make any necessary customizations for your environment.
18+
19+
4. Install the `tibco-cp-bw` chart using the values file you just created:
20+
21+
```bash
22+
helm upgrade --install -n <control_plane_namespace> tibco-cp-bw tibco-platform-public/tibco-cp-bw --version=1.13.0 -f tibco-cp-bw-values.yaml
23+
```
24+
25+
## Cleanup Job
26+
27+
5. (Optional): To clean up EFS data during the uninstallation of the `tibco-cp-bw` chart, install the chart using the following command:
28+
29+
```bash
30+
helm upgrade --install -n <control_plane_namespace> tibco-cp-bw tibco-platform-public/tibco-cp-bw --version=1.13.0 -f tibco-cp-bw-values.yaml --set bwce-utilities.bwCleanupJob=true --set bw5ce-utilities.bw5CleanupJob=true --set bw-recipes.recipeCleanupJob=true
31+
```
32+
33+
## Uninstallation
34+
35+
### Before you begin:
36+
37+
Delete your deployed BW apps before uninstalling the `tibco-cp-bw` chart. If you do not delete the BW apps, they will continue to run but cannot be accessed from the UI.
38+
39+
To uninstall the `tibco-cp-bw` chart, run the following command:
40+
41+
```bash
42+
helm uninstall -n <control_plane_namespace> tibco-cp-bw
43+
```
44+
45+
### Note:
46+
47+
- If you install the `tibco-cp-bw` chart with the cleanup flags set to true (--set bwce-utilities.bwCleanupJob=true --set bw5ce-utilities.bw5CleanupJob=true --set bw-recipes.recipeCleanupJob=true), then bw-specific EFS data is cleaned up automatically during uninstallation.
48+
49+
- If you did not set the cleanup flags during installation and need to clean up EFS data, re-install the `tibco-cp-bw` chart with the cleanup flags enabled using the following command, then uninstall the chart:
50+
51+
```bash
52+
helm get values -n <control_plane_namespace> tibco-cp-bw -o yaml | helm upgrade --install -n <control_plane_namespace> tibco-cp-bw tibco-platform-public/tibco-cp-bw --version=1.13.0 --set bwce-utilities.bwCleanupJob=true --set bw5ce-utilities.bw5CleanupJob=true --set bw-recipes.recipeCleanupJob=true -f -
953
```

charts/tibco-cp-flogo/README.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,53 @@
1-
# TIBCO CP base for FLOGO Capability
1+
# TIBCO CP FLOGO Chart
22

33
## Installation
44

5-
Since this chart is using the same values as the `tibco-cp-base` chart, you can re-use the same values file. The chart will install the platform prerequisites for FLOGO capability.
5+
1. Update your local Helm repository with the latest charts:
66

77
```bash
8-
helm get values -n <CP Namespace> tibco-cp-base -o yaml | helm upgrade --install -n <CP Namespace> tibco-cp-flogo tibco-platform-public/tibco-cp-flogo -f -
8+
helm repo update
9+
```
10+
11+
2. Extract the values from your existing `platform-base` release into a new file. The `tibco-cp-flogo` chart uses the common values from the `platform-base` chart.
12+
13+
```bash
14+
helm get values -n <control_plane_namespace> platform-base > tibco-cp-flogo-values.yaml
15+
```
16+
17+
3. Review the generated `tibco-cp-flogo-values.yaml` file and make any necessary customizations for your environment.
18+
19+
4. Install the `tibco-cp-flogo` chart using the values file you just created:
20+
21+
```bash
22+
helm upgrade --install -n <control_plane_namespace> tibco-cp-flogo tibco-platform-public/tibco-cp-flogo --version=1.13.0 -f tibco-cp-flogo-values.yaml
23+
```
24+
25+
## Cleanup Job
26+
27+
5. (Optional): To clean up EFS data during the uninstallation of the `tibco-cp-flogo` chart, install the chart using the following command:
28+
29+
```bash
30+
helm upgrade --install -n <control_plane_namespace> tibco-cp-flogo tibco-platform-public/tibco-cp-flogo --version=1.13.0 -f tibco-cp-flogo-values.yaml --set flogo-utilities.cleanupJob=true --set flogo-recipes.cleanupJob=true
31+
```
32+
33+
## Uninstallation
34+
35+
### Before you begin:
36+
37+
Delete your deployed FLOGO apps before uninstalling the `tibco-cp-flogo` chart. If you do not delete the FLOGO apps, they will continue to run but cannot be accessed from the UI.
38+
39+
To uninstall the `tibco-cp-flogo` chart, run the following command:
40+
41+
```bash
42+
helm uninstall -n <control_plane_namespace> tibco-cp-flogo
43+
```
44+
45+
### Note:
46+
47+
- If you install the `tibco-cp-flogo` chart with the `cleanupJob` flags set to true (--set flogo-utilities.cleanupJob=true --set flogo-recipes.cleanupJob=true), then flogo-specific EFS data is cleaned up automatically during uninstallation.
48+
49+
- If you did not set the cleanup flags during installation and need to clean up EFS data, re-install the `tibco-cp-flogo` chart with the `cleanupJob` flags enabled using the following command, then uninstall the chart:
50+
51+
```bash
52+
helm get values -n <control_plane_namespace> tibco-cp-flogo -o yaml | helm upgrade --install -n <control_plane_namespace> tibco-cp-flogo tibco-platform-public/tibco-cp-flogo --version=1.13.0 --set flogo-utilities.cleanupJob=true --set flogo-recipes.cleanupJob=true -f -
953
```

0 commit comments

Comments
 (0)