Skip to content

Commit 80c73c2

Browse files
committed
⚠️ Clarify Machine.Spec.ObjectMeta use in godoc
Signed-off-by: Vince Prignano <[email protected]>
1 parent 90cbdd1 commit 80c73c2

File tree

4 files changed

+8
-12
lines changed

4 files changed

+8
-12
lines changed

api/v1alpha2/machine_types.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,8 @@ const (
3737

3838
// MachineSpec defines the desired state of Machine
3939
type MachineSpec struct {
40-
// ObjectMeta will autopopulate the Node created. Use this to
41-
// indicate what labels, annotations, name prefix, etc., should be used
42-
// when creating the Node.
40+
// ObjectMeta specifies the metadata to associate with a Machine
41+
// when using MachineSet or MachineDeployment.
4342
// +optional
4443
ObjectMeta `json:"metadata,omitempty"`
4544

config/crd/bases/cluster.x-k8s.io_machinedeployments.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -355,9 +355,8 @@ spec:
355355
type: string
356356
type: object
357357
metadata:
358-
description: ObjectMeta will autopopulate the Node created.
359-
Use this to indicate what labels, annotations, name prefix,
360-
etc., should be used when creating the Node.
358+
description: ObjectMeta specifies the metadata to associate
359+
with a Machine when using MachineSet or MachineDeployment.
361360
properties:
362361
annotations:
363362
additionalProperties:

config/crd/bases/cluster.x-k8s.io_machines.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,8 @@ spec:
139139
type: string
140140
type: object
141141
metadata:
142-
description: ObjectMeta will autopopulate the Node created. Use this
143-
to indicate what labels, annotations, name prefix, etc., should be
144-
used when creating the Node.
142+
description: ObjectMeta specifies the metadata to associate with a Machine
143+
when using MachineSet or MachineDeployment.
145144
properties:
146145
annotations:
147146
additionalProperties:

config/crd/bases/cluster.x-k8s.io_machinesets.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -305,9 +305,8 @@ spec:
305305
type: string
306306
type: object
307307
metadata:
308-
description: ObjectMeta will autopopulate the Node created.
309-
Use this to indicate what labels, annotations, name prefix,
310-
etc., should be used when creating the Node.
308+
description: ObjectMeta specifies the metadata to associate
309+
with a Machine when using MachineSet or MachineDeployment.
311310
properties:
312311
annotations:
313312
additionalProperties:

0 commit comments

Comments
 (0)