v1beta1

package
Version: v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 6, 2021 License: Apache-2.0 Imports: 13 Imported by: 27

Documentation

Overview

Package v1beta1 contains API Schema definitions for the exp v1beta1 API group +kubebuilder:object:generate=true +groupName=cluster.x-k8s.io

Index

Constants

View Source
const (
	// ReplicasReadyCondition reports an aggregate of current status of the replicas controlled by the MachinePool.
	ReplicasReadyCondition clusterv1.ConditionType = "ReplicasReady"

	// WaitingForReplicasReadyReason (Severity=Info) documents a machinepool waiting for the required replicas
	// to be ready.
	WaitingForReplicasReadyReason = "WaitingForReplicasReady"
)
View Source
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")
)
View Source
const (
	// MachinePoolFinalizer is used to ensure deletion of dependencies (nodes, infra).
	MachinePoolFinalizer = "machinepool.cluster.x-k8s.io"
)

Variables

View Source
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "cluster.x-k8s.io", Version: "v1beta1"}

	// 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

This section is empty.

Types

type MachinePool

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.

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) Default

func (m *MachinePool) Default()

Default implements webhook.Defaulter so a webhook will be registered for the type.

func (*MachinePool) GetConditions

func (m *MachinePool) GetConditions() clusterv1.Conditions

GetConditions returns the set of conditions for this object.

func (*MachinePool) Hub

func (*MachinePool) Hub()

func (*MachinePool) SetConditions

func (m *MachinePool) SetConditions(conditions clusterv1.Conditions)

SetConditions sets the conditions on this object.

func (*MachinePool) SetupWebhookWithManager

func (m *MachinePool) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*MachinePool) ValidateCreate

func (m *MachinePool) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type.

func (*MachinePool) ValidateDelete

func (m *MachinePool) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type.

func (*MachinePool) ValidateUpdate

func (m *MachinePool) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type.

type MachinePoolList

type MachinePoolList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []MachinePool `json:"items"`
}

MachinePoolList contains a list of MachinePool.

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.

func (*MachinePoolList) Hub

func (*MachinePoolList) Hub()

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.
	// +optional
	Replicas *int32 `json:"replicas,omitempty"`

	// Template describes the machines that will be created.
	Template clusterv1.MachineTemplateSpec `json:"template"`

	// 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.
	// +optional
	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"`

	// Total number of unavailable machine instances targeted by this machine pool.
	// 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 clusterv1.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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL