Merge pull request #2321 from chrischdi/pr-godoc-failuredomainselecto…

…r-improve 🌱 Improve godoc for VSphereCluster.spec.failureDomainSelector
kubernetes-sigs · Sep 5, 2023 · 31b8129 · 31b8129
2 parents fb0ccb5 + efb9dd9
commit 31b8129
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/apis/v1beta1/vspherecluster_types.go b/apis/v1beta1/vspherecluster_types.go
@@ -61,7 +61,9 @@ type VSphereClusterSpec struct {
 
 	// FailureDomainSelector is the label selector to use for failure domain selection
 	// for the control plane nodes of the cluster.
-	// An empty value for the selector includes all the related failure domains.
+	// If not set (`nil`), selecting failure domains will be disabled.
+	// An empty value (`{}`) selects all existing failure domains.
+	// A valid selector will select all failure domains which match the selector.
 	// +optional
 	FailureDomainSelector *metav1.LabelSelector `json:"failureDomainSelector,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
@@ -651,8 +651,9 @@ spec:
               failureDomainSelector:
                 description: FailureDomainSelector is the label selector to use for
                   failure domain selection for the control plane nodes of the cluster.
-                  An empty value for the selector includes all the related failure
-                  domains.
+                  If not set (`nil`), selecting failure domains will be disabled.
+                  An empty value (`{}`) selects all existing failure domains. A valid
+                  selector will select all failure domains which match the selector.
                 properties:
                   matchExpressions:
                     description: matchExpressions is a list of label selector requirements.

diff --git a/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vsphereclustertemplates.yaml b/config/default/crd/bases/infrastructure.cluster.x-k8s.io_vsphereclustertemplates.yaml
@@ -171,8 +171,10 @@ spec:
                       failureDomainSelector:
                         description: FailureDomainSelector is the label selector to
                           use for failure domain selection for the control plane nodes
-                          of the cluster. An empty value for the selector includes
-                          all the related failure domains.
+                          of the cluster. If not set (`nil`), selecting failure domains
+                          will be disabled. An empty value (`{}`) selects all existing
+                          failure domains. A valid selector will select all failure
+                          domains which match the selector.
                         properties:
                           matchExpressions:
                             description: matchExpressions is a list of label selector