edit pass: azure-operator-service-manager-overview-how-to

Author: ShawnJackson

articles/operator-service-manager/how-to-cancel-service-deployments.md

@@ -1,5 +1,5 @@
 ---
-title: Interrupt a service deployment with Azure Operator Service Manager
+title: Interrupt a Service Deployment with Azure Operator Service Manager
 description: Learn how to interrupt an Azure Operator Service Manager deployment in a nonterminal state.
 author: msftadam
 ms.author: adamdor
@@ -9,53 +9,69 @@ ms.service: azure-operator-service-manager
 ---
 
 # Interrupt a service deployment operation
-This article describes a method to interrupt a site network service (SNS) deployment operation in a nonterminal state. This capability only supports container network functions (CNF) and is triggered by applying a tag to the network function (NF) managed resource group (MRG). The user must later remove this tag to restore future SNS operations.
+
+This article describes a method to interrupt a site network service (SNS) deployment operation in a nonterminal state. This capability supports only container network functions (CNFs). You trigger it by applying a tag to the managed resource group (MRG) for the network function (NF). You must later remove this tag to restore future SNS operations.
 
 ## Why interrupt a service deployment operation
-Azure Operator Service Manager deploys complex CNF workloads, which are composed of many individual components (helm charts). When an SNS deployment is started, each component is processed sequentially, in the order as defined in the network function design (NFD). Depending on how many components are touched in a given deployment, the SNS operation can take an extended time to complete. As an example, consider a scenario where a CNF is composed of 30 components where each component takes 5 minutes to deploy. The total run time of this operation would exceed 2 hours. Now, consider operational issues with long running deployment operations:
-* Users may wish to test deployment operation only up to a certain component.
-* Users may realize, after initiating the operation, that an error exists in a component configuration. 
-* The operation might create an unexpected negative impact on a customer facing service.
 
-In such cases, an ability to interrupt the operation is desirable. Before the introduction of this interruption capability, the only option was to wait for the defective component to fail. With this interruption capability, long-running deployments can be proactively interrupted before reaching the defective component, minimizing delays and improving operational agility.
+Azure Operator Service Manager deploys complex CNF workloads, which consist of many individual components (Helm charts). When you start an SNS deployment, each component is processed sequentially, in the order defined in the network function design (NFD). Depending on how many components are touched in a deployment, the SNS operation can take an extended time to finish.
+
+As an example, consider a scenario where a CNF has 30 components. Each component takes 5 minutes to deploy. The total run time of this operation would exceed 2 hours. Now, consider operational issues with long-running deployment operations:
+
+* Users might want to test the deployment operation only up to a certain component.
+* Users might realize, after starting the operation, that an error exists in a component configuration.
+* The operation might create an unexpected negative impact on a customer-facing service.
+
+In such cases, an ability to interrupt the operation is desirable. Before the introduction of this interruption capability, the only option was to wait for the defective component to fail. With this interruption capability, you can proactively interrupt long-running deployments before they reach the defective component. This capability minimizes delays and improves operational agility.
 
 ## Overview of service deployment operations
-During the first deployment of an SNS, the install operation creates a managed resource group (MRG) which includes the network function resource. For subsequent SNS deployments, upgrade operations use this managed-by relationship to modify the NF within the MRG. As a prerequisite, the user must have access to the NF MRG to use the interruption feature.
+
+During the first deployment of an SNS, the installation operation creates a managed resource group (MRG) that includes the NF resource. For subsequent SNS deployments, upgrade operations use this managed-by relationship to modify the NF within the MRG. As a prerequisite for using the interruption feature, you must have access to the NF MRG.
 
 > [!NOTE]
-> The NF MRG has different default permissions, versus the SNS resource group (RG), which often restricts direct user access.
+> The NF MRG has different default permissions versus the SNS resource group (RG), which often restricts direct user access.
+
+## Interrupt a service deployment operation
 
-## Execute a service deployment operation interruption
-Follow this process to execute an interruption, but note that interruption behavior differs when executed against an install operation versus an upgrade operation.
-* When a user interrupts an install, the workflow only supports the pause-on-failure failure recovery method. 
-* When a user interrupts an upgrade, the workflow honors the configured failure recovery method, either rollback-on-failure or pause-on-failure.
+Follow this process to execute an interruption. Keep in mind that interruption behavior differs when you execute it against an installation operation versus an upgrade operation:
+
+* When you interrupt an installation, the workflow supports only the pause-on-failure failure recovery method.
+* When you interrupt an upgrade, the workflow honors the configured failure recovery method. This method can be either rollback-on-failure or pause-on-failure.
 
 ### Request interruption with a tag
-To interrupt a running deployment, add the tag `cancel:1` on the NF MRG. The MRG is identified by referencing the `properties.managedResourceGroupConfiguration.name` value within the SNS resource.
-* The tag is a static key value pair and must be an exact match.
-* The tag can be added via any supported method such as Azure portal, Azure CLI, REST SDK, etc.
-* The following example shows how to add the tag using Azure CLI:
+
+To interrupt a running deployment, add the tag `cancel:1` on the NF MRG. You can identify the MRG by referencing the `properties.managedResourceGroupConfiguration.name` value within the SNS resource.
+
+The tag is a static key/value pair and must be an exact match. You can add it by using any supported method, such as the Azure portal, Azure CLI, or REST SDK.
+
+The following example shows how to add the tag by using the Azure CLI:
 
 ```powershell
 az tag update --resource-id {resourceGroup} --operation Merge --tags cancel=1
 ```
 
 ### Wait for interruption to be triggered
-Once the tag is applied to the NF MRG, the interruption is executed between component operations.
-* The current component operation isn't interrupted and must proceed to completion.
-* Before starting the next component operation, the workflow checks for the presence of the tag on the NF MRG.
-* If the tag is present, any remaining components aren't executed and set to fail state.
-* If the interruption is applied to an upgrade operation, the configured failure recovery method is honored.
-* After failure recovery is complete, the deployment operation terminal state is set to failed.
 
-### Monitor state of network function components
-Use the NF component view to determine state of an executed interruption. Look for the `DeploymentStatusProperties` property of the last completed component to be in a state other than installing. Component view can also be used to determine component states based on configured failure recovery method.
+After you apply the tag to the NF MRG, the interruption is executed between component operations. The current component operation isn't interrupted and must proceed to completion.
+
+Before the workflow starts the next component operation, it checks for the presence of the tag on the NF MRG. If the tag is present, any remaining components aren't executed and are set to a `failed` state.
+
+If the interruption is applied to an upgrade operation, the workflow honors the configured failure recovery method. After failure recovery finishes, the deployment operation's terminal state is set to `failed`.
+
+### Monitor the state of network function components
+
+Use the NF component view to determine the state of an executed interruption. Look for the `DeploymentStatusProperties` property of the last completed component to be in a state other than `installing`.
+
+You can also use the component view to determine component states based on the configured failure recovery method.
 
 ### Confirm interruption action via logs
-Once the SNS deployment reaches a terminal state of failed, a notice of interruption is appended onto the operation output log.
 
-#### Error emitted during install interruption
-The following shows an example of the log emitted during a first install operation. The reference to `testapp` identifies the component that wasn't started, due to the interruption request. The string `deployment cancelled` indicates the interruption was applied to an initial install operation.
+After the SNS deployment reaches a terminal state of `failed`, a notice of interruption is appended to the operation's output log.
+
+#### Error emitted during installation interruption
+
+The following code shows an example of the log emitted during a first installation operation. The reference to `testapp` identifies the component that wasn't started, due to the interruption request. The string `deployment cancelled` indicates that the interruption was applied to an initial installation operation.
+
 ```powershell
 {
  "code": "DeploymentFailed",
@@ -70,7 +86,9 @@ The following shows an example of the log emitted during a first install operati
 ```
 
 #### Error emitted during upgrade interruption
-The following shows an example of the log emitted during an upgrade operation. The reference to `testapp` identifies the next component that wasn't started, due to the interruption request. The string `NF update` indicates the interruption was applied to an upgrade operation.
+
+The following code shows an example of the log emitted during an upgrade operation. The reference to `testapp` identifies the next component that wasn't started, due to the interruption request. The string `NF update` indicates that the interruption was applied to an upgrade operation.
+
 ```powershell
 {
  "code": "DeploymentFailed",
@@ -84,15 +102,17 @@ The following shows an example of the log emitted during an upgrade operation. T
 }
 ```
 
-### Remove tag once interruption is complete
-The user should remove the tag from the NF MRG to avoid unintentionally interrupting any future SNS deployment operations.
-* For example, to remove the tag using Azure CLI:
+### Remove a tag after interruption is complete
+
+To avoid unintentionally interrupting any future SNS deployment operations, you should remove the tag from the NF MRG. For example, to remove the tag by using the Azure CLI, run this command:
 
 ```powershell
 az tag update --resource-id {resourceGroup} --operation Delete --tags cancel=1
 ```
 
 ## Other considerations
-When considering interrupting an SNS deployment operation, be aware of the following considerations:
-* Interrupting deployments is supported only for Container Network Function (CNF) deployments. 
-* When the tag is added to the SNS MRG, the ongoing component action isn't interrupted and must complete before interruption is executed.
+
+When you want to interrupt an SNS deployment operation, be aware of these considerations:
+
+* Interrupting deployments is supported only for CNF deployments.
+* When you add the tag to the SNS MRG, the ongoing component action isn't interrupted and must finish before the interruption starts.