Skip to content

Commit 644756e

Browse files
authored
Update safe-upgrades-helm-test.md
fixing all corrections.
1 parent ecbab9b commit 644756e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

articles/operator-service-manager/safe-upgrades-helm-test.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,34 +27,34 @@ As part of the safe upgrade program, AOSM supports the use of helm tests as a ga
2727
The publisher is responsible for authoring the helm tests during construction of the helm charts. The helm tests are defined in the helm chart under the folder: `<ChartName>/Templates/`. Each test includes a job definition that specifies a container environment and command to run. The container environment should exit successfully for a test to be considered a success. The job definition must include the helm test hook annotation `(helm.sh/hook: test)` to be recognized as a test by helm.
2828

2929
## Enable helm tests during operations
30-
AOSM provides a set of configurable install and upgrade options for each nfApp. These existing options are extended with a new `testOptions` parameter. With this parameter the user can specify `testOptions` settings per nfApp and per type of operation. The `testOptions` parameter supports the following parameters:
30+
AOSM provides a set of configurable install and upgrade options for each nfApp. These existing options are extended with a new `testOptions` parameter. With this parameter, the user can specify `testOptions` settings per nfApp and per type of operation. The `testOptions` parameter supports the following parameters:
3131

32-
* enable
32+
* `enable`
3333
* Enables or disables the helm test on a nfApp after install or upgrade completes.
3434
* Default value is false.
35-
* timeout
35+
* `timeout`
3636
* Takes a value that represents the test time-out in minutes.
3737
* Default value is 20 minutes.
38-
* rollbackOnTestFailure
38+
* `rollbackOnTestFailure`
3939
* Enables or disables rollback on nfApp helm test failure.
4040
* Default value is true.
41-
* filter
41+
* `filter`
4242
* Allows for a method to run only a subset of tests. Accepts a list of strings, where each string in the list represents a test to execute.
4343
* Default value is no filter and all tests are run.
4444

4545
## Exposing helm test control via parameters
4646
AOSM already supports the NF payload parameters `installOptions` and `upgradeOptions` for each nfApp under `roleOverrideValues`. These parameters are extended to include new `testOptions` settings. Exposing these new parameter settings allows the Operator to control the upgrade behavior at run-time. See the three following examples demonstrating usage of `testOptions`.
4747

4848
## roleOverrideValues escaped example
49-
Following is an escaped example `roleOverrideValues` with `testOptions` under `installOptions` and `upgradeOptions` for a component named `application1`. This example uses a `filter`, to execute only tests which match the string provided, uses a custom time-out and enables `rollbackOnTestFailures`.
49+
Following is an escaped example `roleOverrideValues` with `testOptions` under `installOptions` and `upgradeOptions` for a component named `application1`. This example uses a `filter`, to execute only tests which match the string provided, uses a custom time-out, and enables `rollbackOnTestFailures`.
5050

5151
```
5252
"roleOverrideValues": [
5353
"{\"name\":\"application1\",\"deployParametersMappingRuleProfile\":{\"helmMappingRuleProfile\":{\"helmPackageVersion\":\"2.1.3\",\"values\":\"{\\\"roleOneParam\\\":\\\"roleOneOverrideValue\\\"}\",\"options\":{\"installOptions\":{\"atomic\":\”true\”,\"wait\":\"true\",\"timeout\":\"30m\",\”testOptions\”:{\”enable\”:\”true\”,\”timeout\”:\”15\”,\”rollbackOnTestFailure\”:\”true\”,\”filter\”:[\”test1\”,\”test2\”,\”test3\”]}},\"upgradeOptions\":{\"atomic\": \”true\”,\"wait\":\"true\",\"timeout\":\"30\", \”testOptions\”:{\”enable ”:\”true\”,\”timeout\”:\”15\”,\”rollbackOnTestFailure\”:\”true\”,\” filter \”:[\”test1\”,\”test2\”,\”test3\”]}}}}}}"]
5454
```
5555

5656
## roleOverrideValues unescaped example
57-
Following is an unescaped example `roleOverrideValues` NF Payload with `testOptions` under `installOptions` and `upgradeOptions` for a component named `hellotest`. This example uses a `filter` to execute only tests which match the string provided, uses a custom time-out and enables `rollbackOnTestFailures`.
57+
Following is an unescaped example `roleOverrideValues` NF Payload with `testOptions` under `installOptions` and `upgradeOptions` for a component named `hellotest`. This example uses a `filter` to execute only tests which match the string provided, uses a custom time-out, and enables `rollbackOnTestFailures`.
5858

5959
```
6060
"roleOverrideValues": ["{

0 commit comments

Comments
 (0)