Skip to content

Commit 4702b80

Browse files
authored
Fix typos and enhance clarity in upgrade practices
Corrected typos and improved clarity in the safe upgrade practices article.
1 parent bbb6574 commit 4702b80

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

articles/operator-service-manager/safe-upgrade-practices.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ ms.custom:
1111
---
1212

1313
# Get started with safe upgrade practices
14-
This article introduces Azure Operator Service Manager safe upgrade practices (SUP). These practices, supported by a series of features, enable complex upgrades of network functions hosted on Azure Operator Nexus. Compliance with in-service software upgrades (ISSU), in-service software downgrade (ISSD), and in-service rollback (ISSR) is supported within documented limits. This article focuses on basic upgrade concepts, look for other series articles to expand on advanced capabilities.
14+
This article introduces Azure Operator Service Manager safe upgrade practices (SUP). These practices enable complex upgrades of network functions hosted on Azure Operator Nexus. Compliance with in-service software upgrades (ISSU), in-service software downgrade (ISSD), and in-service rollback (ISSR) is supported within documented limits. This article focuses on basic upgrade concepts, look for other articles to expand on more advanced capabilities.
1515

1616
## Introduction to safe upgrades
17-
A given container network function is composed of one to many nf Applications (nfApps) which, over time, require lifecycle software version and configuration provisioning management. This genearlly requires the execution of the appropriate helm operations on each nfApp to set the active software or configuration version in-use. Azure Operator Service Manager SUP intelligently automates managing thes operations at-scale, to occur a particular order, and in a manner which least impacts the network service. The following feature list summarizes SUP available capabilities. These feature should be considered during the approate stage of publishing, designing and operating.
17+
A given container network function is composed of one to many nf Applications (nfApps) which, over time, require lifecycle software version and configuration provisioning management. This genearlly requires the execution of the appropriate helm operations on each nfApp to set the active software or configuration version. SUP intelligently automates managing thes operations at-scale, to occur a particular order, and in a manner which least impacts the network service. The following feature list summarizes SUP available capabilities. These features should be considered during the appropriate stage of publishing, designing and operating.
1818

1919
* SNS Reput Support - Calculate and execute correct helm operations in sequence across a series of nfApps.
20-
* Azure Operator Nexus Cluster - Support for workloads hosted by against arc-enabled kubernetes clusters.
20+
* Azure Operator Nexus Cluster - Support for workloads hosted by Nexus arc-enabled kubernetes clusters.
2121
* Helm Parameter - Ability to set helm operating parameters like atomic, timeout, and wait for each nfApp operation.
22-
* Synchronous Operations - Ability to run one serial nfApp operation at a time.
23-
* Control Upgrade Order - Define different nfApp sequences for installs and upgrades.
24-
* Single Chart Test Validation - Run a helm test operation after a create or update.
22+
* Synchronous Operations - Ability to run one operation against one nfApp at-a-time.
23+
* Control Upgrade Order - Define different nfApp sequences for installs, upgrades and deletes.
24+
* nfApp Validation - Run a helm test hook operation after a helm create or update operation.
2525
* Pause On Failure - If an nfApp fails, pause sequence of operations for diagnostics.
2626
* Rollback On Failure - If an nfApp fails, rollback any prior completed nfApps to starting state.
27-
* Skip nfApp on No Change - Manual or automatic skip processing of nfApps where no changes is required.
27+
* Skip nfApp on No Change - Manual or automatic skipping of nfApps where no change is required.
2828
* Interruption - Set a cancellation flag to stop sequence of operations before next nfApp.
2929

3030
## Safe upgrade approach
31-
To update an existing Azure Operator Service Manager site network service (SNS), the operator starts with executing a reput request against the deployed SNS resource. Where the SNS contains multiple nfApps, the proper helm operation is calculateed for each nfpp. Those operations are then fanned out serially across all nfApps defined in the network function definition version (NFDV). By default, in the order, which they appear, or optionally in the order defined by `updateDependsOn` parameter. The reput request supports various per nfApp changes including increasing a helm chart version, adding/removing helm values and/or adding/removing any nfApps. Some helm parameters, like atomic, timeout and wait can be set per nfApp. The basic logic used by the reput operation is as follows:
31+
To update an existing Azure Operator Service Manager site network service (SNS), the operator starts by executing a reput request against a previously deployed SNS resource. Where the SNS contains multiple nfApps, the proper helm operation is calculateed for each nfpp. Those operations are then fanned out across all nfApps defined in the network function definition version (NFDV). By default, in the order, which they appear, or optionally in the order defined by `updateDependsOn` parameter. The reput request supports various per nfApp changes including increasing a helm chart version, adding/removing helm values and/or adding/removing any nfApps. Some helm parameters, like `atomic`, `timeout` and `wait` can be set per nfApp. The basic logic used by the reput operation is as follows:
3232

3333
* nfApps are processed following either `updateDependsOn` ordering, or in the sequential order they appear.
3434
* nfApps with parameter `applicationEnabled` set to disable are skipped.
@@ -39,36 +39,36 @@ To update an existing Azure Operator Service Manager site network service (SNS),
3939

4040
To ensure outcomes, nfApp testing is supported using helm methods, either tests triggered by helm pre or post hooks, or using the standalone helm test hook. For pre or post hook failure, the `atomic` parameter is honored. With atomic/true, the failed chart is rolled back. With atomic/false, no rollback is executed. For standalone helm test hook failure, the `rollbackOnTestFailure` is honored, following similar logic as atomic. For more information on standalone helm testing, see the following article: [Run tests after install or upgrade](safe-upgrades-helm-test.md)
4141

42-
When an nfApp operation failure occurs, and after the failed nfApp is handled, the operator can control behavior of nfApps changed before the failed nfApp. With pause-on-failure the operator can force the reput operation to terminate after the failure. This best allows for diagnostic, as the broken environment is preserved. With rollback-on-failure the operator can force the reput operation to rollback any nfApp completed prior to the failure. This restores the starting state environment and has the least impact to the running service. For more information on controlling upgrade failure behavior, see the following article: [Control upgrade failure behavior](safe-upgrades-nf-level-rollback.md)
42+
When an nfApp operation failure occurs, and after the failed nfApp is handled, the operator can control behavior of nfApps changed before the failed nfApp. With pause-on-failure the operator can force the reput operation to terminate after the failure. This best allows for diagnostics, as the broken environment is preserved. With rollback-on-failure the operator can force the reput operation to rollback any nfApp completed prior to the failure. This restores the starting state environment and has the least impact to the running service. For more information on controlling upgrade failure behavior, see the following article: [Control upgrade failure behavior](safe-upgrades-nf-level-rollback.md)
4343

4444
## Considerations for in-service upgrades
45-
Azure Operator Service Manager generally supports three stages of in-service operations. These stages advance, downgrade or rollback a deployment version without interrupting the running service.
46-
45+
Azure Operator Service Manager generally supports three stages of in-service operations. These stages advance, downgrade or rollback a deployed version with minimal to no interruption of the running service.
4746
* ISSU: In-service upgrades. Advance software or configuration versions forward, to a specific NFDV target.
4847
* ISSD: In-service downgrades. Reduce software or configuration version backwards, to a specific NFDV target.
4948
* ISSR: In-service rollback. Rollback software or configuration versions, to the last helm release.
5049

51-
While ISSU and ISSD are both operator submitted operations, ISSR only applies when a failures occurs in a ISSU or ISSD operation. Some considerations are necessary to ensure the network function behaves as required when invoked durring ISSU, ISSD or ISSR opreations.
50+
While ISSU and ISSD are both operator executed operations, ISSR only applies when a failures occurs in a ISSU or ISSD operation. Consider the follow high level requirements to ensure a network function behaves as desired when operated against durring ISSU, ISSD or ISSR stages.
5251

53-
* The reput operation upgrades or installs new nfApps first, then deletes nfApps last.
52+
* The reput operation upgrades or installs new nfApps first, then deletes missing nfApps last.
5453
* This approach ensures service isn't impacted until all new nfApps are ready.
5554
* This approach requires sufficient platform capacity for transient hosting of both old and new nfApps.
56-
* The reput operation honors the nfApp's helm deployment profile settings, either rolling or recreate.
55+
* The reput operation honors the nfApp's helm rolling or recreate deployment profile settings.
56+
* Make sure the right setting is used to preserve service functionality during helm operations.
5757
* Where rolling is used, consider exposing the values `maxUnavailable` and `maxSurge` as CGS parameters.
5858

59-
Ultimately, the ability for a given network function to be upgraded without service interruption requires careful co-ordination betwen both Azure Operator Service Manager and the network function itself. Consult further with the network function publisher to better understand supported in-service upgrade capabilities and ensure they're aligned with the proper Azure Operator Service Manager configuration options.
59+
Ultimately, the ability for a given network function to be upgraded without service interruption requires careful co-ordination betwen both Azure Operator Service Manager and the network function. Consult further with the network function publisher to better understand supported in-service upgrade capabilities and ensure they're aligned with the proper Azure Operator Service Manager configuration options. All ISSU, ISSD and ISSU operations should be testing first in a controlled lab environment.
6060

6161
## Safe upgrade prerequisites
6262
When planning for an upgrade, address the following requirements in advance, to optimize time spent attempting and ensure success of the upgrade.
6363

6464
- Onboard updated artifacts using publisher and/or designer workflows.
6565
- In most cases, use the existing publisher to host new version artifacts.
66-
- Using an existing publisher supports `helm upgrade` to update an SNS to a different version.
66+
- Using an existing publisher supports `helm upgrade` to upgrade an SNS to a different version.
6767
- Using a new publisher requires a `helm delete` on the current SNS and then a `helm install` for the new SNS version.
6868
- Artifact store, network service design group (NSDG), and network function design group (NFDG) are immutable and can't change.
6969
- Changing one of these resources requires deployment of a new SNS.
70-
- A new artifact manifest is needed to store the new charts and images.
71-
- See [onboarding documentation](how-to-manage-artifacts-nexus.md) for details on uploading new charts and images.
70+
- A new artifact manifest is needed to store any new charts or images.
71+
- See [onboarding documentation](how-to-manage-artifacts-nexus.md) for details on uploading new charts oe images.
7272
- A new NFDV, and optionally network service design version (NSDV), is needed.
7373
- NFDV changes can be complex. We cover only basic changes in this article.
7474
- New NSDV is only required if a new configuration group schema (CGS) version is being introduced.

0 commit comments

Comments
 (0)