# Packages

Package index provides indexes for the api.

# Functions

No description provided by the author

# Constants

AutoscalerMaxSizeAnnotation defines the maximum node group size.
AutoscalerMinSizeAnnotation defines the minimum node group size.
AvailableUnknownV1Beta2Reason applies to a condition surfacing object availability unknown.
AvailableV1Beta2Condition reports if an object is available.
AvailableV1Beta2Reason applies to a condition surfacing object availability.
BootstrapConfigReadyV1Beta2Condition reports if an object's bootstrap config is ready.
BootstrapReadyCondition reports a summary of current status of the bootstrap object defined for this machine.
BootstrapTemplateCloningFailedReason (Severity=Error) documents a MachineSet failing to clone the bootstrap template.
ClusterAvailableInternalErrorV1Beta2Reason surfaces unexpected error when computing the Available condition.
ClusterAvailableUnknownV1Beta2Reason surfaces when at least one cluster availability criteria is unknown and no availability criteria is not met.
ClusterAvailableV1Beta2Condition is true if the Cluster is not deleted, and RemoteConnectionProbe, InfrastructureReady, ControlPlaneAvailable, WorkersAvailable, TopologyReconciled (if present) conditions are true.
ClusterAvailableV1Beta2Reason surfaces when the cluster availability criteria is met.
ClusterClassKind represents the Kind of ClusterClass.
ClusterClassOutdatedRefVersionsReason (Severity=Warning) that the references in the ClusterClass are not up-to-date (i.e.
ClusterClassRefVersionsNotUpToDateV1Beta2Reason surfaces that the references in the ClusterClass are not up-to-date (i.e.
ClusterClassRefVersionsUpToDateCondition documents if the references in the ClusterClass are up-to-date (i.e.
ClusterClassRefVersionsUpToDateInternalErrorReason (Severity=Warning) surfaces that an unexpected error occurred when validating if the references are up-to-date.
ClusterClassRefVersionsUpToDateInternalErrorV1Beta2Reason surfaces that an unexpected error occurred when validating if the references are up-to-date.
ClusterClassRefVersionsUpToDateV1Beta2Condition documents if the references in the ClusterClass are up-to-date (i.e.
ClusterClassRefVersionsUpToDateV1Beta2Reason surfaces that the references in the ClusterClass are up-to-date (i.e.
ClusterClassVariablesReadyV1Beta2Condition is true if the ClusterClass variables, including both inline and external variables, have been successfully reconciled and thus ready to be used to default and validate variables on Clusters using this ClusterClass.
ClusterClassVariablesReadyV1Beta2Reason surfaces that the variables are ready.
ClusterClassVariablesReadyVariableDiscoveryFailedV1Beta2Reason surfaces that variable discovery failed.
ClusterClassVariablesReconciledCondition reports if the ClusterClass variables, including both inline and external variables, have been successfully reconciled.
ClusterControlPlaneAvailableV1Beta2Condition is a mirror of Cluster's control plane Available condition.
ClusterControlPlaneAvailableV1Beta2Reason surfaces when the cluster control plane is available.
ClusterControlPlaneDeletedV1Beta2Reason surfaces when a referenced control plane object has been deleted.
ClusterControlPlaneDoesNotExistV1Beta2Reason surfaces when a referenced control plane object does not exist.
ClusterControlPlaneInitializedInternalErrorV1Beta2Reason surfaces unexpected failures when computing the ControlPlaneInitialized condition.
ClusterControlPlaneInitializedV1Beta2Condition is true when the Cluster's control plane is functional enough to accept requests.
ClusterControlPlaneInitializedV1Beta2Reason surfaces when the cluster control plane is initialized.
ClusterControlPlaneInternalErrorV1Beta2Reason surfaces unexpected failures when reading a control plane object.
ClusterControlPlaneInvalidConditionReportedV1Beta2Reason surfaces a control plane Available condition (read from a control plane object) which is invalid.
ClusterControlPlaneMachinesNotReadyV1Beta2Reason surfaces when at least one of control plane machine's Ready conditions is false.
ClusterControlPlaneMachinesNotUpToDateV1Beta2Reason surfaces when at least one of the control plane machine's UpToDate conditions is false.
ClusterControlPlaneMachinesReadyInternalErrorV1Beta2Reason surfaces unexpected failures when listing control plane machines or aggregating control plane machine's conditions.
ClusterControlPlaneMachinesReadyNoReplicasV1Beta2Reason surfaces when no control plane machines exist for the Cluster.
ClusterControlPlaneMachinesReadyUnknownV1Beta2Reason surfaces when at least one of control plane machine's Ready conditions is unknown and none of control plane machine's Ready conditions is false.
ClusterControlPlaneMachinesReadyV1Beta2Condition surfaces detail of issues on control plane machines, if any.
ClusterControlPlaneMachinesReadyV1Beta2Reason surfaces when all control plane machine's Ready conditions are true.
ClusterControlPlaneMachinesUpToDateInternalErrorV1Beta2Reason surfaces unexpected failures when listing control plane machines or aggregating status.
ClusterControlPlaneMachinesUpToDateNoReplicasV1Beta2Reason surfaces when no control plane machines exist for the Cluster.
ClusterControlPlaneMachinesUpToDateUnknownV1Beta2Reason surfaces when at least one of the control plane machine's UpToDate conditions is unknown and none of the control plane machine's UpToDate conditions is false.
ClusterControlPlaneMachinesUpToDateV1Beta2Condition surfaces details of control plane machines not up to date, if any.
ClusterControlPlaneMachinesUpToDateV1Beta2Reason surfaces when all the control plane machine's UpToDate conditions are true.
ClusterControlPlaneNotAvailableV1Beta2Reason surfaces when the cluster control plane is not available.
ClusterControlPlaneNotInitializedV1Beta2Reason surfaces when the cluster control plane is not yet initialized.
ClusterDeletingDeletionCompletedV1Beta2Reason surfaces when the Cluster deletion has been completed.
ClusterDeletingInternalErrorV1Beta2Reason surfaces unexpected failures when deleting a cluster.
ClusterDeletingV1Beta2Condition surfaces details about ongoing deletion of the cluster.
ClusterDeletingWaitingForBeforeDeleteHookV1Beta2Reason surfaces when the Cluster deletion waits for the ClusterDelete hooks to allow deletion to complete.
ClusterDeletingWaitingForControlPlaneDeletionV1Beta2Reason surfaces when the Cluster deletion waits for the ControlPlane to be deleted.
ClusterDeletingWaitingForInfrastructureDeletionV1Beta2Reason surfaces when the Cluster deletion waits for the InfraCluster to be deleted.
ClusterDeletingWaitingForWorkersDeletionV1Beta2Reason surfaces when the Cluster deletion waits for the workers Machines and the object controlling those machines (MachinePools, MachineDeployments, MachineSets) to be deleted.
ClusterFinalizer is the finalizer used by the cluster controller to cleanup the cluster resources when a Cluster is being deleted.
ClusterInfrastructureDeletedV1Beta2Reason surfaces when a referenced infrastructure object has been deleted.
ClusterInfrastructureDoesNotExistV1Beta2Reason surfaces when a referenced infrastructure object does not exist.
ClusterInfrastructureInternalErrorV1Beta2Reason surfaces unexpected failures when reading an infra cluster object.
ClusterInfrastructureInvalidConditionReportedV1Beta2Reason surfaces a infrastructure Ready condition (read from an infra cluster object) which is invalid (e.g.
ClusterInfrastructureNotReadyV1Beta2Reason surfaces when the cluster infrastructure is not ready.
ClusterInfrastructureReadyV1Beta2Condition mirrors Cluster's infrastructure Ready condition.
ClusterInfrastructureReadyV1Beta2Reason surfaces when the cluster infrastructure is ready.
ClusterKind represents the Kind of Cluster.
ClusterNameAnnotation is the annotation set on nodes identifying the name of the cluster the node belongs to.
ClusterNameLabel is the label set on machines linked to a cluster and external objects(bootstrap and infrastructure providers).
ClusterNamespaceAnnotation is the annotation set on nodes identifying the namespace of the cluster the node belongs to.
ClusterNotAvailableV1Beta2Reason surfaces when the cluster availability criteria is not met (and thus the machine is not available).
ClusterNotDeletingV1Beta2Reason surfaces when the Cluster is not deleting because the DeletionTimestamp is not set.
ClusterNotRemediatingV1Beta2Reason surfaces when the Cluster does not have any machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false.
ClusterNotRollingOutV1Beta2Reason surfaces when none of the Cluster's control plane, MachineDeployments, or MachinePools are rolling out.
ClusterNotScalingDownV1Beta2Reason surfaces when none of the Cluster's control plane, MachineDeployments, MachinePools and stand-alone MachineSets are scaling down.
ClusterNotScalingUpV1Beta2Reason surfaces when none of the Cluster's control plane, MachineDeployments, MachinePools and stand-alone MachineSets are scaling up.
ClusterPhaseDeleting is the Cluster state when a delete request has been sent to the API Server, but its infrastructure has not yet been fully deleted.
ClusterPhaseFailed is the Cluster state when the system might require user intervention.
ClusterPhasePending is the first state a Cluster is assigned by Cluster API Cluster controller after being created.
ClusterPhaseProvisioned is the state when its control plane endpoint has been created and configured and the infrastructure object is ready (if defined).
ClusterPhaseProvisioning is the state when the Cluster has a infrastructure object or a control plane object that can start provisioning the control plane endpoint.
ClusterPhaseUnknown is returned if the Cluster state cannot be determined.
ClusterRemediatingInternalErrorV1Beta2Reason surfaces unexpected failures when computing the Remediating condition.
ClusterRemediatingV1Beta2Condition surfaces details about ongoing remediation of the controlled machines, if any.
ClusterRemediatingV1Beta2Reason surfaces when the Cluster has at least one machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false.
ClusterRemoteConnectionProbeFailedV1Beta2Reason surfaces issues with the connection to the workload cluster.
ClusterRemoteConnectionProbeSucceededV1Beta2Reason is used to report a working connection with the workload cluster.
ClusterRemoteConnectionProbeV1Beta2Condition is true when control plane can be reached; in case of connection problems.
ClusterRollingOutInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or computing the RollingOut condition.
ClusterRollingOutUnknownV1Beta2Reason surfaces when one of the Cluster's control plane, MachineDeployments, or MachinePools rolling out condition is unknown, and none true.
ClusterRollingOutV1Beta2Condition is the summary of `RollingOut` conditions from ControlPlane, MachineDeployments and MachinePools.
ClusterRollingOutV1Beta2Reason surfaces when at least one of the Cluster's control plane, MachineDeployments, or MachinePools are rolling out.
ClusterScalingDownInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or computing the ScalingDown condition.
ClusterScalingDownUnknownV1Beta2Reason surfaces when one of the Cluster's control plane, MachineDeployments, MachinePools and stand-alone MachineSets scaling down condition is unknown, and none true.
ClusterScalingDownV1Beta2Condition is the summary of `ScalingDown` conditions from ControlPlane, MachineDeployments, MachinePools and stand-alone MachineSets.
ClusterScalingDownV1Beta2Reason surfaces when at least one of the Cluster's control plane, MachineDeployments, MachinePools and stand-alone MachineSets are scaling down.
ClusterScalingUpInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or computing the ScalingUp condition.
ClusterScalingUpUnknownV1Beta2Reason surfaces when one of the Cluster's control plane, MachineDeployments, MachinePools and stand-alone MachineSets scaling up condition is unknown, and none true.
ClusterScalingUpV1Beta2Condition is the summary of `ScalingUp` conditions from ControlPlane, MachineDeployments, MachinePools and stand-alone MachineSets.
ClusterScalingUpV1Beta2Reason surfaces when at least one of the Cluster's control plane, MachineDeployments, MachinePools and stand-alone MachineSets are scaling up.
nolint:gosec.
ClusterTopologyDeferUpgradeAnnotation can be used to defer the Kubernetes upgrade of a single MachineDeployment topology.
ClusterTopologyHoldUpgradeSequenceAnnotation can be used to hold the entire MachineDeployment upgrade sequence.
ClusterTopologyMachineDeploymentNameLabel is the label set on the generated MachineDeployment objects to track the name of the MachineDeployment topology it represents.
ClusterTopologyMachinePoolNameLabel is the label set on the generated MachinePool objects to track the name of the MachinePool topology it represents.
ClusterTopologyOwnedLabel is the label set on all the object which are managed as part of a ClusterTopology.
ClusterTopologyReconciledClusterClassNotReconciledV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because the ClusterClass has not reconciled yet.
ClusterTopologyReconciledControlPlaneUpgradePendingV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because Control Plane is not yet updated to match the desired topology spec.
ClusterTopologyReconciledDeletingV1Beta2Reason surfaces when the Cluster is deleting because the DeletionTimestamp is set.
ClusterTopologyReconciledFailedV1Beta2Reason documents the reconciliation of a Cluster topology failing due to an error.
ClusterTopologyReconciledHookBlockingV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because at least one of the lifecycle hooks is blocking.
ClusterTopologyReconciledMachineDeploymentsCreatePendingV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because at least one of the MachineDeployments is yet to be created.
ClusterTopologyReconciledMachineDeploymentsUpgradeDeferredV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because the upgrade for at least one of the MachineDeployments has been deferred.
ClusterTopologyReconciledMachineDeploymentsUpgradePendingV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because at least one of the MachineDeployments is not yet updated to match the desired topology spec.
ClusterTopologyReconciledMachinePoolsCreatePendingV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because at least one of the MachinePools is yet to be created.
ClusterTopologyReconciledMachinePoolsUpgradeDeferredV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because the upgrade for at least one of the MachinePools has been deferred.
ClusterTopologyReconciledMachinePoolsUpgradePendingV1Beta2Reason documents reconciliation of a Cluster topology not yet completed because at least one of the MachinePools is not yet updated to match the desired topology spec.
ClusterTopologyReconciledV1Beta2Condition is true if the topology controller is working properly.
ClusterTopologyReconcilePausedV1Beta2Reason surfaces when the Cluster is paused.
ClusterTopologyReconcileSucceededV1Beta2Reason documents the reconciliation of a Cluster topology succeeded.
ClusterTopologyUnsafeUpdateClassNameAnnotation can be used to disable the webhook check on update that disallows a pre-existing Cluster to be populated with Topology information and Class.
ClusterTopologyUnsafeUpdateVersionAnnotation can be used to disable the webhook checks on update that disallows updating the .topology.spec.version on certain conditions.
ClusterTopologyUpgradeConcurrencyAnnotation can be set as top-level annotation on the Cluster object of a classy Cluster to define the maximum concurrency while upgrading MachineDeployments.
ClusterWorkerMachinesNotReadyV1Beta2Reason surfaces when at least one of the worker machine's Ready conditions is false.
ClusterWorkerMachinesNotUpToDateV1Beta2Reason surfaces when at least one of the worker machine's UpToDate conditions is false.
ClusterWorkerMachinesReadyInternalErrorV1Beta2Reason surfaces unexpected failures when listing worker machines or aggregating worker machine's conditions.
ClusterWorkerMachinesReadyNoReplicasV1Beta2Reason surfaces when no worker machines exist for the Cluster.
ClusterWorkerMachinesReadyUnknownV1Beta2Reason surfaces when at least one of the worker machine's Ready conditions is unknown and none of the worker machine's Ready conditions is false.
ClusterWorkerMachinesReadyV1Beta2Condition surfaces detail of issues on the worker machines, if any.
ClusterWorkerMachinesReadyV1Beta2Reason surfaces when all the worker machine's Ready conditions are true.
ClusterWorkerMachinesUpToDateInternalErrorV1Beta2Reason surfaces unexpected failures when listing worker machines or aggregating status.
ClusterWorkerMachinesUpToDateNoReplicasV1Beta2Reason surfaces when no worker machines exist for the Cluster.
ClusterWorkerMachinesUpToDateUnknownV1Beta2Reason surfaces when at least one of the worker machine's UpToDate conditions is unknown and none of the worker machine's UpToDate conditions is false.
ClusterWorkerMachinesUpToDateV1Beta2Condition surfaces details of worker machines not up to date, if any.
ClusterWorkerMachinesUpToDateV1Beta2Reason surfaces when all the worker machine's UpToDate conditions are true.
ClusterWorkersAvailableInternalErrorV1Beta2Reason surfaces unexpected failures when listing MachineDeployment and MachinePool or aggregating conditions from those objects.
ClusterWorkersAvailableNoWorkersV1Beta2Reason surfaces when no MachineDeployment and MachinePool exist for the Cluster.
ClusterWorkersAvailableUnknownV1Beta2Reason surfaces when at least one of the MachineDeployment and MachinePool's Available conditions is unknown and none of those Available conditions is false.
ClusterWorkersAvailableV1Beta2Condition is the summary of MachineDeployment and MachinePool's Available conditions.
ClusterWorkersAvailableV1Beta2Reason surfaces when all MachineDeployment and MachinePool's Available conditions are true.
ClusterWorkersNotAvailableV1Beta2Reason surfaces when at least one of the MachineDeployment and MachinePool's Available conditions is false.
ConditionSeverityError specifies that a condition with `Status=False` is an error.
ConditionSeverityInfo specifies that a condition with `Status=False` is informative.
ConditionSeverityNone should apply only to conditions with `Status=True`.
ConditionSeverityWarning specifies that a condition with `Status=False` is a warning.
ConnectionDownV1Beta2Reason surfaces that the connection to the workload cluster is down.
ControlPlaneInitializedCondition reports if the cluster's control plane has been initialized such that the cluster's apiserver is reachable.
ControlPlaneReadyCondition reports the ready condition from the control plane object defined for this cluster.
DeletedReason (Severity=Info) documents a condition not in Status=True because the underlying object was deleted.
DeleteMachineAnnotation marks control plane and worker nodes that will be given priority for deletion when KCP or a machineset scales down.
DeletingReason (Severity=Info) documents a condition not in Status=True because the underlying object it is currently being deleted.
DeletingV1Beta2Condition surfaces details about progress of the object deletion workflow.
DeletingV1Beta2Reason surfaces when an object is deleting because the DeletionTimestamp is set.
DeletionCompletedV1Beta2Reason surfaces when the deletion process has been completed.
DeletionFailedReason (Severity=Warning) documents a condition not in Status=True because the underlying object encountered problems during deletion.
DesiredReplicasAnnotation is the desired replicas for a machine deployment recorded as an annotation in its machine sets.
DisableMachineCreateAnnotation is an annotation that can be used to signal a MachineSet to stop creating new machines.
DrainingFailedReason (Severity=Warning) documents a machine node drain operation failed.
DrainingReason (Severity=Info) documents a machine node being drained.
DrainingSucceededCondition provide evidence of the status of the node drain operation which happens during the machine deletion process.
Define the ClusterIPFamily constants.
ExcludeNodeDrainingAnnotation annotation explicitly skips node draining if set.
ExcludeWaitForNodeVolumeDetachAnnotation annotation explicitly skips the waiting for node volume detaching if set.
ExternalRemediationRequestAvailableCondition is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
ExternalRemediationRequestCreationFailedReason is the reason used when a machine health check fails to create external remediation request.
ExternalRemediationTemplateAvailableCondition is set on machinehealthchecks when MachineHealthCheck controller uses external remediation.
ExternalRemediationTemplateNotFoundReason is the reason used when a machine health check fails to find external remediation template.
FieldValueDuplicate is used to report collisions of values that must be unique (e.g.
FieldValueForbidden is used to report valid (as per formatting rules) values which would be accepted under some conditions, but which are not permitted by the current conditions (such as security policy).
FieldValueInvalid is used to report malformed values (e.g.
FieldValueRequired is used to report required values that are not provided (e.g.
HasRemediateMachineAnnotationReason is the reason that get's set at the MachineHealthCheckSucceededCondition when a machine has the RemediateMachineAnnotation set.
IncorrectExternalRefReason (Severity=Error) documents a CAPI object with an incorrect external object reference.
InfrastructureReadyCondition reports a summary of current status of the infrastructure object defined for this cluster/machine/machinepool.
InfrastructureReadyV1Beta2Condition reports if an object's infrastructure is ready.
InfrastructureTemplateCloningFailedReason (Severity=Error) documents a MachineSet failing to clone the infrastructure template.
InspectionFailedV1Beta2Reason applies to a condition when inspection of the underlying object failed.
InternalErrorV1Beta2Reason surfaces unexpected errors reporting by controllers.
InterruptibleLabel is the label used to mark the nodes that run on interruptible instances.
InvalidConditionReportedV1Beta2Reason applies to a condition, usually read from an external object, that is invalid (e.g.
Define the ClusterIPFamily constants.
Define the ClusterIPFamily constants.
Define the ClusterIPFamily constants.
LabelsFromMachineAnnotation is the annotation set on nodes to track the labels originated from machines.
MachineAnnotation is the annotation set on nodes identifying the machine the node belongs to.
MachineAvailableInternalErrorV1Beta2Reason surfaces unexpected error when computing the Available condition.
MachineAvailableV1Beta2Condition is true if the machine is Ready for at least MinReadySeconds, as defined by the Machine's MinReadySeconds field.
MachineAvailableV1Beta2Reason surfaces when a machine is ready for at least MinReadySeconds.
MachineBootstrapConfigDeletedV1Beta2Reason surfaces when a referenced bootstrap config object has been deleted.
MachineBootstrapConfigDoesNotExistV1Beta2Reason surfaces when a referenced bootstrap config object does not exist.
MachineBootstrapConfigInternalErrorV1Beta2Reason surfaces unexpected failures when reading a BootstrapConfig object.
MachineBootstrapConfigInvalidConditionReportedV1Beta2Reason surfaces a BootstrapConfig Ready condition (read from a bootstrap config object) which is invalid.
MachineBootstrapConfigNotReadyV1Beta2Reason surfaces when the machine bootstrap config is not ready.
MachineBootstrapConfigReadyV1Beta2Condition condition mirrors the corresponding Ready condition from the Machine's BootstrapConfig resource.
MachineBootstrapConfigReadyV1Beta2Reason surfaces when the machine bootstrap config is ready.
MachineBootstrapDataSecretProvidedV1Beta2Reason surfaces when a bootstrap data secret is provided (not originated from a BoostrapConfig object referenced from the machine).
MachineCertificatesExpiryDateAnnotation annotation specifies the expiry date of the machine certificates in RFC3339 format.
MachineControlPlaneLabel is the label set on machines or related objects that are part of a control plane.
MachineControlPlaneNameLabel is the label set on machines if they're controlled by a ControlPlane.
MachineCreationFailedReason (Severity=Error) documents a MachineSet failing to generate a machine object.
MachineDeletingDeletingNodeV1Beta2Reason surfaces when the Machine deletion is deleting the Node.
MachineDeletingDeletionCompletedV1Beta2Reason surfaces when the Machine deletion has been completed.
MachineDeletingDrainingNodeV1Beta2Reason surfaces when the Machine deletion is draining the Node.
MachineDeletingInternalErrorV1Beta2Reason surfaces unexpected failures when deleting a Machine.
MachineDeletingV1Beta2Condition surfaces details about progress in the machine deletion workflow.
MachineDeletingV1Beta2Reason surfaces when the Machine is deleting because the DeletionTimestamp is set.
MachineDeletingWaitingForBootstrapDeletionV1Beta2Reason surfaces when the Machine deletion waits for BootstrapConfig deletion to complete.
MachineDeletingWaitingForInfrastructureDeletionV1Beta2Reason surfaces when the Machine deletion waits for InfraMachine deletion to complete.
MachineDeletingWaitingForPreDrainHookV1Beta2Reason surfaces when the Machine deletion waits for pre-drain hooks to complete.
MachineDeletingWaitingForPreTerminateHookV1Beta2Reason surfaces when the Machine deletion waits for pre-terminate hooks to complete.
MachineDeletingWaitingForVolumeDetachV1Beta2Reason surfaces when the Machine deletion is waiting for volumes to detach from the Node.
MachineDeploymentAvailableCondition means the MachineDeployment is available, that is, at least the minimum available machines required (i.e.
MachineDeploymentAvailableInternalErrorV1Beta2Reason surfaces unexpected failures when computing the Available condition.
MachineDeploymentAvailableV1Beta2Condition is true if the MachineDeployment is not deleted, and it has minimum availability according to parameters specified in the deployment strategy, e.g.
MachineDeploymentAvailableV1Beta2Reason surfaces when a Deployment is available.
MachineDeploymentAvailableWaitingForAvailableReplicasSetV1Beta2Reason surfaces when the .status.v1beta2.availableReplicas field of the MachineDeployment is not set.
MachineDeploymentAvailableWaitingForReplicasSetV1Beta2Reason surfaces when the .spec.replicas field of the MachineDeployment is not set.
MachineDeploymentDeletingInternalErrorV1Beta2Reason surfaces unexpected failures when deleting a MachineDeployment.
MachineDeploymentDeletingV1Beta2Condition surfaces details about ongoing deletion of the controlled machines.
MachineDeploymentDeletingV1Beta2Reason surfaces when the MachineDeployment is deleting because the DeletionTimestamp is set.
MachineDeploymentFinalizer is the finalizer used by the MachineDeployment controller to ensure ordered cleanup of corresponding MachineSets when a MachineDeployment is being deleted.
MachineDeploymentMachinesNotReadyV1Beta2Reason surfaces when at least one of the controlled machine's Ready conditions is false.
MachineDeploymentMachinesNotUpToDateV1Beta2Reason surfaces when at least one of the controlled machine's UpToDate conditions is false.
MachineDeploymentMachinesReadyInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or aggregating machine's conditions.
MachineDeploymentMachinesReadyNoReplicasV1Beta2Reason surfaces when no machines exist for the MachineDeployment.
MachineDeploymentMachinesReadyUnknownV1Beta2Reason surfaces when at least one of the controlled machine's Ready conditions is unknown and none of the controlled machine's Ready conditions is false.
MachineDeploymentMachinesReadyV1Beta2Condition surfaces detail of issues on the controlled machines, if any.
MachineDeploymentMachinesReadyV1Beta2Reason surfaces when all the controlled machine's Ready conditions are true.
MachineDeploymentMachinesUpToDateInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or aggregating status.
MachineDeploymentMachinesUpToDateNoReplicasV1Beta2Reason surfaces when no machines exist for the MachineDeployment.
MachineDeploymentMachinesUpToDateUnknownV1Beta2Reason surfaces when at least one of the controlled machine's UpToDate conditions is unknown and none of the controlled machine's UpToDate conditions is false.
MachineDeploymentMachinesUpToDateV1Beta2Condition surfaces details of controlled machines not up to date, if any.
MachineDeploymentMachinesUpToDateV1Beta2Reason surfaces when all the controlled machine's UpToDate conditions are true.
MachineDeploymentNameLabel is the label set on machines if they're controlled by MachineDeployment.
MachineDeploymentNotAvailableV1Beta2Reason surfaces when a Deployment is not available.
MachineDeploymentNotDeletingV1Beta2Reason surfaces when the MachineDeployment is not deleting because the DeletionTimestamp is not set.
MachineDeploymentNotRemediatingV1Beta2Reason surfaces when the MachineDeployment does not have any machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false.
MachineDeploymentNotRollingOutV1Beta2Reason surfaces when all the machines are up-to-date.
MachineDeploymentNotScalingDownV1Beta2Reason surfaces when actual replicas <= desired replicas.
MachineDeploymentNotScalingUpV1Beta2Reason surfaces when actual replicas >= desired replicas.
MachineDeploymentPhaseFailed indicates there was a problem scaling and user intervention might be required.
MachineDeploymentPhaseRunning indicates scaling has completed and all Machines are running.
MachineDeploymentPhaseScalingDown indicates the MachineDeployment is scaling down.
MachineDeploymentPhaseScalingUp indicates the MachineDeployment is scaling up.
MachineDeploymentPhaseUnknown indicates the state of the MachineDeployment cannot be determined.
MachineDeploymentRemediatingInternalErrorV1Beta2Reason surfaces unexpected failures when computing the Remediating condition.
MachineDeploymentRemediatingV1Beta2Condition surfaces details about ongoing remediation of the controlled machines, if any.
MachineDeploymentRemediatingV1Beta2Reason surfaces when the MachineDeployment has at least one machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false.
MachineDeploymentRollingOutInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines.
MachineDeploymentRollingOutV1Beta2Condition is true if there is at least one machine not up-to-date.
MachineDeploymentRollingOutV1Beta2Reason surfaces when there is at least one machine not up-to-date.
MachineDeploymentScalingDownInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines.
MachineDeploymentScalingDownV1Beta2Condition is true if actual replicas > desired replicas.
MachineDeploymentScalingDownV1Beta2Reason surfaces when actual replicas > desired replicas.
MachineDeploymentScalingDownWaitingForReplicasSetV1Beta2Reason surfaces when the .spec.replicas field of the MachineDeployment is not set.
MachineDeploymentScalingUpInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines.
MachineDeploymentScalingUpV1Beta2Condition is true if actual replicas < desired replicas.
MachineDeploymentScalingUpV1Beta2Reason surfaces when actual replicas < desired replicas.
MachineDeploymentScalingUpWaitingForReplicasSetV1Beta2Reason surfaces when the .spec.replicas field of the MachineDeployment is not set.
MachineDeploymentTopologyFinalizer is the finalizer used by the topology MachineDeployment controller to clean up referenced template resources if necessary when a MachineDeployment is being deleted.
MachineDeploymentUniqueLabel is used to uniquely identify the Machines of a MachineSet.
MachineDrainRuleDrainBehaviorDrain means a Pod should be drained.
MachineDrainRuleDrainBehaviorSkip means the drain for a Pod should be skipped.
MachineDrainRuleDrainBehaviorWaitCompleted means the Pod should not be evicted, but overall drain should wait until the Pod completes.
Define the MachineAddressType constants.
Define the MachineAddressType constants.
MachineExternallyRemediatedRemediationRequestCreationFailedV1Beta2Reason surfaces that the MachineHealthCheck cannot create a request for the external remediation controller.
MachineExternallyRemediatedRemediationTemplateNotFoundV1Beta2Reason surfaces that the MachineHealthCheck cannot find the template for an external remediation request.
MachineExternallyRemediatedV1Beta2Condition is only present if MHC instances targeting this machine determine that an external controller should perform remediation.
MachineExternallyRemediatedWaitingForRemediationV1Beta2Reason surfaces the machine is waiting for the external remediation controller to start remediation.
MachineFinalizer is set on PrepareForCreate callback.
MachineHasFailureReason is the reason used when a machine has either a FailureReason or a FailureMessage set on its status.
MachineHealthCheckHasRemediateAnnotationV1Beta2Reason surfaces when a MachineHealthCheck detects that a Machine was marked for remediation via the `cluster.x-k8s.io/remediate-machine` annotation.
MachineHealthCheckNodeDeletedV1Beta2Reason surfaces when a MachineHealthCheck detects that the node hosted on the machine has been deleted while the Machine is still running.
MachineHealthCheckNodeStartupTimeoutV1Beta2Reason surfaces when the node hosted on the machine does not appear within the timeout defined by a MachineHealthCheck object.
MachineHealthCheckRemediationAllowedV1Beta2Condition surfaces whether the MachineHealthCheck is allowed to remediate any Machines or whether it is blocked from remediating any further.
MachineHealthCheckRemediationAllowedV1Beta2Reason is the reason used when the number of unhealthy machine is within the limits defined by the MachineHealthCheck, and thus remediation is allowed.
MachineHealthCheckSucceededCondition is set on machines that have passed a healthcheck by the MachineHealthCheck controller.
MachineHealthCheckSucceededV1Beta2Condition is true if MHC instances targeting this machine report the Machine is healthy according to the definition of healthy present in the spec of the MachineHealthCheck object.
MachineHealthCheckSucceededV1Beta2Reason surfaces when a machine passes all the health checks defined by a MachineHealthCheck object.
MachineHealthCheckTooManyUnhealthyV1Beta2Reason is the reason used when too many Machines are unhealthy and the MachineHealthCheck is blocked from making any further remediation.
MachineHealthCheckUnhealthyNodeV1Beta2Reason surfaces when the node hosted on the machine does not pass the health checks defined by a MachineHealthCheck object.
Define the MachineAddressType constants.
MachineInfrastructureDeletedV1Beta2Reason surfaces when a referenced infrastructure object has been deleted.
MachineInfrastructureDoesNotExistV1Beta2Reason surfaces when a referenced infrastructure object does not exist.
MachineInfrastructureInternalErrorV1Beta2Reason surfaces unexpected failures when reading an infra machine object.
MachineInfrastructureInvalidConditionReportedV1Beta2Reason surfaces a infrastructure Ready condition (read from an infra machine object) which is invalid.
MachineInfrastructureNotReadyV1Beta2Reason surfaces when the machine infrastructure is not ready.
MachineInfrastructureReadyV1Beta2Condition mirrors the corresponding Ready condition from the Machine's infrastructure resource.
MachineInfrastructureReadyV1Beta2Reason surfaces when the machine infrastructure is ready.
Define the MachineAddressType constants.
Define the MachineAddressType constants.
MachineNodeConnectionDownV1Beta2Reason surfaces that the connection to the workload cluster is down.
MachineNodeDeletedV1Beta2Reason surfaces when the node hosted on the machine has been deleted.
MachineNodeDoesNotExistV1Beta2Reason surfaces when the node hosted on the machine does not exist.
MachineNodeHealthUnknownV1Beta2Reason surfaces when at least one node conditions report healthy state unknown and no node conditions report not healthy state.
MachineNodeHealthyCondition provides info about the operational state of the Kubernetes node hosted on the machine by summarizing node conditions.
MachineNodeHealthyV1Beta2Condition is true if the Machine's Node is ready and it does not report MemoryPressure, DiskPressure and PIDPressure.
MachineNodeHealthyV1Beta2Reason surfaces when all the node conditions report healthy state.
MachineNodeInspectionFailedV1Beta2Reason documents a failure when inspecting the status of a Node.
MachineNodeInternalErrorV1Beta2Reason surfaces unexpected failures when reading a Node object.
MachineNodeNotHealthyV1Beta2Reason surfaces when at least one node conditions report not healthy state.
MachineNodeNotReadyV1Beta2Reason surfaces when Machine's Node Ready condition is false.
MachineNodeReadyUnknownV1Beta2Reason surfaces when Machine's Node Ready condition is unknown.
MachineNodeReadyV1Beta2Condition is true if the Machine's Node is ready.
MachineNodeReadyV1Beta2Reason surfaces when Machine's Node Ready condition is true.
MachineNotDeletingV1Beta2Reason surfaces when the Machine is not deleting because the DeletionTimestamp is not set.
MachineNotReadyV1Beta2Reason surfaces when the machine readiness criteria is not met.
MachineNotUpToDateV1Beta2Reason surface when a Machine spec does not match the spec of the Machine's owner resource, e.g.
MachineOwnerRemediatedCondition is set on machines that have failed a healthcheck by the MachineHealthCheck controller.
MachineOwnerRemediatedV1Beta2Condition is only present if MHC instances targeting this machine determine that the controller owning this machine should perform remediation.
MachineOwnerRemediatedWaitingForRemediationV1Beta2Reason surfaces the machine is waiting for the owner controller to start remediation.
MachinePhaseDeleted is the Machine state when the object and the related infrastructure is deleted and ready to be garbage collected by the API Server.
MachinePhaseDeleting is the Machine state when a delete request has been sent to the API Server, but its infrastructure has not yet been fully deleted.
MachinePhaseFailed is the Machine state when the system might require user intervention.
MachinePhasePending is the first state a Machine is assigned by Cluster API Machine controller after being created.
MachinePhaseProvisioned is the state when its infrastructure has been created and configured.
MachinePhaseProvisioning is the state when the Machine infrastructure is being created.
MachinePhaseRunning is the Machine state when it has become a Kubernetes Node in a Ready state.
MachinePhaseUnknown is returned if the Machine state cannot be determined.
MachinePoolNameLabel is the label indicating the name of the MachinePool a Machine is controlled by.
MachineReadyInternalErrorV1Beta2Reason surfaces unexpected error when computing the Ready condition.
MachineReadyUnknownV1Beta2Reason surfaces when at least one machine readiness criteria is unknown and no machine readiness criteria is not met.
MachineReadyV1Beta2Condition is true if the Machine's deletionTimestamp is not set, Machine's BootstrapConfigReady, InfrastructureReady, NodeHealthy and HealthCheckSucceeded (if present) conditions are true; if other conditions are defined in spec.readinessGates, these conditions must be true as well.
MachineReadyV1Beta2Reason surfaces when the machine readiness criteria is met.
MachinesCreatedCondition documents that the machines controlled by the MachineSet are created.
MachineSetDeletingInternalErrorV1Beta2Reason surfaces unexpected failures when deleting a MachineSet.
MachineSetDeletingV1Beta2Condition surfaces details about ongoing deletion of the controlled machines.
MachineSetDeletingV1Beta2Reason surfaces when the MachineSet is deleting because the DeletionTimestamp is set.
MachineSetFinalizer is the finalizer used by the MachineSet controller to ensure ordered cleanup of corresponding Machines when a Machineset is being deleted.
MachineSetMachineCannotBeRemediatedV1Beta2Reason surfaces when remediation of a MachineSet machine can't be started.
MachineSetMachineRemediationDeferredV1Beta2Reason surfaces when remediation of a MachineSet machine must be deferred.
MachineSetMachineRemediationMachineDeletingV1Beta2Reason surfaces when remediation of a MachineSet machine has been completed by deleting the unhealthy machine.
MachineSetMachinesNotReadyV1Beta2Reason surfaces when at least one of the controlled machine's Ready conditions is false.
MachineSetMachinesNotUpToDateV1Beta2Reason surfaces when at least one of the controlled machine's UpToDate conditions is false.
MachineSetMachinesReadyInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or aggregating machine's conditions.
MachineSetMachinesReadyNoReplicasV1Beta2Reason surfaces when no machines exist for the MachineSet.
MachineSetMachinesReadyUnknownV1Beta2Reason surfaces when at least one of the controlled machine's Ready conditions is unknown and none of the controlled machine's Ready conditions is false.
MachineSetMachinesReadyV1Beta2Condition surfaces detail of issues on the controlled machines, if any.
MachineSetMachinesReadyV1Beta2Reason surfaces when all the controlled machine's Ready conditions are true.
MachineSetMachinesUpToDateInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines or aggregating status.
MachineSetMachinesUpToDateNoReplicasV1Beta2Reason surfaces when no machines exist for the MachineSet.
MachineSetMachinesUpToDateUnknownV1Beta2Reason surfaces when at least one of the controlled machine's UpToDate conditions is unknown and none of the controlled machine's UpToDate conditions is false.
MachineSetMachinesUpToDateV1Beta2Condition surfaces details of controlled machines not up to date, if any.
MachineSetMachinesUpToDateV1Beta2Reason surfaces when all the controlled machine's UpToDate conditions are true.
MachineSetNameLabel is the label set on machines if they're controlled by MachineSet.
MachineSetNotDeletingV1Beta2Reason surfaces when the MachineSet is not deleting because the DeletionTimestamp is not set.
MachineSetNotRemediatingV1Beta2Reason surfaces when the MachineSet does not have any machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false.
MachineSetNotScalingDownV1Beta2Reason surfaces when actual replicas <= desired replicas.
MachineSetNotScalingUpV1Beta2Reason surfaces when actual replicas >= desired replicas.
MachineSetPreflightCheckAll can be used to represent all the MachineSet preflight checks.
MachineSetPreflightCheckControlPlaneIsStable is the name of the preflight check that verifies if the control plane is not provisioning and not upgrading.
MachineSetPreflightCheckKubeadmVersionSkew is the name of the preflight check that verifies if the machine being created or remediated for the MachineSet conforms to the kubeadm version skew policy that requires the machine to be at the same version as the control plane.
MachineSetPreflightCheckKubernetesVersionSkew is the name of the preflight check that verifies if the machines being created or remediated for the MachineSet conform to the Kubernetes version skew policy that requires the machines to be at a version that is not more than 2 minor lower than the ControlPlane version.
MachineSetReadyCondition reports a summary of current status of the MachineSet owned by the MachineDeployment.
MachineSetRemediatingInternalErrorV1Beta2Reason surfaces unexpected failures when computing the Remediating condition.
MachineSetRemediatingV1Beta2Condition surfaces details about ongoing remediation of the controlled machines, if any.
MachineSetRemediatingV1Beta2Reason surfaces when the MachineSet has at least one machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false.
MachineSetScalingDownInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines.
MachineSetScalingDownV1Beta2Condition is true if actual replicas > desired replicas.
MachineSetScalingDownV1Beta2Reason surfaces when actual replicas > desired replicas.
MachineSetScalingDownWaitingForReplicasSetV1Beta2Reason surfaces when the .spec.replicas field of the MachineSet is not set.
MachineSetScalingUpInternalErrorV1Beta2Reason surfaces unexpected failures when listing machines.
MachineSetScalingUpV1Beta2Condition is true if actual replicas < desired replicas.
MachineSetScalingUpV1Beta2Reason surfaces when actual replicas < desired replicas.
MachineSetScalingUpWaitingForReplicasSetV1Beta2Reason surfaces when the .spec.replicas field of the MachineSet is not set.
MachineSetSkipPreflightChecksAnnotation is the annotation used to provide a comma-separated list of preflight checks that should be skipped during the MachineSet reconciliation.
MachineSetTopologyFinalizer is the finalizer used by the topology MachineDeployment controller to clean up referenced template resources if necessary when a MachineSet is being deleted.
MachineSkipRemediationAnnotation is the annotation used to mark the machines that should not be considered for remediation by MachineHealthCheck reconciler.
MachinesReadyCondition reports an aggregate of current status of the machines controlled by the MachineSet.
MachinesReadyV1Beta2Condition surfaces detail of issues on the controlled machines, if any.
MachinesUpToDateV1Beta2Condition surfaces details of controlled machines not up to date, if any.
MachineUpToDateV1Beta2Condition is true if the Machine spec matches the spec of the Machine's owner resource, e.g.
MachineUpToDateV1Beta2Reason surface when a Machine spec matches the spec of the Machine's owner resource, e.g.
MachineWaitingForMinReadySecondsV1Beta2Reason surfaces when a machine is ready for less than MinReadySeconds (and thus not yet available).
ManagedByAnnotation is an annotation that can be applied to InfraCluster resources to signify that some external system is managing the cluster infrastructure.
ManagedNodeLabelDomain is one of the CAPI managed Node label domains.
MaxReplicasAnnotation is the maximum replicas a deployment can have at a given point, which is machinedeployment.spec.replicas + maxSurge.
MissingNodeRefReason (Severity=Info) documents a cluster waiting for at least one control plane Machine to have its node reference populated.
NewestMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.x-k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.FailureReason or Status.FailureMessage are set to a non-empty value or NodeHealthy type of Status.Conditions is not true).
NodeConditionsFailedReason (Severity=Warning) documents a node is not in a healthy state due to the failed state of at least 1 Kubelet condition.
NodeInspectionFailedReason documents a failure in inspecting the node.
NodeNotFoundReason (Severity=Error) documents a machine's node has previously been observed but is now gone.
NodeProvisioningReason (Severity=Info) documents machine in the process of provisioning a node.
NodeRestrictionLabelDomain is one of the CAPI managed Node label domains.
NodeRoleLabelPrefix is one of the CAPI managed Node label prefixes.
NodeStartupTimeoutReason is the reason used when a machine's node does not appear within the specified timeout.
NoReasonReportedV1Beta2Reason applies to a condition, usually read from an external object, that reports no reason.
NoReplicasV1Beta2Reason surfaces when an object that manage replicas does not have any.
NotAvailableV1Beta2Reason applies to a condition surfacing object not satisfying availability criteria.
NotDeletingV1Beta2Reason surfaces when an object is not deleting because the DeletionTimestamp is not set.
NotPausedV1Beta2Reason surfaces when an object is not paused.
NotReadyV1Beta2Reason applies to a condition surfacing object not satisfying readiness criteria.
NotRemediatingV1Beta2Reason surfaces when an object does not own any machines with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false by the MachineHealthCheck controller.
NotRollingOutV1Beta2Reason surfaces when an object is not rolling out.
NotScalingDownV1Beta2Reason surfaces when an object is not scaling down.
NotScalingUpV1Beta2Reason surfaces when an object is not scaling up.
NotUpToDateV1Beta2Reason applies to a condition surfacing object not up-tp-date.
ObjectDeletedV1Beta2Reason surfaces when a referenced object has been deleted.
ObjectDoesNotExistV1Beta2Reason surfaces when a referenced object does not exist.
OldestMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.x-k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.FailureReason or Status.FailureMessage are set to a non-empty value or NodeHealthy type of Status.Conditions is not true).
OnDeleteMachineDeploymentStrategyType replaces old MachineSets when the deletion of the associated machines are completed.
OwnerKindAnnotation is the annotation set on nodes identifying the owner kind.
OwnerNameAnnotation is the annotation set on nodes identifying the owner name.
PausedAnnotation is an annotation that can be applied to any Cluster API object to prevent a controller from processing a resource.
PausedV1Beta2Condition reports if reconciliation for an object or the cluster is paused.
PausedV1Beta2Reason surfaces when an object is paused.
PodDrainLabel is the label that can be set on Pods in workload clusters to ensure a Pod is not drained.
PreDrainDeleteHookAnnotationPrefix annotation specifies the prefix we search each annotation for during the pre-drain.delete lifecycle hook to pause reconciliation of deletion.
PreDrainDeleteHookSucceededCondition reports a machine waiting for a PreDrainDeleteHook before being delete.
PreflightCheckFailedReason (Severity=Error) documents a MachineSet failing preflight checks to create machine(s).
PreTerminateDeleteHookAnnotationPrefix annotation specifies the prefix we search each annotation for during the pre-terminate.delete lifecycle hook to pause reconciliation of deletion.
PreTerminateDeleteHookSucceededCondition reports a machine waiting for a PreDrainDeleteHook before being delete.
ProviderNameLabel is the label set on components in the provider manifest.
RandomMachineSetDeletePolicy prioritizes both Machines that have the annotation "cluster.x-k8s.io/delete-machine=yes" and Machines that are unhealthy (Status.FailureReason or Status.FailureMessage are set to a non-empty value or NodeHealthy type of Status.Conditions is not true).
ReadyCondition defines the Ready condition type that summarizes the operational state of a Cluster API object.
ReadyUnknownV1Beta2Reason applies to a condition surfacing object readiness unknown.
ReadyV1Beta2Condition reports if an object is ready.
ReadyV1Beta2Reason applies to a condition surfacing object readiness.
RemediateMachineAnnotation is the annotation used to mark machines that should be remediated by MachineHealthCheck reconciler.
RemediatingV1Beta2Condition surfaces details about ongoing remediation of the controlled machines, if any.
RemediatingV1Beta2Reason surfaces when an object owns at least one machine with HealthCheckSucceeded set to false and with the OwnerRemediated condition set to false by the MachineHealthCheck controller.
RemediationAllowedCondition is set on MachineHealthChecks to show the status of whether the MachineHealthCheck is allowed to remediate any Machines or whether it is blocked from remediating any further.
RemediationFailedReason is the reason used when a remediation owner fails to remediate an unhealthy machine.
RemediationInProgressReason is the reason used when an unhealthy machine is being remediated by the remediation owner.
ReplicasManagedByAnnotation is an annotation that indicates external (non-Cluster API) management of infra scaling.
ResizedCondition documents a MachineSet is resizing the set of controlled machines.
RevisionAnnotation is the revision annotation of a machine deployment's machine sets which records its rollout sequence.
RevisionHistoryAnnotation maintains the history of all old revisions that a machine set has served for a machine deployment.
RollingOutV1Beta2Condition reports if an object is rolling out changes to machines; Cluster API usually rolls out changes to machines by replacing not up-to-date machines with new ones.
RollingOutV1Beta2Reason surfaces when an object is rolling out.
RollingUpdateMachineDeploymentStrategyType replaces the old MachineSet by new one using rolling update i.e.
ScalingDownReason (Severity=Info) documents a MachineSet is decreasing the number of replicas.
ScalingDownV1Beta2Condition reports if an object is scaling down.
ScalingDownV1Beta2Reason surfaces when an object is scaling down.
ScalingUpReason (Severity=Info) documents a MachineSet is increasing the number of replicas.
ScalingUpV1Beta2Condition reports if an object is scaling up.
ScalingUpV1Beta2Reason surfaces when an object is scaling up.
TemplateClonedFromGroupKindAnnotation is the infrastructure machine annotation that stores the group-kind of the infrastructure template resource that was cloned for the machine.
TemplateClonedFromNameAnnotation is the infrastructure machine annotation that stores the name of the infrastructure template resource that was cloned for the machine.
TemplateSuffix is the object kind suffix used by template types.
TooManyUnhealthyReason is the reason used when too many Machines are unhealthy and the MachineHealthCheck is blocked from making any further remediations.
TopologyDryRunAnnotation is an annotation that gets set on objects by the topology controller only during a server side dry run apply operation.
TopologyReconciledClusterClassNotReconciledReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because the ClusterClass has not reconciled yet.
TopologyReconciledCondition provides evidence about the reconciliation of a Cluster topology into the managed objects of the Cluster.
TopologyReconciledControlPlaneUpgradePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because Control Plane is not yet updated to match the desired topology spec.
TopologyReconciledHookBlockingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the lifecycle hooks is blocking.
TopologyReconciledMachineDeploymentsCreatePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the MachineDeployments is yet to be created.
TopologyReconciledMachineDeploymentsUpgradeDeferredReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because the upgrade for at least one of the MachineDeployments has been deferred.
TopologyReconciledMachineDeploymentsUpgradePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the MachineDeployments is not yet updated to match the desired topology spec.
TopologyReconciledMachinePoolsCreatePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the MachinePools is yet to be created.
TopologyReconciledMachinePoolsUpgradeDeferredReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because the upgrade for at least one of the MachinePools has been deferred.
TopologyReconciledMachinePoolsUpgradePendingReason (Severity=Info) documents reconciliation of a Cluster topology not yet completed because at least one of the MachinePools is not yet updated to match the desired topology spec.
TopologyReconciledPausedReason (Severity=Info) surfaces when the Cluster is paused.
TopologyReconcileFailedReason (Severity=Error) documents the reconciliation of a Cluster topology failing due to an error.
UnhealthyNodeConditionReason is the reason used when a machine's node has one of the MachineHealthCheck's unhealthy conditions.
UpToDateUnknownV1Beta2Reason applies to a condition surfacing object up-tp-date unknown.
UpToDateV1Beta2Reason applies to a condition surfacing object up-tp-date.
VariableDefinitionFromInline indicates a patch or variable was defined in the `.spec` of a ClusterClass rather than from an external patch extension.
VariableDiscoveryFailedReason (Severity=Error) documents a ClusterClass with VariableDiscovery extensions that failed.
VolumeDetachSucceededCondition reports a machine waiting for volumes to be detached.
WaitingExternalHookReason (Severity=Info) provide evidence that we are waiting for an external hook to complete.
WaitingForAvailableMachinesReason (Severity=Warning) reflects the fact that the required minimum number of machines for a machinedeployment are not available.
WaitingForControlPlaneAvailableReason (Severity=Info) documents a Cluster API object waiting for the control plane machine to be available.
WaitingForControlPlaneFallbackReason (Severity=Info) documents a cluster waiting for the control plane to be available.
WaitingForControlPlaneProviderInitializedReason (Severity=Info) documents a cluster waiting for the control plane provider to report successful control plane initialization.
WaitingForDataSecretFallbackReason (Severity=Info) documents a machine waiting for the bootstrap data secret to be available.
WaitingForInfrastructureFallbackReason (Severity=Info) documents a cluster/machine/machinepool waiting for the underlying infrastructure to be available.
WaitingForMachineSetFallbackReason (Severity=Info) documents a MachineDeployment waiting for the underlying MachineSet to be available.
WaitingForNodeRefReason (Severity=Info) documents a machine.spec.providerId is not assigned yet.
WaitingForRemediationReason is the reason used when a machine fails a health check and remediation is needed.
WaitingForReplicasSetV1Beta2Reason surfaces when the replica field of an object is not set.
WaitingForVolumeDetachReason (Severity=Info) provide evidence that a machine node waiting for volumes to be attached.
WatchLabel is a label othat can be applied to any Cluster API object.

# Variables

AddToScheme adds the types in this group-version to the given scheme.
DefaultNodeStartupTimeout is the time allowed for a node to start up.
GroupVersion is group version used to register these objects.
NodeOutdatedRevisionTaint can be added to Nodes at rolling updates in general triggered by updating MachineDeployment This taint is used to prevent unnecessary pod churn, i.e., as the first node is drained, pods previously running on that node are scheduled onto nodes who have yet to be replaced, but will be torn down soon.
NodeUninitializedTaint can be added to Nodes at creation by the bootstrap provider, e.g.
ZeroDuration is a zero value of the metav1.Duration type.

# Structs

APIEndpoint represents a reachable Kubernetes API endpoint.
Bootstrap encapsulates fields to configure the Machine’s bootstrapping mechanism.
Cluster is the Schema for the clusters API.
ClusterAvailabilityGate contains the type of a Cluster condition to be used as availability gate.
ClusterClass is a template which can be used to create managed topologies.
ClusterClassList contains a list of Cluster.
ClusterClassPatch defines a patch which is applied to customize the referenced templates.
ClusterClassSpec describes the desired state of the ClusterClass.
ClusterClassStatus defines the observed state of the ClusterClass.
ClusterClassStatusVariable defines a variable which appears in the status of a ClusterClass.
ClusterClassStatusVariableDefinition defines a variable which appears in the status of a ClusterClass.
ClusterClassV1Beta2Status groups all the fields that will be added or modified in ClusterClass with the V1Beta2 version.
ClusterClassVariable defines a variable which can be configured in the Cluster topology and used in patches.
ClusterClassVariableMetadata is the metadata of a variable.
ClusterControlPlaneStatus groups all the observations about control plane current state.
ClusterList contains a list of Cluster.
ClusterNetwork specifies the different networking parameters for a cluster.
ClusterSpec defines the desired state of Cluster.
ClusterStatus defines the observed state of Cluster.
ClusterV1Beta2Status groups all the fields that will be added or modified in Cluster with the V1Beta2 version.
ClusterVariable can be used to customize the Cluster through patches.
Condition defines an observation of a Cluster API resource operational state.
ControlPlaneClass defines the class for the control plane.
ControlPlaneClassNamingStrategy defines the naming strategy for control plane objects.
ControlPlaneTopology specifies the parameters for the control plane nodes in the cluster.
ControlPlaneVariables can be used to provide variables for the ControlPlane.
ExternalPatchDefinition defines an external patch.
FailureDomainSpec is the Schema for Cluster API failure domains.
JSONPatch defines a JSON patch.
JSONPatchValue defines the value of a patch.
JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).
LocalObjectTemplate defines a template for a topology Class.
Machine is the Schema for the machines API.
MachineAddress contains information for the node's address.
MachineDeletionStatus is the deletion state of the Machine.
MachineDeployment is the Schema for the machinedeployments API.
MachineDeploymentClass serves as a template to define a set of worker nodes of the cluster provisioned using the `ClusterClass`.
MachineDeploymentClassNamingStrategy defines the naming strategy for machine deployment objects.
MachineDeploymentClassTemplate defines how a MachineDeployment generated from a MachineDeploymentClass should look like.
MachineDeploymentList contains a list of MachineDeployment.
MachineDeploymentSpec defines the desired state of MachineDeployment.
MachineDeploymentStatus defines the observed state of MachineDeployment.
MachineDeploymentStrategy describes how to replace existing machines with new ones.
MachineDeploymentTopology specifies the different parameters for a set of worker nodes in the topology.
MachineDeploymentV1Beta2Status groups all the fields that will be added or modified in MachineDeployment with the V1Beta2 version.
MachineDeploymentVariables can be used to provide variables for a specific MachineDeployment.
MachineDrainRule is the Schema for the MachineDrainRule API.
MachineDrainRuleDrainConfig configures if and how Pods are drained.
MachineDrainRuleList contains a list of MachineDrainRules.
MachineDrainRuleMachineSelector defines to which Machines this MachineDrainRule should be applied.
MachineDrainRulePodSelector defines to which Pods this MachineDrainRule should be applied.
MachineDrainRuleSpec defines the spec of a MachineDrainRule.
MachineHealthCheck is the Schema for the machinehealthchecks API.
MachineHealthCheckClass defines a MachineHealthCheck for a group of Machines.
MachineHealthCheckList contains a list of MachineHealthCheck.
MachineHealthCheckSpec defines the desired state of MachineHealthCheck.
MachineHealthCheckStatus defines the observed state of MachineHealthCheck.
MachineHealthCheckTopology defines a MachineHealthCheck for a group of machines.
MachineHealthCheckV1Beta2Status groups all the fields that will be added or modified in MachineHealthCheck with the V1Beta2 version.
MachineList contains a list of Machine.
MachinePoolClass serves as a template to define a pool of worker nodes of the cluster provisioned using `ClusterClass`.
MachinePoolClassNamingStrategy defines the naming strategy for machine pool objects.
MachinePoolClassTemplate defines how a MachinePool generated from a MachinePoolClass should look like.
MachinePoolTopology specifies the different parameters for a pool of worker nodes in the topology.
MachinePoolVariables can be used to provide variables for a specific MachinePool.
MachineReadinessGate contains the type of a Machine condition to be used as a readiness gate.
MachineRollingUpdateDeployment is used to control the desired behavior of rolling update.
MachineSet is the Schema for the machinesets API.
MachineSetList contains a list of MachineSet.
MachineSetSpec defines the desired state of MachineSet.
MachineSetStatus defines the observed state of MachineSet.
MachineSetV1Beta2Status groups all the fields that will be added or modified in MachineSetStatus with the V1Beta2 version.
MachineSpec defines the desired state of Machine.
MachineStatus defines the observed state of Machine.
MachineTemplateSpec describes the data needed to create a Machine from a template.
MachineV1Beta2Status groups all the fields that will be added or modified in MachineStatus with the V1Beta2 version.
NetworkRanges represents ranges of network addresses.
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
PatchDefinition defines a patch which is applied to customize the referenced templates.
PatchSelector defines on which templates the patch should be applied.
PatchSelectorMatch selects templates based on where they are referenced.
PatchSelectorMatchMachineDeploymentClass selects templates referenced in specific MachineDeploymentClasses in .spec.workers.machineDeployments.
PatchSelectorMatchMachinePoolClass selects templates referenced in specific MachinePoolClasses in .spec.workers.machinePools.
RemediationStrategy allows to define how the MachineSet can control scaling operations.
Topology encapsulates the information of the managed resources.
UnhealthyCondition represents a Node condition type and value with a timeout specified as a duration.
ValidationRule describes a validation rule written in the CEL expression language.
VariableSchema defines the schema of a variable.
VariableSchemaMetadata is the metadata of a variable or a nested field within a variable.
WorkersClass is a collection of deployment classes.
WorkersStatus groups all the observations about workers current state.
WorkersTopology represents the different sets of worker nodes in the cluster.

# Type aliases

ClusterIPFamily defines the types of supported IP families.
ClusterPhase is a string representation of a Cluster Phase.
Conditions provide observations of the operational state of a Cluster API resource.
ConditionSeverity expresses the severity of a Condition Type failing.
ConditionType is a valid value for Condition.Type.
FailureDomains is a slice of FailureDomains.
FieldValueErrorReason is a machine-readable value providing more detail about why a field failed the validation.
MachineAddresses is a slice of MachineAddress items to be used by infrastructure providers.
MachineAddressType describes a valid MachineAddress type.
MachineDeploymentPhase indicates the progress of the machine deployment.
MachineDeploymentStrategyType defines the type of MachineDeployment rollout strategies.
MachineDrainRuleDrainBehavior defines the drain behavior.
MachinePhase is a string representation of a Machine Phase.
MachineSetDeletePolicy defines how priority is assigned to nodes to delete when downscaling a MachineSet.
MachineSetPreflightCheck defines a valid MachineSet preflight check.