Merge pull request #1190 from apricote/bastion-mutability

🏃 Explain mutability of bastion configuration in CRD

Author: k8s-ci-robot

api/v1alpha3/openstackcluster_types.go

@@ -107,6 +107,10 @@ type OpenStackClusterSpec struct {
 	ControlPlaneAvailabilityZones []string `json:"controlPlaneAvailabilityZones,omitempty"`
 
 	// Bastion is the OpenStack instance to login the nodes
+	//
+	// As a rolling update is not ideal during a bastion host session, we
+	// prevent changes to a running bastion configuration. Set `enabled: false` to
+	// make changes.
 	//+optional
 	Bastion *Bastion `json:"bastion,omitempty"`
 }

api/v1alpha4/openstackcluster_types.go

@@ -130,6 +130,10 @@ type OpenStackClusterSpec struct {
 	ControlPlaneAvailabilityZones []string `json:"controlPlaneAvailabilityZones,omitempty"`
 
 	// Bastion is the OpenStack instance to login the nodes
+	//
+	// As a rolling update is not ideal during a bastion host session, we
+	// prevent changes to a running bastion configuration. Set `enabled: false` to
+	// make changes.
 	//+optional
 	Bastion *Bastion `json:"bastion,omitempty"`
 

api/v1beta1/openstackcluster_types.go

@@ -130,6 +130,10 @@ type OpenStackClusterSpec struct {
 	ControlPlaneAvailabilityZones []string `json:"controlPlaneAvailabilityZones,omitempty"`
 
 	// Bastion is the OpenStack instance to login the nodes
+	//
+	// As a rolling update is not ideal during a bastion host session, we
+	// prevent changes to a running bastion configuration. Set `enabled: false` to
+	// make changes.
 	//+optional
 	Bastion *Bastion `json:"bastion,omitempty"`
 

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclusters.yaml

@@ -82,7 +82,10 @@ spec:
                   APIServer will be created
                 type: integer
               bastion:
-                description: Bastion is the OpenStack instance to login the nodes
+                description: "Bastion is the OpenStack instance to login the nodes
+                  \n As a rolling update is not ideal during a bastion host session,
+                  we prevent changes to a running bastion configuration. Set `enabled:
+                  false` to make changes."
                 properties:
                   availabilityZone:
                     type: string
@@ -1106,7 +1109,10 @@ spec:
                   APIServer will be created
                 type: integer
               bastion:
-                description: Bastion is the OpenStack instance to login the nodes
+                description: "Bastion is the OpenStack instance to login the nodes
+                  \n As a rolling update is not ideal during a bastion host session,
+                  we prevent changes to a running bastion configuration. Set `enabled:
+                  false` to make changes."
                 properties:
                   availabilityZone:
                     type: string
@@ -2510,7 +2516,10 @@ spec:
                   APIServer will be created
                 type: integer
               bastion:
-                description: Bastion is the OpenStack instance to login the nodes
+                description: "Bastion is the OpenStack instance to login the nodes
+                  \n As a rolling update is not ideal during a bastion host session,
+                  we prevent changes to a running bastion configuration. Set `enabled:
+                  false` to make changes."
                 properties:
                   availabilityZone:
                     type: string

config/crd/bases/infrastructure.cluster.x-k8s.io_openstackclustertemplates.yaml

@@ -87,8 +87,10 @@ spec:
                           on the APIServer will be created
                         type: integer
                       bastion:
-                        description: Bastion is the OpenStack instance to login the
-                          nodes
+                        description: "Bastion is the OpenStack instance to login the
+                          nodes \n As a rolling update is not ideal during a bastion
+                          host session, we prevent changes to a running bastion configuration.
+                          Set `enabled: false` to make changes."
                         properties:
                           availabilityZone:
                             type: string
@@ -775,8 +777,10 @@ spec:
                           on the APIServer will be created
                         type: integer
                       bastion:
-                        description: Bastion is the OpenStack instance to login the
-                          nodes
+                        description: "Bastion is the OpenStack instance to login the
+                          nodes \n As a rolling update is not ideal during a bastion
+                          host session, we prevent changes to a running bastion configuration.
+                          Set `enabled: false` to make changes."
                         properties:
                           availabilityZone:
                             type: string