Last generated October 19, 2020

MachineDeployment

MachineDeployment is the Schema for the machinedeployments API

Full name:
machinedeployments.cluster.x-k8s.io
Group:
cluster.x-k8s.io
Singular name:
machinedeployment
Plural name:
machinedeployments
Scope:
Namespaced
Versions:
v1alpha2v1alpha3

Version v1alpha2

Example CR


apiVersion: infrastructure.giantswarm.io/v1alpha2
kind: MachineDeployment
metadata:
  annotations:
    giantswarm.io/docs: https://pkg.go.dev/sigs.k8s.io/cluster-api/api/v1alpha2?tab=doc#MachineDeployment
  creationTimestamp: null
  name: e3z8q
spec:
  replicas: 10
  selector: {}
  template:
    metadata: {}
    spec:
      bootstrap: {}
      infrastructureRef:
        apiVersion: infrastructure.giantswarm.io/v1alpha2
        kind: AWSMachineDeployment
        name: e3z8q
        namespace: default
        resourceVersion: "58776588"
        uid: b5fdf153-6f10-462b-a49f-0e821873d16b
      metadata: {}

Properties

.apiVersion

string

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

.kind

string

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

.metadata

object

.spec

object

MachineDeploymentSpec defines the desired state of MachineDeployment

.spec.minReadySeconds

integer

Minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready)

.spec.paused

boolean

Indicates that the deployment is paused.

.spec.progressDeadlineSeconds

integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

.spec.replicas

integer

Number of desired machines. Defaults to 1. This is a pointer to distinguish between explicit zero and not specified.

.spec.revisionHistoryLimit

integer

The number of old MachineSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

.spec.selector

object Required

Label selector for machines. Existing MachineSets whose machines are selected by this will be the ones affected by this deployment. It must match the machine template’s labels.

.spec.selector.matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

.spec.selector.matchExpressions[*]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

.spec.selector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.selector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.selector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.selector.matchExpressions[*].values[*]

string

.spec.selector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.strategy

object

The deployment strategy to use to replace existing machines with new ones.

.spec.strategy.rollingUpdate

object

Rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.

.spec.strategy.rollingUpdate.maxSurge

The maximum number of machines that can be scheduled above the desired number of machines. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 1. Example: when this is set to 30%, the new MachineSet can be scaled up immediately when the rolling update starts, such that the total number of old and new machines do not exceed 130% of desired machines. Once old machines have been killed, new MachineSet can be scaled up further, ensuring that total number of machines running at any time during the update is at most 130% of desired machines.

.spec.strategy.rollingUpdate.maxUnavailable

The maximum number of machines that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 0. Example: when this is set to 30%, the old MachineSet can be scaled down to 70% of desired machines immediately when the rolling update starts. Once new machines are ready, old MachineSet can be scaled down further, followed by scaling up the new MachineSet, ensuring that the total number of machines available at all times during the update is at least 70% of desired machines.

.spec.strategy.type

string

Type of deployment. Currently the only supported strategy is “RollingUpdate”. Default is RollingUpdate.

.spec.template

object Required

Template describes the machines that will be created.

.spec.template.metadata

.spec.template.metadata.annotations

object

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

.spec.template.metadata.generateName

string

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. 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

.spec.template.metadata.labels

object

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

.spec.template.metadata.name

string

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

.spec.template.metadata.namespace

string

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. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

.spec.template.metadata.ownerReferences

array

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.

.spec.template.metadata.ownerReferences[*]

object

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.

.spec.template.metadata.ownerReferences[*].apiVersion

string Required

API version of the referent.

.spec.template.metadata.ownerReferences[*].blockOwnerDeletion

boolean

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. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

.spec.template.metadata.ownerReferences[*].controller

boolean

If true, this reference points to the managing controller.

.spec.template.metadata.ownerReferences[*].kind

.spec.template.metadata.ownerReferences[*].name

string Required

.spec.template.metadata.ownerReferences[*].uid

string Required

.spec.template.spec

object

.spec.template.spec.bootstrap

object Required

Bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism.

.spec.template.spec.bootstrap.configRef

object

ConfigRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.Data without the need of a controller.

.spec.template.spec.bootstrap.configRef.apiVersion

string

API version of the referent.

.spec.template.spec.bootstrap.configRef.fieldPath

string

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.

.spec.template.spec.bootstrap.configRef.kind

.spec.template.spec.bootstrap.configRef.name

.spec.template.spec.bootstrap.configRef.namespace

.spec.template.spec.bootstrap.configRef.resourceVersion

string

.spec.template.spec.bootstrap.configRef.uid

.spec.template.spec.bootstrap.data

string

Data contains the bootstrap data, such as cloud-init details scripts. If nil, the Machine should remain in the Pending state.

.spec.template.spec.infrastructureRef

object Required

InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.

.spec.template.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.template.spec.infrastructureRef.fieldPath

string

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.

.spec.template.spec.infrastructureRef.kind

.spec.template.spec.infrastructureRef.name

.spec.template.spec.infrastructureRef.namespace

.spec.template.spec.infrastructureRef.resourceVersion

string

.spec.template.spec.infrastructureRef.uid

.spec.template.spec.metadata

object

DEPRECATED: ObjectMeta has no function and isn’t used anywhere.

.spec.template.spec.metadata.annotations

object

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

.spec.template.spec.metadata.generateName

string

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. 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

.spec.template.spec.metadata.labels

object

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

.spec.template.spec.metadata.name

string

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

.spec.template.spec.metadata.namespace

string

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. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

.spec.template.spec.metadata.ownerReferences

array

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.

.spec.template.spec.metadata.ownerReferences[*]

object

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.

.spec.template.spec.metadata.ownerReferences[*].apiVersion

string Required

API version of the referent.

.spec.template.spec.metadata.ownerReferences[*].blockOwnerDeletion

boolean

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. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

.spec.template.spec.metadata.ownerReferences[*].controller

boolean

If true, this reference points to the managing controller.

.spec.template.spec.metadata.ownerReferences[*].kind

.spec.template.spec.metadata.ownerReferences[*].name

string Required

.spec.template.spec.metadata.ownerReferences[*].uid

string Required

.spec.template.spec.providerID

string

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.

.spec.template.spec.version

string

Version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers.

.status

object

MachineDeploymentStatus defines the observed state of MachineDeployment

.status.availableReplicas

integer

Total number of available machines (ready for at least minReadySeconds) targeted by this deployment.

.status.observedGeneration

integer

The generation observed by the deployment controller.

.status.readyReplicas

integer

Total number of ready machines targeted by this deployment.

.status.replicas

integer

Total number of non-terminated machines targeted by this deployment (their labels match the selector).

.status.selector

string

Selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

.status.unavailableReplicas

integer

Total number of unavailable machines targeted by this deployment. This is the total number of machines that are still required for the deployment to have 100% available capacity. They may either be machines that are running but not yet available or machines that still have not been created.

.status.updatedReplicas

integer

Total number of non-terminated machines targeted by this deployment that have the desired template spec.

Version v1alpha3

Properties

.apiVersion

string

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

.kind

string

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

.metadata

object

.spec

object

MachineDeploymentSpec defines the desired state of MachineDeployment

.spec.clusterName

string Required

ClusterName is the name of the Cluster this object belongs to.

.spec.minReadySeconds

integer

Minimum number of seconds for which a newly created machine should be ready. Defaults to 0 (machine will be considered available as soon as it is ready)

.spec.paused

boolean

Indicates that the deployment is paused.

.spec.progressDeadlineSeconds

integer

The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s.

.spec.replicas

integer

Number of desired machines. Defaults to 1. This is a pointer to distinguish between explicit zero and not specified.

.spec.revisionHistoryLimit

integer

The number of old MachineSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.

.spec.selector

object Required

Label selector for machines. Existing MachineSets whose machines are selected by this will be the ones affected by this deployment. It must match the machine template’s labels.

.spec.selector.matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

.spec.selector.matchExpressions[*]

object

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

.spec.selector.matchExpressions[*].key

string Required

key is the label key that the selector applies to.

.spec.selector.matchExpressions[*].operator

string Required

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.selector.matchExpressions[*].values

array

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

.spec.selector.matchExpressions[*].values[*]

string

.spec.selector.matchLabels

object

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

.spec.strategy

object

The deployment strategy to use to replace existing machines with new ones.

.spec.strategy.rollingUpdate

object

Rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.

.spec.strategy.rollingUpdate.maxSurge

The maximum number of machines that can be scheduled above the desired number of machines. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 1. Example: when this is set to 30%, the new MachineSet can be scaled up immediately when the rolling update starts, such that the total number of old and new machines do not exceed 130% of desired machines. Once old machines have been killed, new MachineSet can be scaled up further, ensuring that total number of machines running at any time during the update is at most 130% of desired machines.

.spec.strategy.rollingUpdate.maxUnavailable

The maximum number of machines that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired machines (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 0. Example: when this is set to 30%, the old MachineSet can be scaled down to 70% of desired machines immediately when the rolling update starts. Once new machines are ready, old MachineSet can be scaled down further, followed by scaling up the new MachineSet, ensuring that the total number of machines available at all times during the update is at least 70% of desired machines.

.spec.strategy.type

string

Type of deployment. Currently the only supported strategy is “RollingUpdate”. Default is RollingUpdate.

.spec.template

object Required

Template describes the machines that will be created.

.spec.template.metadata

.spec.template.metadata.annotations

object

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

.spec.template.metadata.generateName

string

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. 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). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

.spec.template.metadata.labels

object

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

.spec.template.metadata.name

string

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

.spec.template.metadata.namespace

string

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. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces

.spec.template.metadata.ownerReferences

array

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.

.spec.template.metadata.ownerReferences[*]

object

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.

.spec.template.metadata.ownerReferences[*].apiVersion

string Required

API version of the referent.

.spec.template.metadata.ownerReferences[*].blockOwnerDeletion

boolean

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. Defaults to false. To set this field, a user needs “delete” permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

.spec.template.metadata.ownerReferences[*].controller

boolean

If true, this reference points to the managing controller.

.spec.template.metadata.ownerReferences[*].kind

.spec.template.metadata.ownerReferences[*].name

string Required

.spec.template.metadata.ownerReferences[*].uid

string Required

.spec.template.spec

object

.spec.template.spec.bootstrap

object Required

Bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism.

.spec.template.spec.bootstrap.configRef

object

ConfigRef is a reference to a bootstrap provider-specific resource that holds configuration details. The reference is optional to allow users/operators to specify Bootstrap.Data without the need of a controller.

.spec.template.spec.bootstrap.configRef.apiVersion

string

API version of the referent.

.spec.template.spec.bootstrap.configRef.fieldPath

string

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.

.spec.template.spec.bootstrap.configRef.kind

.spec.template.spec.bootstrap.configRef.name

.spec.template.spec.bootstrap.configRef.namespace

.spec.template.spec.bootstrap.configRef.resourceVersion

string

.spec.template.spec.bootstrap.configRef.uid

.spec.template.spec.bootstrap.data

string

Data contains the bootstrap data, such as cloud-init details scripts. If nil, the Machine should remain in the Pending state. Deprecated: This field has been deprecated in v1alpha3 and will be removed in a future version. Switch to DataSecretName.

.spec.template.spec.bootstrap.dataSecretName

string

DataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state.

.spec.template.spec.clusterName

string Required

ClusterName is the name of the Cluster this object belongs to.

.spec.template.spec.failureDomain

string

FailureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object.

.spec.template.spec.infrastructureRef

object Required

InfrastructureRef is a required reference to a custom resource offered by an infrastructure provider.

.spec.template.spec.infrastructureRef.apiVersion

string

API version of the referent.

.spec.template.spec.infrastructureRef.fieldPath

string

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.

.spec.template.spec.infrastructureRef.kind

.spec.template.spec.infrastructureRef.name

.spec.template.spec.infrastructureRef.namespace

.spec.template.spec.infrastructureRef.resourceVersion

string

.spec.template.spec.infrastructureRef.uid

.spec.template.spec.nodeDrainTimeout

string

NodeDrainTimeout is the total amount of time that the controller will spend on draining a node. The default value is 0, meaning that the node can be drained without any time limitations. NOTE: NodeDrainTimeout is different from kubectl drain --timeout

.spec.template.spec.providerID

string

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.

.spec.template.spec.version

string

Version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers.

.status

object

MachineDeploymentStatus defines the observed state of MachineDeployment

.status.availableReplicas

integer

Total number of available machines (ready for at least minReadySeconds) targeted by this deployment.

.status.observedGeneration

integer

The generation observed by the deployment controller.

.status.phase

string

Phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown).

.status.readyReplicas

integer

Total number of ready machines targeted by this deployment.

.status.replicas

integer

Total number of non-terminated machines targeted by this deployment (their labels match the selector).

.status.selector

string

Selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors

.status.unavailableReplicas

integer

Total number of unavailable machines targeted by this deployment. This is the total number of machines that are still required for the deployment to have 100% available capacity. They may either be machines that are running but not yet available or machines that still have not been created.

.status.updatedReplicas

integer

Total number of non-terminated machines targeted by this deployment that have the desired template spec.


This documentation page shows information based on apiextensions v3.2.0.