1apiVersion: apiextensions.k8s.io/v1
2kind: CustomResourceDefinition
3metadata:
4 annotations:
5 api-approved.openshift.io: https://github.com/openshift/api/pull/948
6 exclude.release.openshift.io/internal-openshift-hosted: "true"
7 include.release.openshift.io/self-managed-high-availability: "true"
8 include.release.openshift.io/single-node-developer: "true"
9 name: machines.machine.openshift.io
10spec:
11 group: machine.openshift.io
12 names:
13 kind: Machine
14 listKind: MachineList
15 plural: machines
16 singular: machine
17 scope: Namespaced
18 versions:
19 - additionalPrinterColumns:
20 - description: Phase of machine
21 jsonPath: .status.phase
22 name: Phase
23 type: string
24 - description: Type of instance
25 jsonPath: .metadata.labels['machine\.openshift\.io/instance-type']
26 name: Type
27 type: string
28 - description: Region associated with machine
29 jsonPath: .metadata.labels['machine\.openshift\.io/region']
30 name: Region
31 type: string
32 - description: Zone associated with machine
33 jsonPath: .metadata.labels['machine\.openshift\.io/zone']
34 name: Zone
35 type: string
36 - description: Machine age
37 jsonPath: .metadata.creationTimestamp
38 name: Age
39 type: date
40 - description: Node associated with machine
41 jsonPath: .status.nodeRef.name
42 name: Node
43 priority: 1
44 type: string
45 - description: Provider ID of machine created in cloud provider
46 jsonPath: .spec.providerID
47 name: ProviderID
48 priority: 1
49 type: string
50 - description: State of instance
51 jsonPath: .metadata.annotations['machine\.openshift\.io/instance-state']
52 name: State
53 priority: 1
54 type: string
55 name: v1beta1
56 schema:
57 openAPIV3Schema:
58 description: 'Machine is the Schema for the machines API Compatibility level 2: Stable within a major release for a minimum of 9 months or 3 minor releases (whichever is longer).'
59 type: object
60 properties:
61 apiVersion:
62 description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
63 type: string
64 kind:
65 description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
66 type: string
67 metadata:
68 type: object
69 spec:
70 description: MachineSpec defines the desired state of Machine
71 type: object
72 properties:
73 lifecycleHooks:
74 description: LifecycleHooks allow users to pause operations on the machine at certain predefined points within the machine lifecycle.
75 type: object
76 properties:
77 preDrain:
78 description: PreDrain hooks prevent the machine from being drained. This also blocks further lifecycle events, such as termination.
79 type: array
80 items:
81 description: LifecycleHook represents a single instance of a lifecycle hook
82 type: object
83 required:
84 - name
85 - owner
86 properties:
87 name:
88 description: Name defines a unique name for the lifcycle hook. The name should be unique and descriptive, ideally 1-3 words, in CamelCase or it may be namespaced, eg. foo.example.com/CamelCase. Names must be unique and should only be managed by a single entity.
89 type: string
90 maxLength: 256
91 minLength: 3
92 pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
93 owner:
94 description: Owner defines the owner of the lifecycle hook. This should be descriptive enough so that users can identify who/what is responsible for blocking the lifecycle. This could be the name of a controller (e.g. clusteroperator/etcd) or an administrator managing the hook.
95 type: string
96 maxLength: 512
97 minLength: 3
98 x-kubernetes-list-map-keys:
99 - name
100 x-kubernetes-list-type: map
101 preTerminate:
102 description: PreTerminate hooks prevent the machine from being terminated. PreTerminate hooks be actioned after the Machine has been drained.
103 type: array
104 items:
105 description: LifecycleHook represents a single instance of a lifecycle hook
106 type: object
107 required:
108 - name
109 - owner
110 properties:
111 name:
112 description: Name defines a unique name for the lifcycle hook. The name should be unique and descriptive, ideally 1-3 words, in CamelCase or it may be namespaced, eg. foo.example.com/CamelCase. Names must be unique and should only be managed by a single entity.
113 type: string
114 maxLength: 256
115 minLength: 3
116 pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
117 owner:
118 description: Owner defines the owner of the lifecycle hook. This should be descriptive enough so that users can identify who/what is responsible for blocking the lifecycle. This could be the name of a controller (e.g. clusteroperator/etcd) or an administrator managing the hook.
119 type: string
120 maxLength: 512
121 minLength: 3
122 x-kubernetes-list-map-keys:
123 - name
124 x-kubernetes-list-type: map
125 metadata:
126 description: ObjectMeta will autopopulate the Node created. Use this to indicate what labels, annotations, name prefix, etc., should be used when creating the Node.
127 type: object
128 properties:
129 annotations:
130 description: 'Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations'
131 type: object
132 additionalProperties:
133 type: string
134 generateName:
135 description: "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. \n If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). \n Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
136 type: string
137 labels:
138 description: 'Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels'
139 type: object
140 additionalProperties:
141 type: string
142 name:
143 description: 'Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names'
144 type: string
145 namespace:
146 description: "Namespace defines the space within each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. \n Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
147 type: string
148 ownerReferences:
149 description: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
150 type: array
151 items:
152 description: OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
153 type: object
154 required:
155 - apiVersion
156 - kind
157 - name
158 - uid
159 properties:
160 apiVersion:
161 description: API version of the referent.
162 type: string
163 blockOwnerDeletion:
164 description: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
165 type: boolean
166 controller:
167 description: If true, this reference points to the managing controller.
168 type: boolean
169 kind:
170 description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
171 type: string
172 name:
173 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names'
174 type: string
175 uid:
176 description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids'
177 type: string
178 x-kubernetes-map-type: atomic
179 providerID:
180 description: ProviderID is the identification ID of the machine provided by the provider. This field must match the provider ID as seen on the node object corresponding to this machine. This field is required by higher level consumers of cluster-api. Example use case is cluster autoscaler with cluster-api as provider. Clean-up logic in the autoscaler compares machines to nodes to find out machines at provider which could not get registered as Kubernetes nodes. With cluster-api as a generic out-of-tree provider for autoscaler, this field is required by autoscaler to be able to have a provider view of the list of machines. Another list of nodes is queried from the k8s apiserver and then a comparison is done to find out unregistered machines and are marked for delete. This field will be set by the actuators and consumed by higher level entities like autoscaler that will be interfacing with cluster-api as generic provider.
181 type: string
182 providerSpec:
183 description: ProviderSpec details Provider-specific configuration to use during node creation.
184 type: object
185 properties:
186 value:
187 description: Value is an inlined, serialized representation of the resource configuration. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field, akin to component config.
188 type: object
189 x-kubernetes-preserve-unknown-fields: true
190 taints:
191 description: The list of the taints to be applied to the corresponding Node in additive manner. This list will not overwrite any other taints added to the Node on an ongoing basis by other entities. These taints should be actively reconciled e.g. if you ask the machine controller to apply a taint and then manually remove the taint the machine controller will put it back) but not have the machine controller remove any taints
192 type: array
193 items:
194 description: The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.
195 type: object
196 required:
197 - effect
198 - key
199 properties:
200 effect:
201 description: Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
202 type: string
203 key:
204 description: Required. The taint key to be applied to a node.
205 type: string
206 timeAdded:
207 description: TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints.
208 type: string
209 format: date-time
210 value:
211 description: The taint value corresponding to the taint key.
212 type: string
213 status:
214 description: MachineStatus defines the observed state of Machine
215 type: object
216 properties:
217 addresses:
218 description: Addresses is a list of addresses assigned to the machine. Queried from cloud provider, if available.
219 type: array
220 items:
221 description: NodeAddress contains information for the node's address.
222 type: object
223 required:
224 - address
225 - type
226 properties:
227 address:
228 description: The node address.
229 type: string
230 type:
231 description: Node address type, one of Hostname, ExternalIP or InternalIP.
232 type: string
233 conditions:
234 description: Conditions defines the current state of the Machine
235 type: array
236 items:
237 description: Condition defines an observation of a Machine API resource operational state.
238 type: object
239 properties:
240 lastTransitionTime:
241 description: Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
242 type: string
243 format: date-time
244 message:
245 description: A human readable message indicating details about the transition. This field may be empty.
246 type: string
247 reason:
248 description: The reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.
249 type: string
250 severity:
251 description: Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.
252 type: string
253 status:
254 description: Status of the condition, one of True, False, Unknown.
255 type: string
256 type:
257 description: Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.
258 type: string
259 errorMessage:
260 description: "ErrorMessage will be set in the event that there is a terminal problem reconciling the Machine and will contain a more verbose string suitable for logging and human consumption. \n This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. \n Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output."
261 type: string
262 errorReason:
263 description: "ErrorReason will be set in the event that there is a terminal problem reconciling the Machine and will contain a succinct value suitable for machine interpretation. \n This field should not be set for transitive errors that a controller faces that are expected to be fixed automatically over time (like service outages), but instead indicate that something is fundamentally wrong with the Machine's spec or the configuration of the controller, and that manual intervention is required. Examples of terminal errors would be invalid combinations of settings in the spec, values that are unsupported by the controller, or the responsible controller itself being critically misconfigured. \n Any transient errors that occur during the reconciliation of Machines can be added as events to the Machine object and/or logged in the controller's output."
264 type: string
265 lastOperation:
266 description: LastOperation describes the last-operation performed by the machine-controller. This API should be useful as a history in terms of the latest operation performed on the specific machine. It should also convey the state of the latest-operation for example if it is still on-going, failed or completed successfully.
267 type: object
268 properties:
269 description:
270 description: Description is the human-readable description of the last operation.
271 type: string
272 lastUpdated:
273 description: LastUpdated is the timestamp at which LastOperation API was last-updated.
274 type: string
275 format: date-time
276 state:
277 description: State is the current status of the last performed operation. E.g. Processing, Failed, Successful etc
278 type: string
279 type:
280 description: Type is the type of operation which was last performed. E.g. Create, Delete, Update etc
281 type: string
282 lastUpdated:
283 description: LastUpdated identifies when this status was last observed.
284 type: string
285 format: date-time
286 nodeRef:
287 description: NodeRef will point to the corresponding Node if it exists.
288 type: object
289 properties:
290 apiVersion:
291 description: API version of the referent.
292 type: string
293 fieldPath:
294 description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.'
295 type: string
296 kind:
297 description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
298 type: string
299 name:
300 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
301 type: string
302 namespace:
303 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
304 type: string
305 resourceVersion:
306 description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
307 type: string
308 uid:
309 description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
310 type: string
311 x-kubernetes-map-type: atomic
312 phase:
313 description: 'Phase represents the current phase of machine actuation. One of: Failed, Provisioning, Provisioned, Running, Deleting'
314 type: string
315 providerStatus:
316 description: ProviderStatus details a Provider-specific status. It is recommended that providers maintain their own versioned API types that should be serialized/deserialized from this field.
317 type: object
318 x-kubernetes-preserve-unknown-fields: true
319 served: true
320 storage: true
321 subresources:
322 status: {}
323status:
324 acceptedNames:
325 kind: ""
326 plural: ""
327 conditions: []
328 storedVersions: []
View as plain text