v1beta1

package
v1.0.24 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2024 License: Apache-2.0 Imports: 13 Imported by: 17

Documentation

Overview

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

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

Index

Constants

View Source
const (
	// EtcdMachinesSpecUpToDateCondition documents that the spec of the machines controlled by the EtcdadmCluster
	// is up to date. When this condition is false, the EtcdadmCluster is executing a rolling upgrade.
	EtcdMachinesSpecUpToDateCondition clusterv1.ConditionType = "EtcdMachinesSpecUpToDate"

	// EtcdRollingUpdateInProgressReason (Severity=Warning) documents an EtcdadmCluster object executing a
	// rolling upgrade for aligning the machines spec to the desired state.
	EtcdRollingUpdateInProgressReason = "EtcdRollingUpdateInProgress"

	// EtcdMaxNumberOfMachinesReached (Severity=Warning) indicatest that there are 2X replicas while executing a
	// rolling upgrade for aligning the machines spec to the desired state.
	MaxNumberOfEtcdMachinesReachedReason = "MaxNumberOfEtcdMachinesReached"

	// EtcdCertificatesAvailableCondition indicates that the etcdadm controller has generated the etcd certs to be used by new members
	// joining the etcd cluster, and to be used by the controlplane
	EtcdCertificatesAvailableCondition clusterv1.ConditionType = "EtcdCertificatesAvailable"

	// EtcdClusterResizeCompleted indicates if cluster is finished with scale up/down or is being resized
	EtcdClusterResizeCompleted clusterv1.ConditionType = "EtcdClusterResizeCompleted"

	// EtcdScaleUpInProgressReason indicates scale up is in progress
	EtcdScaleUpInProgressReason = "ScalingUp"

	// EtcdScaleDownInProgressReason indicates scale down is in progress
	EtcdScaleDownInProgressReason = "ScalingDown"

	// InitializedCondition shows if etcd cluster has been initialized, which is when the first etcd member has been initialized
	InitializedCondition clusterv1.ConditionType = "Initialized"

	// WaitingForEtcdadmInitReason shows that the first etcd member has not been created yet
	WaitingForEtcdadmInitReason = "WaitingForEtcdadmInit"

	// EtcdMachinesReadyCondition stores an aggregate status of all owned machines
	EtcdMachinesReadyCondition clusterv1.ConditionType = "EtcdMachinesReady"

	// EtcdClusterHasNoOutdatedMembersCondition indicates that all etcd members are up-to-date. NOTE: this includes even members present on Machines not owned by the
	// etcdadm cluster
	EtcdClusterHasNoOutdatedMembersCondition clusterv1.ConditionType = "EtcdClusterHasNoOutdatedMachines"

	// EtcdClusterHasOutdatedMembersReason shows that some of the etcd members are out-of-date
	EtcdClusterHasOutdatedMembersReason = "EtcdClusterHasOutdatedMachines"

	// EtcdEndpointsAvailable shows that all endpoints of the etcd cluster passed healthcheck and are available
	EtcdEndpointsAvailable = "EtcdEndpointsAvailable"

	// WaitingForEtcdadmEndpointsToPassHealthcheckReason shows that some of the etcd members are not ready yet
	WaitingForEtcdadmEndpointsToPassHealthcheckReason = "WaitingForEtcdadmEndpointsToPassHealthcheck"
)
View Source
const (
	UpgradeInProgressAnnotation = "etcdcluster.cluster.x-k8s.io/upgrading"

	// HealthCheckRetriesAnnotation allows users to configure healthcheck retries. When set to 0, it disables healthchecks.
	HealthCheckRetriesAnnotation = "etcdcluster.cluster.x-k8s.io/healthcheck-retries"

	// EtcdadmClusterFinalizer is the finalizer applied to EtcdadmCluster resources
	// by its managing controller.
	EtcdadmClusterFinalizer = "etcdcluster.cluster.x-k8s.io"
)

Variables

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

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

	Spec   EtcdadmClusterSpec   `json:"spec,omitempty"`
	Status EtcdadmClusterStatus `json:"status,omitempty"`
}

EtcdadmCluster is the Schema for the etcdadmclusters API

func (*EtcdadmCluster) DeepCopy

func (in *EtcdadmCluster) DeepCopy() *EtcdadmCluster

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

func (*EtcdadmCluster) DeepCopyInto

func (in *EtcdadmCluster) DeepCopyInto(out *EtcdadmCluster)

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

func (*EtcdadmCluster) DeepCopyObject

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

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

func (*EtcdadmCluster) Default

func (r *EtcdadmCluster) Default()

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

func (*EtcdadmCluster) GetConditions

func (in *EtcdadmCluster) GetConditions() clusterv1.Conditions

func (*EtcdadmCluster) Hub

func (*EtcdadmCluster) Hub()

Hub marks EtcdadmCluster as a conversion hub.

func (*EtcdadmCluster) SetConditions

func (in *EtcdadmCluster) SetConditions(conditions clusterv1.Conditions)

func (*EtcdadmCluster) SetupWebhookWithManager

func (r *EtcdadmCluster) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*EtcdadmCluster) ValidateCreate

func (r *EtcdadmCluster) ValidateCreate() (admission.Warnings, error)

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

func (*EtcdadmCluster) ValidateDelete

func (r *EtcdadmCluster) ValidateDelete() (admission.Warnings, error)

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

func (*EtcdadmCluster) ValidateUpdate

func (r *EtcdadmCluster) ValidateUpdate(old runtime.Object) (admission.Warnings, error)

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

type EtcdadmClusterList

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

EtcdadmClusterList contains a list of EtcdadmCluster

func (*EtcdadmClusterList) DeepCopy

func (in *EtcdadmClusterList) DeepCopy() *EtcdadmClusterList

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

func (*EtcdadmClusterList) DeepCopyInto

func (in *EtcdadmClusterList) DeepCopyInto(out *EtcdadmClusterList)

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

func (*EtcdadmClusterList) DeepCopyObject

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

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

func (*EtcdadmClusterList) Hub

func (*EtcdadmClusterList) Hub()

Hub marks EtcdadmClusterList as a conversion hub.

type EtcdadmClusterSpec

type EtcdadmClusterSpec struct {
	Replicas *int32 `json:"replicas,omitempty"`

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

	// +optional
	EtcdadmConfigSpec etcdbp.EtcdadmConfigSpec `json:"etcdadmConfigSpec"`
}

EtcdadmClusterSpec defines the desired state of EtcdadmCluster

func (*EtcdadmClusterSpec) DeepCopy

func (in *EtcdadmClusterSpec) DeepCopy() *EtcdadmClusterSpec

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

func (*EtcdadmClusterSpec) DeepCopyInto

func (in *EtcdadmClusterSpec) DeepCopyInto(out *EtcdadmClusterSpec)

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

type EtcdadmClusterStatus

type EtcdadmClusterStatus struct {

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

	// +optional
	InitMachineAddress string `json:"initMachineAddress"`

	// +optional
	Initialized bool `json:"initialized"`

	// Ready reflects the state of the etcd cluster, whether all of its members have passed healthcheck and are ready to serve requests or not.
	// +optional
	Ready bool `json:"ready"`

	// CreationComplete gets set to true once the etcd cluster is created. Its value never changes after that.
	// It is used as a way to indicate that the periodic healthcheck loop can be run for the particular etcd cluster.
	// +optional
	CreationComplete bool `json:"creationComplete"`

	// +optional
	Endpoints string `json:"endpoints"`

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

	// ObservedGeneration is the latest generation observed by the controller.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// Conditions defines current service state of the EtcdadmCluster.
	// +optional
	Conditions clusterv1.Conditions `json:"conditions,omitempty"`
}

EtcdadmClusterStatus defines the observed state of EtcdadmCluster

func (*EtcdadmClusterStatus) DeepCopy

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

func (*EtcdadmClusterStatus) DeepCopyInto

func (in *EtcdadmClusterStatus) DeepCopyInto(out *EtcdadmClusterStatus)

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

Jump to

Keyboard shortcuts

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