Make CloudControllerManagerState immutable in spec

and mirror CloudControllerManagerState into the PlatformStatus

Author: adriengentil

config/v1/0000_10_config-operator_01_infrastructure-Default.crd.yaml

@@ -83,12 +83,16 @@ spec:
                           description: CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
                           properties:
                             state:
+                              default: ""
                               description: "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager \n When set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected."
                               enum:
                                 - ""
                                 - External
                                 - None
                               type: string
+                              x-kubernetes-validations:
+                                - message: cloud controller state cannot be changed once set
+                                  rule: (oldSelf == '' && self == 'None') || self == oldSelf
                           type: object
                         platformName:
                           default: Unknown
@@ -603,6 +607,19 @@ spec:
                       type: object
                     external:
                       description: External contains settings specific to the generic External infrastructure provider.
+                      properties:
+                        cloudControllerManager:
+                          description: CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
+                          properties:
+                            state:
+                              default: ""
+                              description: "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager \n When set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected."
+                              enum:
+                                - ""
+                                - External
+                                - None
+                              type: string
+                          type: object
                       type: object
                     gcp:
                       description: GCP contains settings specific to the Google Cloud Platform infrastructure provider.

config/v1/0000_10_config-operator_01_infrastructure-TechPreviewNoUpgrade.crd.yaml

@@ -83,12 +83,16 @@ spec:
                           description: CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
                           properties:
                             state:
+                              default: ""
                               description: "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager \n When set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected."
                               enum:
                                 - ""
                                 - External
                                 - None
                               type: string
+                              x-kubernetes-validations:
+                                - message: cloud controller state cannot be changed once set
+                                  rule: (oldSelf == '' && self == 'None') || self == oldSelf
                           type: object
                         platformName:
                           default: Unknown
@@ -626,6 +630,19 @@ spec:
                       type: object
                     external:
                       description: External contains settings specific to the generic External infrastructure provider.
+                      properties:
+                        cloudControllerManager:
+                          description: CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
+                          properties:
+                            state:
+                              default: ""
+                              description: "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager \n When set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected."
+                              enum:
+                                - ""
+                                - External
+                                - None
+                              type: string
+                          type: object
                       type: object
                     gcp:
                       description: GCP contains settings specific to the Google Cloud Platform infrastructure provider.

config/v1/stable.infrastructure.testsuite.yaml

@@ -56,6 +56,55 @@ tests:
             external:
               platformName: SomeOtherCoolplatformName
       expectedError: " spec.platformSpec.external.platformName: Invalid value: \"string\": platform name cannot be changed once set"
+    - name: Should not be able to change External cloudControllerManager state once it was set
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Infrastructure
+        spec:
+          platformSpec:
+            type: External
+            external:
+              cloudControllerManager:
+                state: ""
+      updated: |
+        apiVersion: config.openshift.io/v1
+        kind: Infrastructure
+        spec:
+          platformSpec:
+            type: External
+            external:
+              cloudControllerManager:
+                state: External
+      expectedError: " spec.platformSpec.external.cloudControllerManager.state: Invalid value: \"string\": cloud controller state cannot be changed once set"
+    - name: Should be able to change External cloudControllerManager state from "" to "None"
+      initial: |
+        apiVersion: config.openshift.io/v1
+        kind: Infrastructure
+        spec:
+          platformSpec:
+            type: External
+            external:
+              cloudControllerManager:
+                state: ""
+      updated: |
+        apiVersion: config.openshift.io/v1
+        kind: Infrastructure
+        spec:
+          platformSpec:
+            type: External
+            external:
+              cloudControllerManager:
+                state: None
+      expected: |
+        apiVersion: config.openshift.io/v1
+        kind: Infrastructure
+        spec:
+          platformSpec:
+            type: External
+            external:
+              cloudControllerManager:
+                state: None
+              platformName: Unknown
     - name: Should not be able to modify an existing Azure ResourceTags Tag
       initial: |
         apiVersion: config.openshift.io/v1

config/v1/types_infrastructure.go

@@ -255,7 +255,10 @@ type CloudControllerManagerSpec struct {
 	// preventing them from running workloads until they are initialized by the cloud controller manager.
 	// When omitted or set to "None", new nodes will be not tainted
 	// and no extra initialization from the cloud controller manager is expected.
+	// +kubebuilder:default:=""
+	// +default=""
 	// +kubebuilder:validation:Enum="";External;None
+	// +kubebuilder:validation:XValidation:rule="(oldSelf == '' && self == 'None') || self == oldSelf",message="cloud controller state cannot be changed once set"
 	// +optional
 	State CloudControllerManagerState `json:"state"`
 }
@@ -348,8 +351,29 @@ type PlatformSpec struct {
 	External *ExternalPlatformSpec `json:"external,omitempty"`
 }
 
+// CloudControllerManagerStatus holds the state of Cloud Controller Manager (a.k.a. CCM or CPI) related settings
+type CloudControllerManagerStatus struct {
+	// state determines whether or not an external Cloud Controller Manager is expected to
+	// be installed within the cluster.
+	// https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager
+	//
+	// When set to "External", new nodes will be tainted as uninitialized when created,
+	// preventing them from running workloads until they are initialized by the cloud controller manager.
+	// When omitted or set to "None", new nodes will be not tainted
+	// and no extra initialization from the cloud controller manager is expected.
+	// +kubebuilder:default:=""
+	// +default=""
+	// +kubebuilder:validation:Enum="";External;None
+	// +optional
+	State CloudControllerManagerState `json:"state"`
+}
+
 // ExternalPlatformStatus holds the current status of the generic External infrastructure provider.
-type ExternalPlatformStatus struct{}
+type ExternalPlatformStatus struct {
+	// CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)
+	// +optional
+	CloudControllerManager CloudControllerManagerStatus `json:"cloudControllerManager"`
+}
 
 // PlatformStatus holds the current status specific to the underlying infrastructure provider
 // of the current cluster. Since these are used at status-level for the underlying cluster, it

config/v1/zz_generated.deepcopy.go

@@ -4902,6 +4902,17 @@
         }
       }
     },
+    "com.github.openshift.api.config.v1.CloudControllerManagerStatus": {
+      "description": "CloudControllerManagerStatus holds the state of Cloud Controller Manager (a.k.a. CCM or CPI) related settings",
+      "type": "object",
+      "properties": {
+        "state": {
+          "description": "state determines whether or not an external Cloud Controller Manager is expected to be installed within the cluster. https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/#running-cloud-controller-manager\n\nWhen set to \"External\", new nodes will be tainted as uninitialized when created, preventing them from running workloads until they are initialized by the cloud controller manager. When omitted or set to \"None\", new nodes will be not tainted and no extra initialization from the cloud controller manager is expected.",
+          "type": "string",
+          "default": ""
+        }
+      }
+    },
     "com.github.openshift.api.config.v1.ClusterCondition": {
       "description": "ClusterCondition is a union of typed cluster conditions.  The 'type' property determines which of the type-specific properties are relevant. When evaluated on a cluster, the condition may match, not match, or fail to evaluate.",
       "type": "object",
@@ -5956,7 +5967,14 @@
     },
     "com.github.openshift.api.config.v1.ExternalPlatformStatus": {
       "description": "ExternalPlatformStatus holds the current status of the generic External infrastructure provider.",
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "cloudControllerManager": {
+          "description": "CloudControllerManager contains settings specific to the external Cloud Controller Manager (a.k.a. CCM or CPI)",
+          "default": {},
+          "$ref": "#/definitions/com.github.openshift.api.config.v1.CloudControllerManagerStatus"
+        }
+      }
     },
     "com.github.openshift.api.config.v1.FeatureGate": {
       "description": "Feature holds cluster-wide information about feature gates.  The canonical name is `cluster`\n\nCompatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).",