cluster.x-k8s.io / v1alpha4 / MachineDeployment
- string
.apiVersion
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
- string
.kind
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
- object
.metadata
- object
.spec
spec is the desired state of MachineDeployment.
- string required
.spec .clusterName
clusterName is the name of the Cluster this object belongs to.
- integer
.spec .minReadySeconds
minReadySeconds is the 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)
- boolean
.spec .paused
paused indicates that the deployment is paused.
- integer
.spec .progressDeadlineSeconds
progressDeadlineSeconds is 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.
- integer
.spec .replicas
replicas is the number of desired machines. Defaults to 1. This is a pointer to distinguish between explicit zero and not specified.
- integer
.spec .revisionHistoryLimit
revisionHistoryLimit is 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.
- object required
.spec .selector
selector is the 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.
- array
.spec .selector .matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
- string required
.spec .selector .matchExpressions[] .key
key is the label key that the selector applies to.
- string required
.spec .selector .matchExpressions[] .operator
operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
- array
.spec .selector .matchExpressions[] .values
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.
- object
.spec .selector .matchLabels
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.
- object
.spec .strategy
strategy is the deployment strategy to use to replace existing machines with new ones.
- object
.spec .strategy .rollingUpdate
rollingUpdate is the rolling update config params. Present only if MachineDeploymentStrategyType = RollingUpdate.
- string
.spec .strategy .rollingUpdate .deletePolicy
deletePolicy defines the policy used by the MachineDeployment to identify nodes to delete when downscaling. Valid values are “Random, “Newest”, “Oldest” When no value is supplied, the default DeletePolicy of MachineSet is used
- integer | string
.spec .strategy .rollingUpdate .maxSurge
maxSurge is 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.
- string
.spec .strategy .type
type of deployment. Default is RollingUpdate.
- object required
.spec .template
template describes the machines that will be created.
- object
.spec .template .metadata
metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- object
.spec .template .metadata .annotations
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
- object
.spec .template .metadata .labels
labels is a 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
- object
.spec .template .spec
spec is the specification of the desired behavior of the machine. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
- object required
.spec .template .spec .bootstrap
bootstrap is a reference to a local struct which encapsulates fields to configure the Machine’s bootstrapping mechanism.
- object
.spec .template .spec .bootstrap .configRef
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.DataSecretName without the need of a controller.
- string
.spec .template .spec .bootstrap .configRef .apiVersion
API version of the referent.
- string
.spec .template .spec .bootstrap .configRef .fieldPath
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.
- string
.spec .template .spec .bootstrap .configRef .kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- string
.spec .template .spec .bootstrap .configRef .name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .template .spec .bootstrap .configRef .namespace
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- string
.spec .template .spec .bootstrap .configRef .resourceVersion
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
- string
.spec .template .spec .bootstrap .configRef .uid
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- string
.spec .template .spec .bootstrap .dataSecretName
dataSecretName is the name of the secret that stores the bootstrap data script. If nil, the Machine should remain in the Pending state.
- string required
.spec .template .spec .clusterName
clusterName is the name of the Cluster this object belongs to.
- string
.spec .template .spec .failureDomain
failureDomain is the failure domain the machine will be created in. Must match a key in the FailureDomains map stored on the cluster object.
- object required
.spec .template .spec .infrastructureRef
infrastructureRef is a required reference to a custom resource offered by an infrastructure provider.
- string
.spec .template .spec .infrastructureRef .apiVersion
API version of the referent.
- string
.spec .template .spec .infrastructureRef .fieldPath
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.
- string
.spec .template .spec .infrastructureRef .kind
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
- string
.spec .template .spec .infrastructureRef .name
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
- string
.spec .template .spec .infrastructureRef .namespace
Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
- string
.spec .template .spec .infrastructureRef .resourceVersion
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
- string
.spec .template .spec .infrastructureRef .uid
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
- string
.spec .template .spec .nodeDrainTimeout
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 - string
.spec .template .spec .providerID
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.
- string
.spec .template .spec .version
version defines the desired Kubernetes version. This field is meant to be optionally used by bootstrap providers.
- object
.status
status is the observed state of MachineDeployment.
- integer
.status .availableReplicas
availableReplicas is the total number of available machines (ready for at least minReadySeconds) targeted by this deployment.
- array
.status .conditions
conditions defines current service state of the MachineDeployment.
- string
.status .conditions[] .lastTransitionTime
lastTransitionTime is the 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.
- string
.status .conditions[] .message
message is a human readable message indicating details about the transition. This field may be empty.
- string
.status .conditions[] .reason
reason is 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.
- string
.status .conditions[] .severity
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.
- string required
.status .conditions[] .status
status of the condition, one of True, False, Unknown.
- string required
.status .conditions[] .type
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.
- integer
.status .observedGeneration
observedGeneration is the generation observed by the deployment controller.
- string
.status .phase
phase represents the current phase of a MachineDeployment (ScalingUp, ScalingDown, Running, Failed, or Unknown).
- integer
.status .readyReplicas
readyReplicas is the total number of ready machines targeted by this deployment.
- integer
.status .replicas
replicas is the total number of non-terminated machines targeted by this deployment (their labels match the selector).
- string
.status .selector
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
- integer
.status .updatedReplicas
updatedReplicas is the total number of non-terminated machines targeted by this deployment that have the desired template spec.