Add ControlPlaneOnly enum to ManagedClusterUpgradeSpec (#27491)

* Add ControlPlaneOnly enum to ManagedClusterUpgradeSpec * add decorator for 2-02 release and fix comments * fix comment * fix decorator generation * fix version commenting * fix commenting typo * revise spec comments and consolidate into type comments
Azure · Feb 17, 2024 · be0e270 · be0e270
1 parent cc94f60
commit be0e270
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 22 deletions.
diff --git a/specification/containerservice/Fleet.Management/update/run.tsp b/specification/containerservice/Fleet.Management/update/run.tsp
@@ -120,11 +120,7 @@ scalar KubernetesVersion extends string;
 
 @doc("The upgrade to apply to a ManagedCluster.")
 model ManagedClusterUpgradeSpec {
-  @doc("""
-The upgrade type.
-Full requires the KubernetesVersion property to be set.
-NodeImageOnly requires the KubernetesVersion property not to be set.
-""")
+  @doc("ManagedClusterUpgradeType is the type of upgrade to be applied.")
   type: ManagedClusterUpgradeType;
 
   @doc("The Kubernetes version to upgrade the member clusters to.")
@@ -138,8 +134,12 @@ union ManagedClusterUpgradeType {
   @doc("Full upgrades the control plane and all agent pools of the target ManagedClusters.")
   "Full",
 
-  @doc("NodeImageOnly upgrades only the node images of the target ManagedClusters.")
+  @doc("NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set.")
   "NodeImageOnly",
+
+  @doc("ControlPlaneOnly upgrades only targets the KubernetesVersion of the ManagedClusters and will not be applied to the AgentPool. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set.")
+  @added(Versions.v2024_02_02_preview)
+  "ControlPlaneOnly",
 }
 
 @doc("The state of the UpdateRun, UpdateStage, UpdateGroup, or MemberUpdate.")

diff --git a/.../resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json b/.../resource-manager/Microsoft.ContainerService/fleet/preview/2023-03-15-preview/fleets.json
@@ -1691,7 +1691,7 @@
       "properties": {
         "type": {
           "$ref": "#/definitions/ManagedClusterUpgradeType",
-          "description": "The upgrade type.\nFull requires the KubernetesVersion property to be set.\nNodeImageOnly requires the KubernetesVersion property not to be set."
+          "description": "ManagedClusterUpgradeType is the type of upgrade to be applied."
         },
         "kubernetesVersion": {
           "$ref": "#/definitions/KubernetesVersion",
@@ -1716,12 +1716,12 @@
           {
             "name": "Full",
             "value": "Full",
-            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters."
+            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set."
           },
           {
             "name": "NodeImageOnly",
             "value": "NodeImageOnly",
-            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters."
+            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set."
           }
         ]
       }

diff --git a/.../resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json b/.../resource-manager/Microsoft.ContainerService/fleet/preview/2023-06-15-preview/fleets.json
@@ -1803,7 +1803,7 @@
       "properties": {
         "type": {
           "$ref": "#/definitions/ManagedClusterUpgradeType",
-          "description": "The upgrade type.\nFull requires the KubernetesVersion property to be set.\nNodeImageOnly requires the KubernetesVersion property not to be set."
+          "description": "ManagedClusterUpgradeType is the type of upgrade to be applied."
         },
         "kubernetesVersion": {
           "$ref": "#/definitions/KubernetesVersion",
@@ -1828,12 +1828,12 @@
           {
             "name": "Full",
             "value": "Full",
-            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters."
+            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set."
           },
           {
             "name": "NodeImageOnly",
             "value": "NodeImageOnly",
-            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters."
+            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set."
           }
         ]
       }

diff --git a/.../resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json b/.../resource-manager/Microsoft.ContainerService/fleet/preview/2023-08-15-preview/fleets.json
@@ -2224,7 +2224,7 @@
       "properties": {
         "type": {
           "$ref": "#/definitions/ManagedClusterUpgradeType",
-          "description": "The upgrade type.\nFull requires the KubernetesVersion property to be set.\nNodeImageOnly requires the KubernetesVersion property not to be set."
+          "description": "ManagedClusterUpgradeType is the type of upgrade to be applied."
         },
         "kubernetesVersion": {
           "$ref": "#/definitions/KubernetesVersion",
@@ -2249,12 +2249,12 @@
           {
             "name": "Full",
             "value": "Full",
-            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters."
+            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set."
           },
           {
             "name": "NodeImageOnly",
             "value": "NodeImageOnly",
-            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters."
+            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set."
           }
         ]
       }

diff --git a/.../resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json b/.../resource-manager/Microsoft.ContainerService/fleet/preview/2024-02-02-preview/fleets.json
@@ -2300,7 +2300,7 @@
       "properties": {
         "type": {
           "$ref": "#/definitions/ManagedClusterUpgradeType",
-          "description": "The upgrade type.\nFull requires the KubernetesVersion property to be set.\nNodeImageOnly requires the KubernetesVersion property not to be set."
+          "description": "ManagedClusterUpgradeType is the type of upgrade to be applied."
         },
         "kubernetesVersion": {
           "$ref": "#/definitions/KubernetesVersion",
@@ -2316,7 +2316,8 @@
       "description": "The type of upgrade to perform when targeting ManagedClusters.",
       "enum": [
         "Full",
-        "NodeImageOnly"
+        "NodeImageOnly",
+        "ControlPlaneOnly"
       ],
       "x-ms-enum": {
         "name": "ManagedClusterUpgradeType",
@@ -2325,12 +2326,17 @@
           {
             "name": "Full",
             "value": "Full",
-            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters."
+            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set."
           },
           {
             "name": "NodeImageOnly",
             "value": "NodeImageOnly",
-            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters."
+            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set."
+          },
+          {
+            "name": "ControlPlaneOnly",
+            "value": "ControlPlaneOnly",
+            "description": "ControlPlaneOnly upgrades only targets the KubernetesVersion of the ManagedClusters and will not be applied to the AgentPool. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set."
           }
         ]
       }

diff --git a/...erservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json b/...erservice/resource-manager/Microsoft.ContainerService/fleet/stable/2023-10-15/fleets.json
@@ -2120,7 +2120,7 @@
       "properties": {
         "type": {
           "$ref": "#/definitions/ManagedClusterUpgradeType",
-          "description": "The upgrade type.\nFull requires the KubernetesVersion property to be set.\nNodeImageOnly requires the KubernetesVersion property not to be set."
+          "description": "ManagedClusterUpgradeType is the type of upgrade to be applied."
         },
         "kubernetesVersion": {
           "$ref": "#/definitions/KubernetesVersion",
@@ -2145,12 +2145,12 @@
           {
             "name": "Full",
             "value": "Full",
-            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters."
+            "description": "Full upgrades the control plane and all agent pools of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to be set."
           },
           {
             "name": "NodeImageOnly",
             "value": "NodeImageOnly",
-            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters."
+            "description": "NodeImageOnly upgrades only the node images of the target ManagedClusters. Requires the ManagedClusterUpgradeSpec.KubernetesVersion property to NOT be set."
           }
         ]
       }