v1alpha3

Documentation

Overview

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

Index

• Constants
• Variables
• type KubeadmControlPlane
  • func (in *KubeadmControlPlane) DeepCopy() *KubeadmControlPlane
  • func (in *KubeadmControlPlane) DeepCopyInto(out *KubeadmControlPlane)
  • func (in *KubeadmControlPlane) DeepCopyObject() runtime.Object
  • func (in *KubeadmControlPlane) Default()
  • func (in *KubeadmControlPlane) SetupWebhookWithManager(mgr ctrl.Manager) error
  • func (in *KubeadmControlPlane) ValidateCreate() error
  • func (in *KubeadmControlPlane) ValidateDelete() error
  • func (in *KubeadmControlPlane) ValidateUpdate(old runtime.Object) error
• type KubeadmControlPlaneList
  • func (in *KubeadmControlPlaneList) DeepCopy() *KubeadmControlPlaneList
  • func (in *KubeadmControlPlaneList) DeepCopyInto(out *KubeadmControlPlaneList)
  • func (in *KubeadmControlPlaneList) DeepCopyObject() runtime.Object
• type KubeadmControlPlaneSpec
  • func (in *KubeadmControlPlaneSpec) DeepCopy() *KubeadmControlPlaneSpec
  • func (in *KubeadmControlPlaneSpec) DeepCopyInto(out *KubeadmControlPlaneSpec)
• type KubeadmControlPlaneStatus
  • func (in *KubeadmControlPlaneStatus) DeepCopy() *KubeadmControlPlaneStatus
  • func (in *KubeadmControlPlaneStatus) DeepCopyInto(out *KubeadmControlPlaneStatus)

Constants

const (
	KubeadmControlPlaneFinalizer    = "kubeadm.controlplane.cluster.x-k8s.io"
	KubeadmControlPlaneHashLabelKey = "kubeadm.controlplane.cluster.x-k8s.io/hash"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "controlplane.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
)

Types

type KubeadmControlPlane

type KubeadmControlPlane struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   KubeadmControlPlaneSpec   `json:"spec,omitempty"`
	Status KubeadmControlPlaneStatus `json:"status,omitempty"`
}

KubeadmControlPlane is the Schema for the KubeadmControlPlane API.

func (*KubeadmControlPlane) DeepCopy

func (in *KubeadmControlPlane) DeepCopy() *KubeadmControlPlane

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeadmControlPlane.

func (*KubeadmControlPlane) DeepCopyInto

func (in *KubeadmControlPlane) DeepCopyInto(out *KubeadmControlPlane)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KubeadmControlPlane) DeepCopyObject

func (in *KubeadmControlPlane) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*KubeadmControlPlane) Default

func (in *KubeadmControlPlane) Default()

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

func (*KubeadmControlPlane) SetupWebhookWithManager

func (in *KubeadmControlPlane) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*KubeadmControlPlane) ValidateCreate

func (in *KubeadmControlPlane) ValidateCreate() error

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

func (*KubeadmControlPlane) ValidateDelete

func (in *KubeadmControlPlane) ValidateDelete() error

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

func (*KubeadmControlPlane) ValidateUpdate

func (in *KubeadmControlPlane) ValidateUpdate(old runtime.Object) error

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

type KubeadmControlPlaneList

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

KubeadmControlPlaneList contains a list of KubeadmControlPlane.

func (*KubeadmControlPlaneList) DeepCopy

func (in *KubeadmControlPlaneList) DeepCopy() *KubeadmControlPlaneList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeadmControlPlaneList.

func (*KubeadmControlPlaneList) DeepCopyInto

func (in *KubeadmControlPlaneList) DeepCopyInto(out *KubeadmControlPlaneList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*KubeadmControlPlaneList) DeepCopyObject

func (in *KubeadmControlPlaneList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type KubeadmControlPlaneSpec

type KubeadmControlPlaneSpec struct {
	// Number of desired machines. Defaults to 1. When stacked etcd is used only
	// odd numbers are permitted, as per [etcd best practice](https://etcd.io/docs/v3.3.12/faq/#why-an-odd-number-of-cluster-members).
	// This is a pointer to distinguish between explicit zero and not specified.
	// +optional
	Replicas *int32 `json:"replicas,omitempty"`

	// Version defines the desired Kubernetes version.
	// +kubebuilder:validation:MinLength:=2
	// +kubebuilder:validation:Pattern:=^v(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)([-0-9a-zA-Z_\.+]*)?$
	Version string `json:"version"`

	// InfrastructureTemplate is a required reference to a custom resource
	// offered by an infrastructure provider.
	InfrastructureTemplate corev1.ObjectReference `json:"infrastructureTemplate"`

	// KubeadmConfigSpec is a KubeadmConfigSpec
	// to use for initializing and joining machines to the control plane.
	KubeadmConfigSpec cabpkv1.KubeadmConfigSpec `json:"kubeadmConfigSpec"`

	// UpgradeAfter is a field to indicate an upgrade should be performed
	// after the specified time even if no changes have been made to the
	// KubeadmControlPlane
	// +optional
	UpgradeAfter *metav1.Time `json:"upgradeAfter,omitempty"`
}

KubeadmControlPlaneSpec defines the desired state of KubeadmControlPlane.

func (*KubeadmControlPlaneSpec) DeepCopy

func (in *KubeadmControlPlaneSpec) DeepCopy() *KubeadmControlPlaneSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeadmControlPlaneSpec.

func (*KubeadmControlPlaneSpec) DeepCopyInto

func (in *KubeadmControlPlaneSpec) DeepCopyInto(out *KubeadmControlPlaneSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KubeadmControlPlaneStatus

type KubeadmControlPlaneStatus struct {
	// Selector is the label selector in string format to avoid introspection
	// by clients, and is used to provide the CRD-based integration for the
	// scale subresource and additional integrations for things like kubectl
	// describe.. The string will be in the same format as the query-param syntax.
	// More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors
	// +optional
	Selector string `json:"selector,omitempty"`

	// Total number of non-terminated machines targeted by this control plane
	// (their labels match the selector).
	// +optional
	Replicas int32 `json:"replicas,omitempty"`

	// Total number of non-terminated machines targeted by this control plane
	// that have the desired template spec.
	// +optional
	UpdatedReplicas int32 `json:"updatedReplicas,omitempty"`

	// Total number of fully running and ready control plane machines.
	// +optional
	ReadyReplicas int32 `json:"readyReplicas,omitempty"`

	// Total number of unavailable machines targeted by this control plane.
	// This is the total number of machines that are still required for
	// the deployment to have 100% available capacity. They may either
	// be machines that are running but not yet ready or machines
	// that still have not been created.
	// +optional
	UnavailableReplicas int32 `json:"unavailableReplicas,omitempty"`

	// Initialized denotes whether or not the control plane has the
	// uploaded kubeadm-config configmap.
	// +optional
	Initialized bool `json:"initialized"`

	// Ready denotes that the KubeadmControlPlane API Server is ready to
	// receive requests.
	// +optional
	Ready bool `json:"ready"`

	// FailureReason indicates that there is a terminal problem reconciling the
	// state, and will be set to a token value suitable for
	// programmatic interpretation.
	// +optional
	FailureReason errors.KubeadmControlPlaneStatusError `json:"failureReason,omitempty"`

	// ErrorMessage indicates that there is a terminal problem reconciling the
	// state, and will be set to a descriptive error message.
	// +optional
	FailureMessage *string `json:"failureMessage,omitempty"`
}

KubeadmControlPlaneStatus defines the observed state of KubeadmControlPlane.

func (*KubeadmControlPlaneStatus) DeepCopy

func (in *KubeadmControlPlaneStatus) DeepCopy() *KubeadmControlPlaneStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubeadmControlPlaneStatus.

func (*KubeadmControlPlaneStatus) DeepCopyInto

func (in *KubeadmControlPlaneStatus) DeepCopyInto(out *KubeadmControlPlaneStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.