Merge pull request #287694 from msftadam/patch-29

Update safe-upgrade-practices.md

Author: v-shils

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

@@ -93,9 +93,199 @@ In the NFDV resource, under deployParametersMappingRuleProfile there is the prop
 ### Publisher changes
 For the applicationEnablement property, the publisher has two options: either provide a default value or parameterize it. 
 
+#### Sample NFDV
+```json
+{ 
+      "location":"<location>", 
+      "properties": {
+      "networkFunctionTemplate": {
+        "networkFunctionApplications": [
+          {
+            "artifactProfile": {
+              "helmArtifactProfile": { 
+                "var":"var"
+              },
+              "artifactStore": {
+                "id": "<artifactStore id>"
+              }
+            },
+            "deployParametersMappingRuleProfile": {
+              "helmMappingRuleProfile": {
+                "releaseNamespace": "{deployParameters.role1releasenamespace}",
+                "releaseName": "{deployParameters.role1releasename}"
+              },
+              "applicationEnablement": "Enabled"
+            },
+            "artifactType": "HelmPackage",
+            "dependsOnProfile": "null",
+            "name": "hellotest"
+          },
+          {
+            "artifactProfile": {
+              "helmArtifactProfile": {
+                 "var":"var"
+              },
+              "artifactStore": {
+                "id": "<artifactStore id>"
+              }
+            },
+            "deployParametersMappingRuleProfile": {
+              "helmMappingRuleProfile": {
+                "releaseNamespace": "{deployParameters.role2releasenamespace}",
+                "releaseName": "{deployParameters.role2releasename}"
+              },
+              "applicationEnablement": "Enabled"
+            },
+            "artifactType": "HelmPackage",
+            "dependsOnProfile": "null",
+            "name": "hellotest1"
+          }
+        ],
+        "nfviType": "AzureArcKubernetes"
+      },
+      "description": "null",
+      "deployParameters": {"type":"object","properties":{"role1releasenamespace":{"type":"string"},"role1releasename":{"type":"string"},"role2releasenamespace":{"type":"string"},"role2releasename":{"type":"string"}},"required":["role1releasenamespace","role1releasename","role2releasenamespace","role2releasename"]},
+      "networkFunctionType": "ContainerizedNetworkFunction"
+    }
+}
+```
+
 ### Operator changes
 Operators specify applicationEnablement as defined by the NFDV. If applicationEnablement for specific application is parameterized, then it must be passed through the deploymentValues property at runtime. 
 
+#### Sample configuration group schema (CGS) resource
+```json
+{
+  "type": "object",
+  "properties": {
+    "location": {
+      "type": "string"
+    },
+    "nfviType": {
+      "type": "string"
+    },
+    "nfdvId": {
+      "type": "string"
+    },
+    "helloworld-cnf-config": {
+      "type": "object",
+      "properties": {
+        "role1releasenamespace": {
+          "type": "string"
+        },
+        "role1releasename": {
+          "type": "string"
+        },
+        "role2releasenamespace": {
+          "type": "string"
+        },
+        "role2releasename": {
+          "type": "string"
+        },
+        "roleOverrideValues1": {
+          "type": "string"
+        },
+        "roleOverrideValues2": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "role1releasenamespace",
+        "role1releasename",
+        "role2releasenamespace",
+        "role2releasename",
+        "roleOverrideValues1",
+        "roleOverrideValues2"
+      ]
+    }
+  },
+  "required": [
+    "nfviType",
+    "nfdvId",
+    "location",
+    "helloworld-cnf-config"
+  ]
+}
+```
+ 
+#### Sample configuration group value (CGV) resource
+```json
+{
+  "location": "<location>",
+  "nfviType": "AzureArcKubernetes",
+  "nfdvId": "<nfdv_id>",
+  "helloworld-cnf-config": {
+    "role1releasenamespace": "hello-test-releasens",
+    "role1releasename": "hello-test-release",
+    "role2releasenamespace": "hello-test-2-releasens",
+    "role2releasename": "hello-test-2-release",
+    "roleOverrideValues1": "{\"name\":\"hellotest\",\"deployParametersMappingRuleProfile\":{\"applicationEnablement\":\"Enabled\",\"helmMappingRuleProfile\":{\"releaseName\":\"override-release\",\"releaseNamespace\":\"override-namespace\",\"helmPackageVersion\":\"1.0.0\",\"values\":\"\",\"options\":{\"installOptions\":{\"atomic\":\"true\",\"wait\":\"true\",\"timeout\":\"30\",\"injectArtifactStoreDetails\":\"true\"},\"upgradeOptions\":{\"atomic\":\"true\",\"wait\":\"true\",\"timeout\":\"30\",\"injectArtifactStoreDetails\":\"true\"}}}}}",
+    "roleOverrideValues2": "{\"name\":\"hellotest1\",\"deployParametersMappingRuleProfile\":{\"applicationEnablement\" : \"Enabled\"}}"
+  }
+}
+```
+
+#### Sample NF template
+```json
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
+  "contentVersion": "1.0.0.0",
+  "parameters": {
+    "nameValue": {
+      "type": "string",
+      "defaultValue": "HelloWorld"
+    },
+    "locationValue": {
+      "type": "string",
+      "defaultValue": "eastus"
+    },
+    "nfviTypeValue": {
+      "type": "string",
+      "defaultValue": "AzureArcKubernetes"
+    },
+    "nfviIdValue": {
+      "type": "string"
+    },
+    "config": {
+      "type": "object",
+      "defaultValue": {}
+    },
+    "nfdvId": {
+      "type": "string"
+    }
+  },
+  "variables": {
+    "deploymentValuesValue": "[string(createObject('role1releasenamespace', parameters('config').role1releasenamespace, 'role1releasename',parameters('config').role1releasename, 'role2releasenamespace', parameters('config').role2releasenamespace, 'role2releasename',parameters('config').role2releasename))]",
+    "nfName": "[concat(parameters('nameValue'), '-CNF')]",
+    "roleOverrideValues1": "[string(parameters('config').roleOverrideValues1)]",
+    "roleOverrideValues2": "[string(parameters('config').roleOverrideValues2)]"
+  },
+  "resources": [
+    {
+      "type": "Microsoft.HybridNetwork/networkFunctions",
+      "apiVersion": "2023-09-01",
+      "name": "[variables('nfName')]",
+      "location": "[parameters('locationValue')]",
+      "properties": {
+        "networkFunctionDefinitionVersionResourceReference": {
+          "id": "[parameters('nfdvId')]",
+          "idType": "Open"
+        },
+        "nfviType": "[parameters('nfviTypeValue')]",
+        "nfviId": "[parameters('nfviIdValue')]",
+        "allowSoftwareUpdate": true,
+        "configurationType": "Open",
+        "deploymentValues": "[string(variables('deploymentValuesValue'))]",
+        "roleOverrideValues": [
+          "[variables('roleOverrideValues1')]",
+          "[variables('roleOverrideValues2')]"
+        ]
+      }
+    }
+  ]
+}
+```
+
 ## Support for in service upgrades
 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.