diff --git a/apis/v1alpha3/cloudprovider_types.go b/apis/v1alpha3/cloudprovider_types.go index e3aaf766c9..66b6b1ea00 100644 --- a/apis/v1alpha3/cloudprovider_types.go +++ b/apis/v1alpha3/cloudprovider_types.go @@ -27,7 +27,8 @@ limitations under the License. package v1alpha3 // CPIConfig is the vSphere cloud provider's configuration. -// Depracated: will be removed in v1alpha4. +// +// Deprecated: will be removed in v1alpha4. type CPIConfig struct { // Global is the vSphere cloud provider's global configuration. // +optional diff --git a/apis/v1alpha3/vspherecluster_types.go b/apis/v1alpha3/vspherecluster_types.go index c38d25a347..4e0b1773a5 100644 --- a/apis/v1alpha3/vspherecluster_types.go +++ b/apis/v1alpha3/vspherecluster_types.go @@ -22,6 +22,13 @@ import ( clusterv1alpha3 "sigs.k8s.io/cluster-api/api/v1alpha3" ) +const ( + // ClusterFinalizer allows ReconcileVSphereCluster to clean up vSphere + // resources associated with VSphereCluster before removing it from the + // API server. + ClusterFinalizer = "vspherecluster.infrastructure.cluster.x-k8s.io" +) + // VSphereClusterSpec defines the desired state of VSphereCluster. type VSphereClusterSpec struct { // Server is the address of the vSphere endpoint. @@ -29,7 +36,8 @@ type VSphereClusterSpec struct { // Insecure is a flag that controls whether to validate the // vSphere server's certificate. - // Depracated: will be removed in v1alpha4 + // + // Deprecated: will be removed in v1alpha4. // +optional Insecure *bool `json:"insecure,omitempty"` @@ -38,9 +46,9 @@ type VSphereClusterSpec struct { // +optional Thumbprint string `json:"thumbprint,omitempty"` - // CloudProviderConfiguration holds the cluster-wide configuration for the - // Depracated: will be removed in v1alpha4 - // vSphere cloud provider. + // CloudProviderConfiguration holds the cluster-wide configuration for the vSphere cloud provider. + // + // Deprecated: will be removed in v1alpha4. CloudProviderConfiguration CPIConfig `json:"cloudProviderConfiguration,omitempty"` // ControlPlaneEndpoint represents the endpoint used to communicate with the control plane. @@ -52,7 +60,8 @@ type VSphereClusterSpec struct { // When a LoadBalancerRef is provided, the VSphereCluster.Status.Ready field // will not be true until the referenced resource is Status.Ready and has a // non-empty Status.Address value. - // Depracated: will be removed in v1alpha4 + // + // Deprecated: will be removed in v1alpha4. // +optional LoadBalancerRef *corev1.ObjectReference `json:"loadBalancerRef,omitempty"` diff --git a/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vsphereclusters.yaml b/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vsphereclusters.yaml index 3b2ea4a8c5..0ee84903f3 100644 --- a/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vsphereclusters.yaml +++ b/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vsphereclusters.yaml @@ -57,8 +57,9 @@ spec: description: VSphereClusterSpec defines the desired state of VSphereCluster. properties: cloudProviderConfiguration: - description: 'CloudProviderConfiguration holds the cluster-wide configuration - for the Depracated: will be removed in v1alpha4 vSphere cloud provider.' + description: "CloudProviderConfiguration holds the cluster-wide configuration + for the vSphere cloud provider. \n Deprecated: will be removed in + v1alpha4." properties: disk: description: Disk is the vSphere cloud provider's disk configuration. @@ -279,16 +280,16 @@ spec: - name type: object insecure: - description: 'Insecure is a flag that controls whether to validate - the vSphere server''s certificate. Depracated: will be removed in - v1alpha4' + description: "Insecure is a flag that controls whether to validate + the vSphere server's certificate. \n Deprecated: will be removed + in v1alpha4." type: boolean loadBalancerRef: - description: 'LoadBalancerRef may be used to enable a control plane + description: "LoadBalancerRef may be used to enable a control plane load balancer for this cluster. When a LoadBalancerRef is provided, the VSphereCluster.Status.Ready field will not be true until the referenced resource is Status.Ready and has a non-empty Status.Address - value. Depracated: will be removed in v1alpha4' + value. \n Deprecated: will be removed in v1alpha4." properties: apiVersion: description: API version of the referent.