Skip to content

Commit 988a0f0

Browse files
authored
Refine language for upgrade and rollback documentation
Reword sections for clarity and consistency, including upgrade and rollback behavior descriptions.
1 parent d39e77e commit 988a0f0

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

articles/operator-service-manager/safe-upgrades-nf-level-rollback.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ ms.service: azure-operator-service-manager
1010

1111
# Control upgrade failure behavior
1212

13-
This guide describes the Azure Operator Service Manager (AOSM) upgrade failure behavior features for container network functions (CNFs). These features, as part of the AOSM safe upgrade practices initiative, offer a choice between faster retries, with pause on failure, versus return to starting point, with rollback on failure.
13+
This guide describes the Azure Operator Service Manager (AOSM) upgrade failure behavior features for container network functions (CNFs). For faster retries, use pause on failure. To return to the starting point, use rollback on failure.
1414

1515
## Pause on failure
1616
Any upgrade using AOSM starts with a site network service (SNS) reput operation. The reput operation processes the network function applications (nfApps) found in the network function design version (NFDV). The reput operation implements the following default logic:
1717
* A user initiates an SNS reput operation with pause-on-failure enabled.
1818
* nfApps are processed following either `updateDependsOn` ordering, or in the sequential order they appear.
19-
* If an nfApp install or upgrade operation fails, the atomic rollback setting for that operation and nfApp is honored .
19+
* If an nfApp install or upgrade operation fails, the atomic rollback setting for that operation and nfApp is honored.
2020
* No prior completed NfApps are further operated upon.
2121
* The task terminates and leaves the SNS resource in a failed state.
2222

23-
With pause on failure, AOSM rolls back only the failed nfApp, via the `testOptions`, `installOptions`, or `upgradeOptions` operation parameters. No action is taken on any nfApps which proceed the failed nfApp. This method allows the end user to troubleshoot the failed nfApp and then restart the upgrade from that point forward. As the default behavior, this method is the most efficient method, but may cause network function (NF) inconsistencies while in a mixed version state.
23+
With pause on failure, AOSM rolls back only the failed nfApp, via the `testOptions`, `installOptions`, or `upgradeOptions` operation parameters. No action is taken on any nfApps proceeding the failed nfApp. This method allows the end user to troubleshoot the failed nfApp and then restart the upgrade from that point forward. As the default behavior, this method is the most efficient method, but may cause network function (NF) inconsistencies while in a mixed version state.
2424

2525
### Upgrade successful
26-
An upgrade is considered successful if all nfApps reach the desired target state without generating helm install or helm ugrade failures. In such conditions, Azure Operator Service Manager returns the following operational status and message:
26+
An upgrade is considered successful if all nfApps reach the desired target state without generating helm install or helm upgrade failures. In such conditions, Azure Operator Service Manager returns the following operational status and message:
2727

2828
```
2929
- Upgrade Succeeded
@@ -32,7 +32,7 @@ An upgrade is considered successful if all nfApps reach the desired target state
3232
```
3333

3434
### Upgrade unsuccessful
35-
An upgrade is considered unsuccessful if any nfApp generates a helm install or helm ugrade failure. In such conditions, Azure Operator Service Manager returns the following operational status and message:
35+
An upgrade is considered unsuccessful if any nfApp generates a helm install or helm upgrade failure. In such conditions, Azure Operator Service Manager returns the following operational status and message:
3636

3737
```
3838
- Upgrade Failed
@@ -57,10 +57,10 @@ To address risk of mismatched nfApp versions, Azure Operator Service Manager sup
5757
> [!NOTE]
5858
> * AOSM doesn't create a snapshot if a user doesn't enable rollback on failure.
5959
> * A rollback on failure only applies to the successfully completed nfApps.
60-
> * An error with the atomic rollback on the nfApp which failed to upgrade or install is not treated as a rollback failure.
60+
> * An error with the atomic rollback isn't treated as a rollback failure.
6161
6262
### Upgrade successful
63-
An upgrade is considered successful if all nfApps reach the desired target state without generating helm install or helm ugrade failures. In such conditions, Azure Operator Service Manager returns the following operational status and message:
63+
An upgrade is considered successful if all nfApps reach the desired target state without generating helm install or helm upgrade failures. In such conditions, Azure Operator Service Manager returns the following operational status and message:
6464

6565
```
6666
- Upgrade Succeeded
@@ -69,7 +69,7 @@ An upgrade is considered successful if all nfApps reach the desired target state
6969
```
7070

7171
### Rollback successful
72-
A rollback is considered successful if all prior completed NfApps have reached the original snapshot state without generating a helm rollback failure. In such conditions, Azure Operator Service Manager returns the following operational status and message:
72+
A rollback is considered successful if all prior completed NfApps reached the original snapshot state without generating a helm rollback failure. In such conditions, Azure Operator Service Manager returns the following operational status and message:
7373

7474
```
7575
- Upgrade Failed, Rollback Succeeded
@@ -78,7 +78,7 @@ A rollback is considered successful if all prior completed NfApps have reached t
7878
```
7979

8080
### Rollback unsuccessful
81-
A rollback is considered unsuccessful if any prior completed nfApps fail to reach the original snapshot state, instead generating a helm rollback failure. In such conditions, Azure Operator Service Manager will stop processing any further rollback eligble nfApps and terminate with the following operational status and message:
81+
A rollback is considered unsuccessful if any prior completed nfApps fail to reach the original snapshot state, instead generating a helm rollback failure. In such conditions, Azure Operator Service Manager stops processing any further rollback eligible nfApps and terminate with the following operational status and message:
8282

8383
```
8484
- Upgrade Failed, Rollback Failed
@@ -130,12 +130,12 @@ example:
130130
> * Each `roleOverrideValues` entry overrides the default behavior of the NfAapps.
131131
> * If multiple entries of `nfConfiguration` are found in the `roleOverrideValues`, then the NF reput is returned as a bad request.
132132
133-
## Managing nfApps which don't support rollback
134-
Almost all publishers have reported some nfApps which are not compatible with helm rollback operations. Some of these nfApps maybe sourced from third-parties who do not common support such strict resilency requirements. Some of these nfApps maybe related to database applications which have complicated schema management requirements. In these cases special consideration should be taken to deal with these nfApps.
133+
## Managing nfApps that don't support rollback
134+
Almost all publishers report some nfApps that aren't compatible with helm rollback operations. These nfApps maybe sourced from third-parties who don't common support such strict resiliency requirements. These nfApps maybe related to database applications with complicated schema management requirements. In these cases, special consideration should be taken to deal with nfApps that don't support rollback.
135135

136136
* The strong preference is to push vendors to support helm rollback.
137-
* nfApps which don't support rollback cannot be skipped.
138-
* nfApp rollback order cannot changed.
137+
* nfApps that don't support rollback can't be skipped.
138+
* nfApp rollback order can't change.
139139
* Incremental-NFDV approach must be used in these situations.
140140

141141
## How to troubleshoot rollback on failure

0 commit comments

Comments
 (0)