Struct MachineDeploymentSpec

pub struct MachineDeploymentSpec {
    pub cluster_name: String,
    pub machine_naming_strategy: Option<MachineDeploymentMachineNamingStrategy>,
    pub min_ready_seconds: Option<i32>,
    pub paused: Option<bool>,
    pub progress_deadline_seconds: Option<i32>,
    pub replicas: Option<i32>,
    pub revision_history_limit: Option<i32>,
    pub rollout_after: Option<String>,
    pub selector: MachineDeploymentSelector,
    pub strategy: Option<MachineDeploymentStrategy>,
    pub template: MachineDeploymentTemplate,
}

spec is the desired state of MachineDeployment.

Fields

cluster_name: String

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

machine_naming_strategy: Option<MachineDeploymentMachineNamingStrategy>

machineNamingStrategy allows changing the naming pattern used when creating Machines. Note: InfraMachines & BootstrapConfigs will use the same name as the corresponding Machines.

min_ready_seconds: Option<i32>

minReadySeconds is the minimum number of seconds for which a Node for a newly created machine should be ready before considering the replica available. Defaults to 0 (machine will be considered available as soon as the Node is ready)

paused: Option<bool>

paused indicates that the deployment is paused.

progress_deadline_seconds: Option<i32>

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.

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/11470 for more details.

replicas: Option<i32>

replicas is the number of desired machines. This is a pointer to distinguish between explicit zero and not specified.

Defaults to:

• if the Kubernetes autoscaler min size and max size annotations are set:
  • if it’s a new MachineDeployment, use min size
  • if the replicas field of the old MachineDeployment is < min size, use min size
  • if the replicas field of the old MachineDeployment is > max size, use max size
  • if the replicas field of the old MachineDeployment is in the (min size, max size) range, keep the value from the oldMD
• otherwise use 1 Note: Defaulting will be run whenever the replicas field is not set:
• A new MachineDeployment is created with replicas not set.
• On an existing MachineDeployment the replicas field was first set and is now unset. Those cases are especially relevant for the following Kubernetes autoscaler use cases:
• A new MachineDeployment is created and replicas should be managed by the autoscaler
• An existing MachineDeployment which initially wasn’t controlled by the autoscaler should be later controlled by the autoscaler

revision_history_limit: Option<i32>

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.

Deprecated: This field is deprecated and is going to be removed in the next apiVersion. Please see https://github.com/kubernetes-sigs/cluster-api/issues/10479 for more details.

rollout_after: Option<String>

rolloutAfter is a field to indicate a rollout should be performed after the specified time even if no changes have been made to the MachineDeployment. Example: In the YAML the time can be specified in the RFC3339 format. To specify the rolloutAfter target as March 9, 2023, at 9 am UTC use “2023-03-09T09:00:00Z”.

selector: MachineDeploymentSelector

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.

strategy: Option<MachineDeploymentStrategy>

strategy is the deployment strategy to use to replace existing machines with new ones.

template: MachineDeploymentTemplate

template describes the machines that will be created.

Trait Implementations

impl Clone for MachineDeploymentSpec

fn clone(&self) -> MachineDeploymentSpec

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MachineDeploymentSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MachineDeploymentSpec

fn default() -> MachineDeploymentSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MachineDeploymentSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for MachineDeploymentSpec

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for MachineDeploymentSpec

fn eq(&self, other: &MachineDeploymentSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MachineDeploymentSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MachineDeploymentSpec