Documentation ¶
Overview ¶
Package v1alpha3 contains the v1alpha3 API implementation. +k8s:conversion-gen=sigs.k8s.io/cluster-api/exp/api/v1beta1
Deprecated: This package will be removed in one of the next releases.
Package v1alpha3 contains API Schema definitions for the exp v1alpha3 API group +kubebuilder:object:generate=true +groupName=cluster.x-k8s.io
Index ¶
- Constants
- Variables
- func Convert_v1alpha3_MachinePoolList_To_v1beta1_MachinePoolList(in *MachinePoolList, out *v1beta1.MachinePoolList, s conversion.Scope) error
- func Convert_v1alpha3_MachinePoolSpec_To_v1beta1_MachinePoolSpec(in *MachinePoolSpec, out *expv1.MachinePoolSpec, ...) error
- func Convert_v1alpha3_MachinePoolStatus_To_v1beta1_MachinePoolStatus(in *MachinePoolStatus, out *v1beta1.MachinePoolStatus, s conversion.Scope) error
- func Convert_v1alpha3_MachinePool_To_v1beta1_MachinePool(in *MachinePool, out *expv1.MachinePool, s apimachineryconversion.Scope) error
- func Convert_v1alpha3_MachineTemplateSpec_To_v1beta1_MachineTemplateSpec(in *clusterv1alpha3.MachineTemplateSpec, out *clusterv1.MachineTemplateSpec, ...) error
- func Convert_v1beta1_MachinePoolList_To_v1alpha3_MachinePoolList(in *v1beta1.MachinePoolList, out *MachinePoolList, s conversion.Scope) error
- func Convert_v1beta1_MachinePoolSpec_To_v1alpha3_MachinePoolSpec(in *v1beta1.MachinePoolSpec, out *MachinePoolSpec, s conversion.Scope) error
- func Convert_v1beta1_MachinePoolStatus_To_v1alpha3_MachinePoolStatus(in *expv1.MachinePoolStatus, out *MachinePoolStatus, ...) error
- func Convert_v1beta1_MachinePool_To_v1alpha3_MachinePool(in *expv1.MachinePool, out *MachinePool, s apimachineryconversion.Scope) error
- func Convert_v1beta1_MachineTemplateSpec_To_v1alpha3_MachineTemplateSpec(in *clusterv1.MachineTemplateSpec, out *clusterv1alpha3.MachineTemplateSpec, ...) error
- func RegisterConversions(s *runtime.Scheme) error
- type MachinePooldeprecated
- func (dst *MachinePool) ConvertFrom(srcRaw conversion.Hub) error
- func (src *MachinePool) ConvertTo(dstRaw conversion.Hub) error
- func (in *MachinePool) DeepCopy() *MachinePool
- func (in *MachinePool) DeepCopyInto(out *MachinePool)
- func (in *MachinePool) DeepCopyObject() runtime.Object
- func (m *MachinePool) GetConditions() clusterv1alpha3.Conditions
- func (m *MachinePool) SetConditions(conditions clusterv1alpha3.Conditions)
- type MachinePoolListdeprecated
- func (dst *MachinePoolList) ConvertFrom(srcRaw conversion.Hub) error
- func (src *MachinePoolList) ConvertTo(dstRaw conversion.Hub) error
- func (in *MachinePoolList) DeepCopy() *MachinePoolList
- func (in *MachinePoolList) DeepCopyInto(out *MachinePoolList)
- func (in *MachinePoolList) DeepCopyObject() runtime.Object
- type MachinePoolPhase
- type MachinePoolSpec
- type MachinePoolStatus
Constants ¶
const ( // ReplicasReadyCondition reports an aggregate of current status of the replicas controlled by the MachinePool. ReplicasReadyCondition clusterv1alpha3.ConditionType = "ReplicasReady" // WaitingForReplicasReadyReason (Severity=Info) documents a machinepool waiting for the required replicas // to be ready. WaitingForReplicasReadyReason = "WaitingForReplicasReady" )
const ( // MachinePoolPhasePending is the first state a MachinePool is assigned by // Cluster API MachinePool controller after being created. MachinePoolPhasePending = MachinePoolPhase("Pending") // MachinePoolPhaseProvisioning is the state when the // MachinePool infrastructure is being created or updated. MachinePoolPhaseProvisioning = MachinePoolPhase("Provisioning") // MachinePoolPhaseProvisioned is the state when its // infrastructure has been created and configured. MachinePoolPhaseProvisioned = MachinePoolPhase("Provisioned") // MachinePoolPhaseRunning is the MachinePool state when its instances // have become Kubernetes Nodes in the Ready state. MachinePoolPhaseRunning = MachinePoolPhase("Running") // MachinePoolPhaseScalingUp is the MachinePool state when the // MachinePool infrastructure is scaling up. MachinePoolPhaseScalingUp = MachinePoolPhase("ScalingUp") // MachinePoolPhaseScalingDown is the MachinePool state when the // MachinePool infrastructure is scaling down. MachinePoolPhaseScalingDown = MachinePoolPhase("ScalingDown") // MachinePoolPhaseDeleting is the MachinePool state when a delete // request has been sent to the API Server, // but its infrastructure has not yet been fully deleted. MachinePoolPhaseDeleting = MachinePoolPhase("Deleting") // MachinePoolPhaseFailed is the MachinePool state when the system // might require user intervention. MachinePoolPhaseFailed = MachinePoolPhase("Failed") // MachinePoolPhaseUnknown is returned if the MachinePool state cannot be determined. MachinePoolPhaseUnknown = MachinePoolPhase("Unknown") )
const (
// MachinePoolFinalizer is used to ensure deletion of dependencies (nodes, infra).
MachinePoolFinalizer = "machinepool.exp.cluster.x-k8s.io"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects. GroupVersion = schema.GroupVersion{Group: "cluster.x-k8s.io", Version: "v1alpha3"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Convert_v1alpha3_MachinePoolList_To_v1beta1_MachinePoolList ¶
func Convert_v1alpha3_MachinePoolList_To_v1beta1_MachinePoolList(in *MachinePoolList, out *v1beta1.MachinePoolList, s conversion.Scope) error
Convert_v1alpha3_MachinePoolList_To_v1beta1_MachinePoolList is an autogenerated conversion function.
func Convert_v1alpha3_MachinePoolSpec_To_v1beta1_MachinePoolSpec ¶
func Convert_v1alpha3_MachinePoolSpec_To_v1beta1_MachinePoolSpec(in *MachinePoolSpec, out *expv1.MachinePoolSpec, s apimachineryconversion.Scope) error
Convert_v1alpha3_MachinePoolSpec_To_v1beta1_MachinePoolSpec is an autogenerated conversion function.
func Convert_v1alpha3_MachinePoolStatus_To_v1beta1_MachinePoolStatus ¶
func Convert_v1alpha3_MachinePoolStatus_To_v1beta1_MachinePoolStatus(in *MachinePoolStatus, out *v1beta1.MachinePoolStatus, s conversion.Scope) error
Convert_v1alpha3_MachinePoolStatus_To_v1beta1_MachinePoolStatus is an autogenerated conversion function.
func Convert_v1alpha3_MachinePool_To_v1beta1_MachinePool ¶
func Convert_v1alpha3_MachinePool_To_v1beta1_MachinePool(in *MachinePool, out *expv1.MachinePool, s apimachineryconversion.Scope) error
func Convert_v1alpha3_MachineTemplateSpec_To_v1beta1_MachineTemplateSpec ¶ added in v1.8.0
func Convert_v1alpha3_MachineTemplateSpec_To_v1beta1_MachineTemplateSpec(in *clusterv1alpha3.MachineTemplateSpec, out *clusterv1.MachineTemplateSpec, s apimachineryconversion.Scope) error
func Convert_v1beta1_MachinePoolList_To_v1alpha3_MachinePoolList ¶
func Convert_v1beta1_MachinePoolList_To_v1alpha3_MachinePoolList(in *v1beta1.MachinePoolList, out *MachinePoolList, s conversion.Scope) error
Convert_v1beta1_MachinePoolList_To_v1alpha3_MachinePoolList is an autogenerated conversion function.
func Convert_v1beta1_MachinePoolSpec_To_v1alpha3_MachinePoolSpec ¶
func Convert_v1beta1_MachinePoolSpec_To_v1alpha3_MachinePoolSpec(in *v1beta1.MachinePoolSpec, out *MachinePoolSpec, s conversion.Scope) error
Convert_v1beta1_MachinePoolSpec_To_v1alpha3_MachinePoolSpec is an autogenerated conversion function.
func Convert_v1beta1_MachinePoolStatus_To_v1alpha3_MachinePoolStatus ¶
func Convert_v1beta1_MachinePoolStatus_To_v1alpha3_MachinePoolStatus(in *expv1.MachinePoolStatus, out *MachinePoolStatus, s apimachineryconversion.Scope) error
func Convert_v1beta1_MachinePool_To_v1alpha3_MachinePool ¶
func Convert_v1beta1_MachinePool_To_v1alpha3_MachinePool(in *expv1.MachinePool, out *MachinePool, s apimachineryconversion.Scope) error
func Convert_v1beta1_MachineTemplateSpec_To_v1alpha3_MachineTemplateSpec ¶ added in v1.8.0
func Convert_v1beta1_MachineTemplateSpec_To_v1alpha3_MachineTemplateSpec(in *clusterv1.MachineTemplateSpec, out *clusterv1alpha3.MachineTemplateSpec, s apimachineryconversion.Scope) error
func RegisterConversions ¶
RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.
Types ¶
type MachinePool
deprecated
type MachinePool struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MachinePoolSpec `json:"spec,omitempty"` Status MachinePoolStatus `json:"status,omitempty"` }
MachinePool is the Schema for the machinepools API.
Deprecated: This type will be removed in one of the next releases.
func (*MachinePool) ConvertFrom ¶
func (dst *MachinePool) ConvertFrom(srcRaw conversion.Hub) error
func (*MachinePool) ConvertTo ¶
func (src *MachinePool) ConvertTo(dstRaw conversion.Hub) error
func (*MachinePool) DeepCopy ¶
func (in *MachinePool) DeepCopy() *MachinePool
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachinePool.
func (*MachinePool) DeepCopyInto ¶
func (in *MachinePool) DeepCopyInto(out *MachinePool)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachinePool) DeepCopyObject ¶
func (in *MachinePool) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*MachinePool) GetConditions ¶
func (m *MachinePool) GetConditions() clusterv1alpha3.Conditions
GetConditions returns the set of conditions for this object.
func (*MachinePool) SetConditions ¶
func (m *MachinePool) SetConditions(conditions clusterv1alpha3.Conditions)
SetConditions sets the conditions on this object.
type MachinePoolList
deprecated
type MachinePoolList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []MachinePool `json:"items"` }
MachinePoolList contains a list of MachinePool.
Deprecated: This type will be removed in one of the next releases.
func (*MachinePoolList) ConvertFrom ¶
func (dst *MachinePoolList) ConvertFrom(srcRaw conversion.Hub) error
func (*MachinePoolList) ConvertTo ¶
func (src *MachinePoolList) ConvertTo(dstRaw conversion.Hub) error
func (*MachinePoolList) DeepCopy ¶
func (in *MachinePoolList) DeepCopy() *MachinePoolList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachinePoolList.
func (*MachinePoolList) DeepCopyInto ¶
func (in *MachinePoolList) DeepCopyInto(out *MachinePoolList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachinePoolList) DeepCopyObject ¶
func (in *MachinePoolList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MachinePoolPhase ¶
type MachinePoolPhase string
MachinePoolPhase is a string representation of a MachinePool Phase.
This type is a high-level indicator of the status of the MachinePool as it is provisioned, from the API user’s perspective.
The value should not be interpreted by any software components as a reliable indication of the actual state of the MachinePool, and controllers should not use the MachinePool Phase field value when making decisions about what action to take.
Controllers should always look at the actual state of the MachinePool’s fields to make those decisions.
type MachinePoolSpec ¶
type MachinePoolSpec struct { // clusterName is the name of the Cluster this object belongs to. // +kubebuilder:validation:MinLength=1 ClusterName string `json:"clusterName"` // Number of desired machines. Defaults to 1. // This is a pointer to distinguish between explicit zero and not specified. Replicas *int32 `json:"replicas,omitempty"` // template describes the machines that will be created. Template clusterv1alpha3.MachineTemplateSpec `json:"template"` // The deployment strategy to use to replace existing machine instances with // new ones. // +optional Strategy *clusterv1alpha3.MachineDeploymentStrategy `json:"strategy,omitempty"` // Minimum number of seconds for which a newly created machine instances should // be ready. // Defaults to 0 (machine instance will be considered available as soon as it // is ready) // +optional MinReadySeconds *int32 `json:"minReadySeconds,omitempty"` // providerIDList are the identification IDs of machine instances provided by the provider. // This field must match the provider IDs as seen on the node objects corresponding to a machine pool's machine instances. // +optional ProviderIDList []string `json:"providerIDList,omitempty"` // failureDomains is the list of failure domains this MachinePool should be attached to. FailureDomains []string `json:"failureDomains,omitempty"` }
MachinePoolSpec defines the desired state of MachinePool.
func (*MachinePoolSpec) DeepCopy ¶
func (in *MachinePoolSpec) DeepCopy() *MachinePoolSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachinePoolSpec.
func (*MachinePoolSpec) DeepCopyInto ¶
func (in *MachinePoolSpec) DeepCopyInto(out *MachinePoolSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MachinePoolStatus ¶
type MachinePoolStatus struct { // nodeRefs will point to the corresponding Nodes if it they exist. // +optional NodeRefs []corev1.ObjectReference `json:"nodeRefs,omitempty"` // replicas is the most recently observed number of replicas. // +optional Replicas int32 `json:"replicas"` // The number of ready replicas for this MachinePool. A machine is considered ready when the node has been created and is "Ready". // +optional ReadyReplicas int32 `json:"readyReplicas,omitempty"` // The number of available replicas (ready for at least minReadySeconds) for this MachinePool. // +optional AvailableReplicas int32 `json:"availableReplicas,omitempty"` // This is the total number of machine instances that are still required for // the machine pool to have 100% available capacity. They may either // be machine instances that are running but not yet available or machine instances // that still have not been created. // +optional UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"` // failureReason indicates that there is a problem reconciling the state, and // will be set to a token value suitable for programmatic interpretation. // +optional FailureReason *capierrors.MachinePoolStatusFailure `json:"failureReason,omitempty"` // failureMessage indicates that there is a problem reconciling the state, // and will be set to a descriptive error message. // +optional FailureMessage *string `json:"failureMessage,omitempty"` // phase represents the current phase of cluster actuation. // E.g. Pending, Running, Terminating, Failed etc. // +optional Phase string `json:"phase,omitempty"` // bootstrapReady is the state of the bootstrap provider. // +optional BootstrapReady bool `json:"bootstrapReady"` // infrastructureReady is the state of the infrastructure provider. // +optional InfrastructureReady bool `json:"infrastructureReady"` // observedGeneration is the latest generation observed by the controller. // +optional ObservedGeneration int64 `json:"observedGeneration,omitempty"` // conditions define the current service state of the MachinePool. // +optional Conditions clusterv1alpha3.Conditions `json:"conditions,omitempty"` }
MachinePoolStatus defines the observed state of MachinePool.
func (*MachinePoolStatus) DeepCopy ¶
func (in *MachinePoolStatus) DeepCopy() *MachinePoolStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachinePoolStatus.
func (*MachinePoolStatus) DeepCopyInto ¶
func (in *MachinePoolStatus) DeepCopyInto(out *MachinePoolStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MachinePoolStatus) GetTypedPhase ¶
func (m *MachinePoolStatus) GetTypedPhase() MachinePoolPhase
GetTypedPhase attempts to parse the Phase field and return the typed MachinePoolPhase representation as described in `machinepool_phase_types.go`.
func (*MachinePoolStatus) SetTypedPhase ¶
func (m *MachinePoolStatus) SetTypedPhase(p MachinePoolPhase)
SetTypedPhase sets the Phase field to the string representation of MachinePoolPhase.