⚠️ Clarify Machine.Spec.ObjectMeta use in godoc

Signed-off-by: Vince Prignano <vincepri@vmware.com>
kubernetes-sigs · Sep 26, 2019 · 80c73c2 · 80c73c2
1 parent 90cbdd1
commit 80c73c2
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 12 deletions.
diff --git a/api/v1alpha2/machine_types.go b/api/v1alpha2/machine_types.go
@@ -37,9 +37,8 @@ const (
 
 // MachineSpec defines the desired state of Machine
 type MachineSpec struct {
-	// ObjectMeta will autopopulate the Node created. Use this to
-	// indicate what labels, annotations, name prefix, etc., should be used
-	// when creating the Node.
+	// ObjectMeta specifies the metadata to associate with a Machine
+	// when using MachineSet or MachineDeployment.
 	// +optional
 	ObjectMeta `json:"metadata,omitempty"`
 

diff --git a/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml b/config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml
@@ -355,9 +355,8 @@ spec:
                           type: string
                       type: object
                     metadata:
-                      description: ObjectMeta will autopopulate the Node created.
-                        Use this to indicate what labels, annotations, name prefix,
-                        etc., should be used when creating the Node.
+                      description: ObjectMeta specifies the metadata to associate
+                        with a Machine when using MachineSet or MachineDeployment.
                       properties:
                         annotations:
                           additionalProperties:

diff --git a/config/crd/bases/cluster.x-k8s.io_machines.yaml b/config/crd/bases/cluster.x-k8s.io_machines.yaml
@@ -139,9 +139,8 @@ spec:
                   type: string
               type: object
             metadata:
-              description: ObjectMeta will autopopulate the Node created. Use this
-                to indicate what labels, annotations, name prefix, etc., should be
-                used when creating the Node.
+              description: ObjectMeta specifies the metadata to associate with a Machine
+                when using MachineSet or MachineDeployment.
               properties:
                 annotations:
                   additionalProperties:

diff --git a/config/crd/bases/cluster.x-k8s.io_machinesets.yaml b/config/crd/bases/cluster.x-k8s.io_machinesets.yaml
@@ -305,9 +305,8 @@ spec:
                           type: string
                       type: object
                     metadata:
-                      description: ObjectMeta will autopopulate the Node created.
-                        Use this to indicate what labels, annotations, name prefix,
-                        etc., should be used when creating the Node.
+                      description: ObjectMeta specifies the metadata to associate
+                        with a Machine when using MachineSet or MachineDeployment.
                       properties:
                         annotations:
                           additionalProperties: