OpenStackCluster: Add explicit optional tags

Author: mdbooth

api/v1beta1/openstackcluster_types.go

@@ -34,6 +34,7 @@ type OpenStackClusterSpec struct {
 	// subnets with the defined CIDR, and a router connected to these subnets. Currently only one IPv4
 	// subnet is supported. If you leave this empty, no network will be created.
 	// +kubebuilder:validation:MaxItems=1
+	// +optional
 	ManagedSubnets []SubnetSpec `json:"managedSubnets,omitempty"`
 
 	// Router specifies an existing router to be used if ManagedSubnets are
@@ -63,6 +64,7 @@ type OpenStackClusterSpec struct {
 
 	// ExternalRouterIPs is an array of externalIPs on the respective subnets.
 	// This is necessary if the router needs a fixed ip in a specific subnet.
+	// +optional
 	ExternalRouterIPs []ExternalRouterIPParam `json:"externalRouterIPs,omitempty"`
 
 	// ExternalNetwork is the OpenStack Network to be used to get public internet to the VMs.
@@ -131,6 +133,7 @@ type OpenStackClusterSpec struct {
 
 	// Tags for all resources in cluster
 	// +listType=set
+	// +optional
 	Tags []string `json:"tags,omitempty"`
 
 	// ControlPlaneEndpoint represents the endpoint used to communicate with the control plane.
@@ -139,6 +142,7 @@ type OpenStackClusterSpec struct {
 
 	// ControlPlaneAvailabilityZones is the az to deploy control plane to
 	// +listType=set
+	// +optional
 	ControlPlaneAvailabilityZones []string `json:"controlPlaneAvailabilityZones,omitempty"`
 
 	// Indicates whether to omit the az for control plane nodes, allowing the Nova scheduler
@@ -167,15 +171,19 @@ type OpenStackClusterStatus struct {
 	Ready bool `json:"ready"`
 
 	// Network contains information about the created OpenStack Network.
+	// +optional
 	Network *NetworkStatusWithSubnets `json:"network,omitempty"`
 
 	// externalNetwork contains information about the external network used for default ingress and egress traffic.
+	// +optional
 	ExternalNetwork *NetworkStatus `json:"externalNetwork,omitempty"`
 
 	// Router describes the default cluster router
+	// +optional
 	Router *Router `json:"router,omitempty"`
 
 	// APIServerLoadBalancer describes the api server load balancer if one exists
+	// +optional
 	APIServerLoadBalancer *LoadBalancer `json:"apiServerLoadBalancer,omitempty"`
 
 	// FailureDomains represent OpenStack availability zones
@@ -184,14 +192,18 @@ type OpenStackClusterStatus struct {
 	// ControlPlaneSecurityGroups contains all the information about the OpenStack
 	// Security Group that needs to be applied to control plane nodes.
 	// TODO: Maybe instead of two properties, we add a property to the group?
+	// +optional
 	ControlPlaneSecurityGroup *SecurityGroupStatus `json:"controlPlaneSecurityGroup,omitempty"`
 
 	// WorkerSecurityGroup contains all the information about the OpenStack Security
 	// Group that needs to be applied to worker nodes.
+	// +optional
 	WorkerSecurityGroup *SecurityGroupStatus `json:"workerSecurityGroup,omitempty"`
 
+	// +optional
 	BastionSecurityGroup *SecurityGroupStatus `json:"bastionSecurityGroup,omitempty"`
 
+	// +optional
 	Bastion *BastionStatus `json:"bastion,omitempty"`
 
 	// FailureReason will be set in the event that there is a terminal problem

docs/book/src/api/v1beta1/api.md

@@ -77,6 +77,7 @@ OpenStackClusterSpec
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ManagedSubnets describe OpenStack Subnets to be created. Cluster actuator will create a network,
 subnets with the defined CIDR, and a router connected to these subnets. Currently only one IPv4
 subnet is supported. If you leave this empty, no network will be created.</p>
@@ -154,6 +155,7 @@ To use this field, the Openstack installation requires the net-mtu neutron API e
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ExternalRouterIPs is an array of externalIPs on the respective subnets.
 This is necessary if the router needs a fixed ip in a specific subnet.</p>
 </td>
@@ -308,6 +310,7 @@ Kubernetes cluster, which also disables SecurityGroups</p>
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>Tags for all resources in cluster</p>
 </td>
 </tr>
@@ -333,6 +336,7 @@ sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ControlPlaneAvailabilityZones is the az to deploy control plane to</p>
 </td>
 </tr>
@@ -1951,6 +1955,7 @@ It may not be empty and may not contain commas.</p>
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ManagedSubnets describe OpenStack Subnets to be created. Cluster actuator will create a network,
 subnets with the defined CIDR, and a router connected to these subnets. Currently only one IPv4
 subnet is supported. If you leave this empty, no network will be created.</p>
@@ -2028,6 +2033,7 @@ To use this field, the Openstack installation requires the net-mtu neutron API e
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ExternalRouterIPs is an array of externalIPs on the respective subnets.
 This is necessary if the router needs a fixed ip in a specific subnet.</p>
 </td>
@@ -2182,6 +2188,7 @@ Kubernetes cluster, which also disables SecurityGroups</p>
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>Tags for all resources in cluster</p>
 </td>
 </tr>
@@ -2207,6 +2214,7 @@ sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ControlPlaneAvailabilityZones is the az to deploy control plane to</p>
 </td>
 </tr>
@@ -2294,6 +2302,7 @@ NetworkStatusWithSubnets
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>Network contains information about the created OpenStack Network.</p>
 </td>
 </tr>
@@ -2307,6 +2316,7 @@ NetworkStatus
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>externalNetwork contains information about the external network used for default ingress and egress traffic.</p>
 </td>
 </tr>
@@ -2320,6 +2330,7 @@ Router
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>Router describes the default cluster router</p>
 </td>
 </tr>
@@ -2333,6 +2344,7 @@ LoadBalancer
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>APIServerLoadBalancer describes the api server load balancer if one exists</p>
 </td>
 </tr>
@@ -2359,6 +2371,7 @@ SecurityGroupStatus
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ControlPlaneSecurityGroups contains all the information about the OpenStack
 Security Group that needs to be applied to control plane nodes.
 TODO: Maybe instead of two properties, we add a property to the group?</p>
@@ -2374,6 +2387,7 @@ SecurityGroupStatus
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>WorkerSecurityGroup contains all the information about the OpenStack Security
 Group that needs to be applied to worker nodes.</p>
 </td>
@@ -2388,6 +2402,7 @@ SecurityGroupStatus
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 </td>
 </tr>
 <tr>
@@ -2400,6 +2415,7 @@ BastionStatus
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 </td>
 </tr>
 <tr>
@@ -2496,6 +2512,7 @@ OpenStackClusterSpec
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ManagedSubnets describe OpenStack Subnets to be created. Cluster actuator will create a network,
 subnets with the defined CIDR, and a router connected to these subnets. Currently only one IPv4
 subnet is supported. If you leave this empty, no network will be created.</p>
@@ -2573,6 +2590,7 @@ To use this field, the Openstack installation requires the net-mtu neutron API e
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ExternalRouterIPs is an array of externalIPs on the respective subnets.
 This is necessary if the router needs a fixed ip in a specific subnet.</p>
 </td>
@@ -2727,6 +2745,7 @@ Kubernetes cluster, which also disables SecurityGroups</p>
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>Tags for all resources in cluster</p>
 </td>
 </tr>
@@ -2752,6 +2771,7 @@ sigs.k8s.io/cluster-api/api/v1beta1.APIEndpoint
 </em>
 </td>
 <td>
+<em>(Optional)</em>
 <p>ControlPlaneAvailabilityZones is the az to deploy control plane to</p>
 </td>
 </tr>