You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/operator-service-manager/safe-upgrades-helm-test.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,34 +27,34 @@ As part of the safe upgrade program, AOSM supports the use of helm tests as a ga
27
27
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.
28
28
29
29
## 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:
31
31
32
-
* enable
32
+
*`enable`
33
33
* Enables or disables the helm test on a nfApp after install or upgrade completes.
34
34
* Default value is false.
35
-
* timeout
35
+
*`timeout`
36
36
* Takes a value that represents the test time-out in minutes.
37
37
* Default value is 20 minutes.
38
-
* rollbackOnTestFailure
38
+
*`rollbackOnTestFailure`
39
39
* Enables or disables rollback on nfApp helm test failure.
40
40
* Default value is true.
41
-
* filter
41
+
*`filter`
42
42
* 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.
43
43
* Default value is no filter and all tests are run.
44
44
45
45
## Exposing helm test control via parameters
46
46
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`.
47
47
48
48
## 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`.
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`.
0 commit comments