@@ -97,20 +97,20 @@ spec:
97
97
type : string
98
98
lifecycleHooks :
99
99
description : |-
100
- LifecycleHooks allow users to pause operations on the machine at
100
+ lifecycleHooks allow users to pause operations on the machine at
101
101
certain predefined points within the machine lifecycle.
102
102
properties :
103
103
preDrain :
104
104
description : |-
105
- PreDrain hooks prevent the machine from being drained.
105
+ preDrain hooks prevent the machine from being drained.
106
106
This also blocks further lifecycle events, such as termination.
107
107
items :
108
108
description : LifecycleHook represents a single instance of a
109
109
lifecycle hook
110
110
properties :
111
111
name :
112
112
description : |-
113
- Name defines a unique name for the lifcycle hook.
113
+ name defines a unique name for the lifcycle hook.
114
114
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
115
115
it may be namespaced, eg. foo.example.com/CamelCase.
116
116
Names must be unique and should only be managed by a single entity.
@@ -120,7 +120,7 @@ spec:
120
120
type : string
121
121
owner :
122
122
description : |-
123
- Owner defines the owner of the lifecycle hook.
123
+ owner defines the owner of the lifecycle hook.
124
124
This should be descriptive enough so that users can identify
125
125
who/what is responsible for blocking the lifecycle.
126
126
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -138,15 +138,15 @@ spec:
138
138
x-kubernetes-list-type : map
139
139
preTerminate :
140
140
description : |-
141
- PreTerminate hooks prevent the machine from being terminated.
141
+ preTerminate hooks prevent the machine from being terminated.
142
142
PreTerminate hooks be actioned after the Machine has been drained.
143
143
items :
144
144
description : LifecycleHook represents a single instance of a
145
145
lifecycle hook
146
146
properties :
147
147
name :
148
148
description : |-
149
- Name defines a unique name for the lifcycle hook.
149
+ name defines a unique name for the lifcycle hook.
150
150
The name should be unique and descriptive, ideally 1-3 words, in CamelCase or
151
151
it may be namespaced, eg. foo.example.com/CamelCase.
152
152
Names must be unique and should only be managed by a single entity.
@@ -156,7 +156,7 @@ spec:
156
156
type : string
157
157
owner :
158
158
description : |-
159
- Owner defines the owner of the lifecycle hook.
159
+ owner defines the owner of the lifecycle hook.
160
160
This should be descriptive enough so that users can identify
161
161
who/what is responsible for blocking the lifecycle.
162
162
This could be the name of a controller (e.g. clusteroperator/etcd)
@@ -183,14 +183,14 @@ spec:
183
183
additionalProperties :
184
184
type : string
185
185
description : |-
186
- Annotations is an unstructured key value map stored with a resource that may be
186
+ annotations is an unstructured key value map stored with a resource that may be
187
187
set by external tools to store and retrieve arbitrary metadata. They are not
188
188
queryable and should be preserved when modifying objects.
189
189
More info: http://kubernetes.io/docs/user-guide/annotations
190
190
type : object
191
191
generateName :
192
192
description : |-
193
- GenerateName is an optional prefix, used by the server, to generate a unique
193
+ generateName is an optional prefix, used by the server, to generate a unique
194
194
name ONLY IF the Name field has not been provided.
195
195
If this field is used, the name returned to the client will be different
196
196
than the name passed. This value will also be combined with a unique suffix.
@@ -217,7 +217,7 @@ spec:
217
217
type : object
218
218
name :
219
219
description : |-
220
- Name must be unique within a namespace. Is required when creating resources, although
220
+ name must be unique within a namespace. Is required when creating resources, although
221
221
some resources may allow a client to request the generation of an appropriate name
222
222
automatically. Name is primarily intended for creation idempotence and configuration
223
223
definition.
@@ -226,7 +226,7 @@ spec:
226
226
type : string
227
227
namespace :
228
228
description : |-
229
- Namespace defines the space within each name must be unique. An empty namespace is
229
+ namespace defines the space within each name must be unique. An empty namespace is
230
230
equivalent to the "default" namespace, but "default" is the canonical representation.
231
231
Not all objects are required to be scoped to a namespace - the value of this field for
232
232
those objects will be empty.
@@ -294,7 +294,7 @@ spec:
294
294
type : object
295
295
providerID :
296
296
description : |-
297
- ProviderID is the identification ID of the machine provided by the provider.
297
+ providerID is the identification ID of the machine provided by the provider.
298
298
This field must match the provider ID as seen on the node object corresponding to this machine.
299
299
This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler
300
300
with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out
@@ -306,12 +306,12 @@ spec:
306
306
be interfacing with cluster-api as generic provider.
307
307
type : string
308
308
providerSpec :
309
- description : ProviderSpec details Provider-specific configuration
309
+ description : providerSpec details Provider-specific configuration
310
310
to use during node creation.
311
311
properties :
312
312
value :
313
313
description : |-
314
- Value is an inlined, serialized representation of the resource
314
+ value is an inlined, serialized representation of the resource
315
315
configuration. It is recommended that providers maintain their own
316
316
versioned API types that should be serialized/deserialized from this
317
317
field, akin to component config.
@@ -360,7 +360,7 @@ spec:
360
360
description : MachineStatus defines the observed state of Machine
361
361
properties :
362
362
addresses :
363
- description : Addresses is a list of addresses assigned to the machine.
363
+ description : addresses is a list of addresses assigned to the machine.
364
364
Queried from cloud provider, if available.
365
365
items :
366
366
description : NodeAddress contains information for the node's address.
@@ -396,7 +396,7 @@ spec:
396
396
through Migrating.
397
397
rule : self == 'Migrating' || self == oldSelf || oldSelf == 'Migrating'
398
398
conditions :
399
- description : Conditions defines the current state of the Machine
399
+ description : conditions defines the current state of the Machine
400
400
items :
401
401
description : Condition defines an observation of a Machine API resource
402
402
operational state.
@@ -421,16 +421,16 @@ spec:
421
421
type : string
422
422
severity :
423
423
description : |-
424
- Severity provides an explicit classification of Reason code, so the users or machines can immediately
424
+ severity provides an explicit classification of Reason code, so the users or machines can immediately
425
425
understand the current situation and act accordingly.
426
426
The Severity field MUST be set only when Status=False.
427
427
type : string
428
428
status :
429
- description : Status of the condition, one of True, False, Unknown.
429
+ description : status of the condition, one of True, False, Unknown.
430
430
type : string
431
431
type :
432
432
description : |-
433
- Type of condition in CamelCase or in foo.example.com/CamelCase.
433
+ type of condition in CamelCase or in foo.example.com/CamelCase.
434
434
Many .condition.type values are consistent across resources like Available, but because arbitrary conditions
435
435
can be useful (see .node.status.conditions), the ability to deconflict is important.
436
436
type : string
@@ -445,7 +445,7 @@ spec:
445
445
x-kubernetes-list-type : map
446
446
errorMessage :
447
447
description : |-
448
- ErrorMessage will be set in the event that there is a terminal problem
448
+ errorMessage will be set in the event that there is a terminal problem
449
449
reconciling the Machine and will contain a more verbose string suitable
450
450
for logging and human consumption.
451
451
@@ -464,7 +464,7 @@ spec:
464
464
type : string
465
465
errorReason :
466
466
description : |-
467
- ErrorReason will be set in the event that there is a terminal problem
467
+ errorReason will be set in the event that there is a terminal problem
468
468
reconciling the Machine and will contain a succinct value suitable
469
469
for machine interpretation.
470
470
@@ -483,37 +483,37 @@ spec:
483
483
type : string
484
484
lastOperation :
485
485
description : |-
486
- LastOperation describes the last-operation performed by the machine-controller.
486
+ lastOperation describes the last-operation performed by the machine-controller.
487
487
This API should be useful as a history in terms of the latest operation performed on the
488
488
specific machine. It should also convey the state of the latest-operation for example if
489
489
it is still on-going, failed or completed successfully.
490
490
properties :
491
491
description :
492
- description : Description is the human-readable description of
492
+ description : description is the human-readable description of
493
493
the last operation.
494
494
type : string
495
495
lastUpdated :
496
- description : LastUpdated is the timestamp at which LastOperation
496
+ description : lastUpdated is the timestamp at which LastOperation
497
497
API was last-updated.
498
498
format : date-time
499
499
type : string
500
500
state :
501
501
description : |-
502
- State is the current status of the last performed operation.
502
+ state is the current status of the last performed operation.
503
503
E.g. Processing, Failed, Successful etc
504
504
type : string
505
505
type :
506
506
description : |-
507
- Type is the type of operation which was last performed.
507
+ type is the type of operation which was last performed.
508
508
E.g. Create, Delete, Update etc
509
509
type : string
510
510
type : object
511
511
lastUpdated :
512
- description : LastUpdated identifies when this status was last observed.
512
+ description : lastUpdated identifies when this status was last observed.
513
513
format : date-time
514
514
type : string
515
515
nodeRef :
516
- description : NodeRef will point to the corresponding Node if it exists.
516
+ description : nodeRef will point to the corresponding Node if it exists.
517
517
properties :
518
518
apiVersion :
519
519
description : API version of the referent.
@@ -557,12 +557,12 @@ spec:
557
557
x-kubernetes-map-type : atomic
558
558
phase :
559
559
description : |-
560
- Phase represents the current phase of machine actuation.
560
+ phase represents the current phase of machine actuation.
561
561
One of: Failed, Provisioning, Provisioned, Running, Deleting
562
562
type : string
563
563
providerStatus :
564
564
description : |-
565
- ProviderStatus details a Provider-specific status.
565
+ providerStatus details a Provider-specific status.
566
566
It is recommended that providers maintain their
567
567
own versioned API types that should be
568
568
serialized/deserialized from this field.
0 commit comments