Skip to content

Commit 9ac7534

Browse files
authored
Update safe-upgrade-practices.md
1 parent 5aedf5d commit 9ac7534

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

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

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ ms.service: azure-operator-service-manager
99
---
1010

1111
# Get started with safe upgrade practices
12-
13-
## Overview
1412
This article introduces Azure Operator Service Manager (AOSM) safe upgrade practices (SUP). This feature set enables an end user to safely execute complex upgrades of Container Network Function (CNF) workloads hosted on Azure Operator Nexus, in compliance with partner In Service Software Upgrade (ISSU) requirements, where applicable. Look for future articles in these services to expand on SUP features and capabilities.
1513

1614
## Introduction
@@ -23,21 +21,32 @@ A given network service supported by Azure Operator Service Manager will be comp
2321
* Pause On Failure - Based on flag, set failure behavior to rollback only last NfApp operation.
2422
* Single Chart Test Validation - Running a helm test operation after a create or update.
2523
* Refactored SNS Reput - Improved methods, adds update order and cleanup check.
24+
* Improve Upgrade Options Control - Expose parameters more effectively.
25+
* Skip NfApp on No Change - Skip processing of NfApps where no changes result.
26+
* Execute NF-level Rollback On Failure - Based on flag, rollback all completed NfApps on failure.
27+
* Image Preloading - Ability to preload images to edge repository.
2628

2729
## Upgrade approach
2830
To update an existing Azure Operator Service Manager site network service (SNS), the Operator executes a reput update request against the deployed SNS resource. Where the SNS contains CNFs with multiple NfApps, the request is 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.
2931

3032
For each NfApp, the reput update request supports increasing a helm chart version, adding/removing helm values and/or adding/removing any NfApps. Time-outs can be set per NfApp, based on known allowable runtimes, but NfApps can only be processed in serial order, one after the other. The reput update implements the following processing logic:
3133

3234
* NfApps are processed following either updateDependsOn ordering, or in the sequential order they appear.
33-
* NfApps with parameter "applicationEnabled" set to disable are skipped.
34-
* NFApps deployed, but not referenced by the new NFDV, are deleted.
35+
* NfApps with parameter `applicationEnabled` set to disable are skipped.
36+
* NfApps with parameter `skipUpgrade` set to enabled are skipped if no changes detected.
3537
* NFApps which are common between old and new NFDV are upgraded.
3638
* NFApps which are only in the new NFDV are installed.
37-
39+
* NFApps deployed, but not referenced by the new NFDV, are deleted.
40+
3841
To ensure outcomes, NfApp testing is supported using helm, either helm upgrade pre/post tests, or standalone helm tests. For pre/post tests failures, the atomic parameter is honored. With atomic/true, the failed chart is rolled back. With atomic/false, no rollback is executed. For standalone helm tests, the rollbackOnTestFailure parameter us honored. With rollbackOnTestFailure/true, the failed chart is rolled back. With rollbackOnTestFailure/false, no rollback is executed.
3942

40-
## Prerequisites
43+
## Considerations for in-service upgrades
44+
Azure Operator Service Manager generally supports in service upgrades, an upgrade method which advances a deployment version without interrupting the running service. Some considerations are neccesary to ensure the proper behavior of AOSM during ISSU operations.
45+
* Where AOSM is performaning an upgrade against an ordered set of multiple nfApps, AOSM will first upgrade or create all new nfApps, then delete all old nfApps. This ensures service is not impacted until all new nfApps are ready but requires extra platform capacity for transiet hosting of both old and new nfApps.
46+
* Where AOSM is upgrading an NfApp with multiple replica, AOSM will honor the deployment profile settings for rolling or recreate option. Where rolling is used, it's recommended to expose the values `maxUnavailable` and `maxSurge` as parameters, which can then be set via operator CGV at run-time.
47+
Ultimately, the ability for a given service to be upgraded without interruption is a feature of the service itself. Consult further with the service publisher to understand the in-service upgrade capabilities and ensure they are aligned with the proper AOSM behavioral options.
48+
49+
## Upgrade prerequisites
4150
When planning for an upgrade using Azure Operator Service Manager, address the following requirements in advance of upgrade execution to optimize the time spent attempting the upgrade.
4251

4352
- Onboard updated artifacts using publisher and/or designer workflows.
@@ -89,7 +98,7 @@ After fixing the failed NfApp, but before attempting an upgrade retry, consider
8998
### Issue SNS reput retry (repeat until success)
9099
By default, the reput retries NfApps in the declared update order, unless they are skipped using applicationEnablement flag.
91100

92-
## How to use applicationEnablement
101+
## How skip nfApps using applicationEnablement
93102
In the NFDV resource, under deployParametersMappingRuleProfile there is the property applicationEnablement of type enum, which takes values: Unknown, Enabled, or disabled. It can be used to exclude NfApp operations during network function (NF) deployment.
94103

95104
### Publisher changes
@@ -296,7 +305,7 @@ The NF ARM template is used by operator to submit the roleOverrideValues variabl
296305
}
297306
```
298307

299-
## How to skip NfApps which have no changes
308+
## How to skip NfApps which have no change
300309
The SkipUpgrade feature is designed to optimize the time taken for CNF upgrades. When the publisher enables this flag in the `RoleOverrideValues` under `UpgradeOptions`, the AOSM service layer performs certain prechecks, to determine whether an upgrade for a specific `NFApplication` can be skipped. If all precheck criteria are met, the upgrade is skipped for that application. Otherwise, an upgrade is executed at the cluster level.
301310

302311
### PreCheck Criteria
@@ -335,16 +344,4 @@ To enable the SkipUpgrade feature via `RoleOverrideValues`, refer to the followi
335344
- The `skipUpgrade` flag is enabled. If the upgrade request for `hellotest` meets the precheck criteria, the upgrade will be skipped at the service level.
336345
- **NfApplication: `runnerTest`**
337346
- The `skipUpgrade` flag is not specified. Therefore, `runnerTest` executes a traditional Helm upgrade at the cluster level, even if the precheck criteria are met.
338-
339-
## Support for in service upgrades
340-
Azure Operator Service Manager, where possible, supports in service upgrades, an upgrade method which advances a deployment version without interrupting the service. However, the ability for a given service to be upgraded without interruption is a feature of the service itself. Consult further with the service publisher to understand the in-service upgrade capabilities.
341-
342-
## Forwarding looking objectives
343-
Azure Operator Service Manager continues to grow the Safe Upgrade Practice feature set and drive improvements into offered update services. The following features are presently under consideration for future availability:
344-
345-
* Improve Upgrade Options Control - Expose parameters more effectively.
346-
* Skip NfApp on No Change - Skip processing of NfApps where no changes result.
347-
* Execute NFDV Rollback On Failure - Based on flag, rollback all completed NfApps on failure.
348-
* Operate Asynchronously - Ability to run multiple NfApp operations at a time.
349-
* Download Images- Ability to preload images to edge repository.
350-
* Target Charts for Validation - Ability to run a helm test only on a specific NfApp.
347+

0 commit comments

Comments
 (0)