v1alpha1

package
v0.0.0-...-0d26b2d Latest Latest
Warning

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

 Go to latest Published: Nov 6, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

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

Index

Constants

View Source 
const (
	// OperationNameLabel is a label defined for allowing lookup of objects related
	// to one Operation.
	OperationNameLabel = "operator.kubeadm.x-k8s.io/operation"

	// OperationUIDLabel is a label defined for ensuring that objects related
	// to one Operation won't get mixed by chance.
	OperationUIDLabel = "operator.kubeadm.x-k8s.io/uid"

	// TaskGroupNameLabel is a label defined for allowing lookup of objects related
	// to one TaskGroup object.
	TaskGroupNameLabel = "operator.kubeadm.x-k8s.io/taskgroup"

	// TaskGroupOrderLabel is a label defined  allowing lookup of objects related
	// to one TaskGroup object by the TaskGroup sequential order
	// e.g. list of the Task related to the first TaskGroup.
	TaskGroupOrderLabel = "operator.kubeadm.x-k8s.io/order"
)
View Source 
const (
	// OperationExecutionModeAuto forces the kubeadm operator to automatically execute a new RuntimeTask/Command immediately
	// after the current RuntimeTask/Command is completed successfully.
	OperationExecutionModeAuto = OperationExecutionMode("Auto")

	// OperationExecutionModeControlled forces the kubeadm operator to pause immediately before executing a new
	// RuntimeTask/Command, so the user can check the RuntimeTask specification and decide if to proceed or not.
	OperationExecutionModeControlled = OperationExecutionMode("Controlled")

	// OperationExecutionModeDryRun forces the kubeadm operator to dry-run instead of actually executing RuntimeTasks/Commands.
	OperationExecutionModeDryRun = OperationExecutionMode("DryRun")

	// OperationExecutionModeUnknown is returned if the OperationExecutionMode cannot be determined.
	OperationExecutionModeUnknown = OperationExecutionMode("")
)
View Source 
const (
	// OperationPhasePending is the first state a Operation is assigned after being created.
	OperationPhasePending = OperationPhase("Pending")

	// OperationPhaseRunning is the Operation state when it has
	// started its actuation.
	OperationPhaseRunning = OperationPhase("Running")

	// OperationPhasePaused is the Operation state when it is paused.
	OperationPhasePaused = OperationPhase("Paused")

	// OperationPhaseSucceeded is the Operation state when all the
	// desired RuntimeTasks are succeeded.
	OperationPhaseSucceeded = OperationPhase("Succeeded")

	// OperationPhaseFailed is the Operation state when the system
	// might require user intervention.
	OperationPhaseFailed = OperationPhase("Failed")

	// OperationPhaseDeleted is the Operation state when the object
	// is deleted and ready to be garbage collected by the API Server.
	OperationPhaseDeleted = OperationPhase("Deleted")

	//OperationPhaseUnknown is returned if the Operation state cannot be determined.
	OperationPhaseUnknown = OperationPhase("")
)
View Source 
const (
	// RuntimeTaskPhasePending is the first state a RuntimeTask is assigned by
	// RuntimeTask controller after being created.
	RuntimeTaskPhasePending = RuntimeTaskPhase("Pending")

	// RuntimeTaskPhaseRunning is the RuntimeTask state when it has
	// started its actuation.
	RuntimeTaskPhaseRunning = RuntimeTaskPhase("Running")

	// RuntimeTaskPhasePaused is the RuntimeTask state when it is paused.
	RuntimeTaskPhasePaused = RuntimeTaskPhase("Paused")

	// RuntimeTaskPhaseSucceeded is the RuntimeTask state when it has
	// succeeded its actuation.
	RuntimeTaskPhaseSucceeded = RuntimeTaskPhase("Succeeded")

	// RuntimeTaskPhaseFailed is the RuntimeTask state when the system
	// might require user intervention.
	RuntimeTaskPhaseFailed = RuntimeTaskPhase("Failed")

	// RuntimeTaskPhaseDeleted is the RuntimeTask state when the object
	// is deleted and ready to be garbage collected by the API Server.
	RuntimeTaskPhaseDeleted = RuntimeTaskPhase("Deleted")

	//RuntimeTaskPhaseUnknown is returned if the RuntimeTask state cannot be determined.
	RuntimeTaskPhaseUnknown = RuntimeTaskPhase("")
)
View Source 
const (
	// RuntimeTaskRecoverySkippingFailedCommandStrategy forces the RuntimeTask operator to skip failed RuntimeTask/Command.
	RuntimeTaskRecoverySkippingFailedCommandStrategy = RuntimeTaskRecoveryStrategy("SkipFailedCommand")

	// RuntimeTaskRecoveryRetryingFailedCommandStrategy forces the RuntimeTask operator to retry the failed RuntimeTask/Command.
	RuntimeTaskRecoveryRetryingFailedCommandStrategy = RuntimeTaskRecoveryStrategy("RetryFailedCommand")

	// RuntimeTaskRecoveryUnknownStrategy is returned if the RuntimeTaskErrorRecoveryStrategy cannot be determined.
	RuntimeTaskRecoveryUnknownStrategy = RuntimeTaskRecoveryStrategy("")
)
View Source 
const (
	// RuntimeTaskGroupCreateSerialStrategy forces the RuntimeTaskGroup controller to create RuntimeTasks in sequential order.
	// New RuntimeTask are created only after the current RuntimeTime is completed successfully.
	RuntimeTaskGroupCreateSerialStrategy = RuntimeTaskGroupCreatePolicy("Serial")

	// RuntimeTaskGroupCreateUnknownStrategy is returned if the RuntimeTaskGroupCreatePolicy cannot be determined.
	RuntimeTaskGroupCreateUnknownStrategy = RuntimeTaskGroupCreatePolicy("")
)
View Source 
const (
	// RuntimeTaskGroupNodeFilterAll forces the RuntimeTaskGroup controller to use all the nodes
	// returned by the NodeSelector.
	RuntimeTaskGroupNodeFilterAll = RuntimeTaskGroupNodeFilter("All")

	// RuntimeTaskGroupNodeFilterHead forces the RuntimeTaskGroup controller to use only the first node
	// returned by the NodeSelector.
	RuntimeTaskGroupNodeFilterHead = RuntimeTaskGroupNodeFilter("Head")

	// RuntimeTaskGroupNodeFilterTail forces the RuntimeTaskGroup controller to use all the nodes
	// returned by the NodeSelector except the first one.
	RuntimeTaskGroupNodeFilterTail = RuntimeTaskGroupNodeFilter("Tail")

	// RuntimeTaskGroupNodeUnknownFilter is returned if the RuntimeTaskGroupNodeFilter cannot be determined.
	RuntimeTaskGroupNodeUnknownFilter = RuntimeTaskGroupNodeFilter("")
)
View Source 
const (
	// RuntimeTaskGroupPhasePending is the first state a RuntimeTaskGroup is assigned by
	// Operation controller after being created.
	RuntimeTaskGroupPhasePending = RuntimeTaskGroupPhase("Pending")

	// RuntimeTaskGroupPhaseRunning is the RuntimeTaskGroup state when it has
	// started its actuation.
	RuntimeTaskGroupPhaseRunning = RuntimeTaskGroupPhase("Running")

	// RuntimeTaskGroupPhasePaused is the RuntimeTaskGroup state when it is paused.
	RuntimeTaskGroupPhasePaused = RuntimeTaskGroupPhase("Paused")

	// RuntimeTaskGroupPhaseSucceeded is the RuntimeTaskGroup state when all the
	// RuntimeTasks are succeeded.
	RuntimeTaskGroupPhaseSucceeded = RuntimeTaskGroupPhase("Succeeded")

	// RuntimeTaskGroupPhaseFailed is the RuntimeTaskGroup state when the system
	// might require user intervention.
	RuntimeTaskGroupPhaseFailed = RuntimeTaskGroupPhase("Failed")

	// RuntimeTaskGroupPhaseDeleted is the RuntimeTaskGroup state when the object
	// is deleted and ready to be garbage collected by the API Server.
	RuntimeTaskGroupPhaseDeleted = RuntimeTaskGroupPhase("Deleted")

	//RuntimeTaskGroupPhaseUnknown is returned if the RuntimeTaskGroup state cannot be determined.
	RuntimeTaskGroupPhaseUnknown = RuntimeTaskGroupPhase("")
)

Variables

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

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

type CommandDescriptor struct {

	// +optional
	KubeadmRenewCertificates *KubeadmRenewCertsCommandSpec `json:"kubeadmRenewCertificates,omitempty"`

	// +optional
	KubeadmUpgradeApply *KubeadmUpgradeApplyCommandSpec `json:"kubeadmUpgradeApply,omitempty"`

	// +optional
	KubeadmUpgradeNode *KubeadmUpgradeNodeCommandSpec `json:"kubeadmUpgradeNode,omitempty"`

	// +optional
	Preflight *PreflightCommandSpec `json:"preflight,omitempty"`

	// +optional
	UpgradeKubeadm *UpgradeKubeadmCommandSpec `json:"upgradeKubeadm,omitempty"`

	// +optional
	UpgradeKubeletAndKubeactl *UpgradeKubeletAndKubeactlCommandSpec `json:"upgradeKubeletAndKubeactl,omitempty"`

	// +optional
	KubectlDrain *KubectlDrainCommandSpec `json:"kubectlDrain,omitempty"`

	// +optional
	KubectlUncordon *KubectlUncordonCommandSpec `json:"kubectlUncordon,omitempty"`

	// Pass provide a dummy command for testing the kubeadm-operator workflow.
	// +optional
	Pass *PassCommandSpec `json:"pass,omitempty"`

	// Fail provide a dummy command for testing the kubeadm-operator workflow.
	// +optional
	Fail *FailCommandSpec `json:"fail,omitempty"`

	// Wait pauses the execution on the next command for a given number of seconds.
	// +optional
	Wait *WaitCommandSpec `json:"wait,omitempty"`
}

CommandDescriptor represents a command to be performed. Only one of its members may be specified.

func (*CommandDescriptor) DeepCopy 

func (in *CommandDescriptor) DeepCopy() *CommandDescriptor

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

func (*CommandDescriptor) DeepCopyInto 

func (in *CommandDescriptor) DeepCopyInto(out *CommandDescriptor)

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

type CustomOperationSpec 

type CustomOperationSpec struct {
	// Workflow allows to define a custom list of RuntimeTaskGroup.
	Workflow []RuntimeTaskGroup `json:"workflow"`
}

CustomOperationSpec enable definition of custom list of RuntimeTaskGroup.

func (*CustomOperationSpec) DeepCopy 

func (in *CustomOperationSpec) DeepCopy() *CustomOperationSpec

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

func (*CustomOperationSpec) DeepCopyInto 

func (in *CustomOperationSpec) DeepCopyInto(out *CustomOperationSpec)

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

type FailCommandSpec 

type FailCommandSpec struct {
}

FailCommandSpec provide a dummy command for testing the kubeadm-operator workflow.

func (*FailCommandSpec) DeepCopy 

func (in *FailCommandSpec) DeepCopy() *FailCommandSpec

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

func (*FailCommandSpec) DeepCopyInto 

func (in *FailCommandSpec) DeepCopyInto(out *FailCommandSpec)

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

type KubeadmRenewCertsCommandSpec 

type KubeadmRenewCertsCommandSpec struct {
}

KubeadmRenewCertsCommandSpec provides...

func (*KubeadmRenewCertsCommandSpec) DeepCopy 

func (in *KubeadmRenewCertsCommandSpec) DeepCopy() *KubeadmRenewCertsCommandSpec

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

func (*KubeadmRenewCertsCommandSpec) DeepCopyInto 

func (in *KubeadmRenewCertsCommandSpec) DeepCopyInto(out *KubeadmRenewCertsCommandSpec)

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

type KubeadmUpgradeApplyCommandSpec 

type KubeadmUpgradeApplyCommandSpec struct {
}

KubeadmUpgradeApplyCommandSpec provides...

func (*KubeadmUpgradeApplyCommandSpec) DeepCopy 

func (in *KubeadmUpgradeApplyCommandSpec) DeepCopy() *KubeadmUpgradeApplyCommandSpec

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

func (*KubeadmUpgradeApplyCommandSpec) DeepCopyInto 

func (in *KubeadmUpgradeApplyCommandSpec) DeepCopyInto(out *KubeadmUpgradeApplyCommandSpec)

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

type KubeadmUpgradeNodeCommandSpec 

type KubeadmUpgradeNodeCommandSpec struct {
}

KubeadmUpgradeNodeCommandSpec provides...

func (*KubeadmUpgradeNodeCommandSpec) DeepCopy 

func (in *KubeadmUpgradeNodeCommandSpec) DeepCopy() *KubeadmUpgradeNodeCommandSpec

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

func (*KubeadmUpgradeNodeCommandSpec) DeepCopyInto 

func (in *KubeadmUpgradeNodeCommandSpec) DeepCopyInto(out *KubeadmUpgradeNodeCommandSpec)

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

type KubectlDrainCommandSpec 

type KubectlDrainCommandSpec struct {
}

KubectlDrainCommandSpec provides...

func (*KubectlDrainCommandSpec) DeepCopy 

func (in *KubectlDrainCommandSpec) DeepCopy() *KubectlDrainCommandSpec

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

func (*KubectlDrainCommandSpec) DeepCopyInto 

func (in *KubectlDrainCommandSpec) DeepCopyInto(out *KubectlDrainCommandSpec)

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

type KubectlUncordonCommandSpec 

type KubectlUncordonCommandSpec struct {
}

KubectlUncordonCommandSpec provides...

func (*KubectlUncordonCommandSpec) DeepCopy 

func (in *KubectlUncordonCommandSpec) DeepCopy() *KubectlUncordonCommandSpec

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

func (*KubectlUncordonCommandSpec) DeepCopyInto 

func (in *KubectlUncordonCommandSpec) DeepCopyInto(out *KubectlUncordonCommandSpec)

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

type Operation 

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

	Spec   OperationSpec   `json:"spec,omitempty"`
	Status OperationStatus `json:"status,omitempty"`
}

Operation is the Schema for the operations API

func (*Operation) DeepCopy 

func (in *Operation) DeepCopy() *Operation

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

func (*Operation) DeepCopyInto 

func (in *Operation) DeepCopyInto(out *Operation)

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

func (*Operation) DeepCopyObject 

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

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

type OperationExecutionMode 

type OperationExecutionMode string

OperationExecutionMode is a string representation of a RuntimeTaskGroup create policy.

type OperationList 

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

OperationList contains a list of Operation

func (*OperationList) DeepCopy 

func (in *OperationList) DeepCopy() *OperationList

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

func (*OperationList) DeepCopyInto 

func (in *OperationList) DeepCopyInto(out *OperationList)

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

func (*OperationList) DeepCopyObject 

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

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

type OperationPhase 

type OperationPhase string

OperationPhase is a string representation of a Operation Phase.

This type is a high-level indicator of the status of the Operation 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 Operation, and controllers should not use the Operation Phase field value when making decisions about what action to take.

Controllers should always look at the actual state of the Operation’s fields to make those decisions.

type OperationSpec 

type OperationSpec struct {
	// Paused indicates that the operation is paused.
	// +optional
	Paused bool `json:"paused,omitempty"`

	// ExecutionMode indicates how the controller should handle RuntimeTask/Command execution for this operation.
	// If missing, auto mode will be used.
	// +optional
	ExecutionMode string `json:"executionMode,omitempty"`

	// OperatorDescriptor provide description of the operator content
	OperatorDescriptor `json:",inline"`
}

OperationSpec defines the spec of an Operation to be performed by the kubeadm-operator. Please note that once the operation will be completed, the operator will stop to reconcile on any instance of this object.

func (*OperationSpec) DeepCopy 

func (in *OperationSpec) DeepCopy() *OperationSpec

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

func (*OperationSpec) DeepCopyInto 

func (in *OperationSpec) DeepCopyInto(out *OperationSpec)

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

func (*OperationSpec) GetTypedOperationExecutionMode 

func (s *OperationSpec) GetTypedOperationExecutionMode() OperationExecutionMode

GetTypedOperationExecutionMode attempts to parse the ExecutionMode field and return the typed OperationExecutionMode representation.

type OperationStatus 

type OperationStatus struct {

	// StartTime represents time when the Operation execution was started by the controller.
	// It is represented in RFC3339 form and is in UTC.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// Paused indicates that the Operation is paused.
	// This fields is set when the OperationSpec.Paused value is processed by the controller.
	// +optional
	Paused bool `json:"paused,omitempty"`

	// CompletionTime represents time when the Operation was completed.
	// It is represented in RFC3339 form and is in UTC.
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Groups returns the number of RuntimeTaskGroups belonging to this operation.
	// +optional
	Groups int32 `json:"groups,omitempty"`

	// RunningGroups
	// +optional
	RunningGroups int32 `json:"runningGroups,omitempty"`

	// SucceededGroups return the number of RuntimeTaskGroups where all the RuntimeTask succeeded
	// +optional
	SucceededGroups int32 `json:"succeededGroups,omitempty"`

	// FailedGroups return the number of RuntimeTaskGroups with at least one RuntimeTask failure
	// +optional
	FailedGroups int32 `json:"failedGroups,omitempty"`

	// InvalidGroups return the number of RuntimeTaskGroups with at least one RuntimeTask inconsistencies like e.g. orphans
	// +optional
	InvalidGroups int32 `json:"invalidGroups,omitempty"`

	// Phase represents the current phase of Operation actuation.
	// E.g. pending, running, succeeded, failed etc.
	// +optional
	Phase string `json:"phase,omitempty"`

	// ErrorReason will be set in the event that there is a problem in executing
	// one of the Operation's RuntimeTasks and will contain a succinct value suitable
	// for machine interpretation.
	// +optional
	ErrorReason *operatorerrors.OperationStatusError `json:"errorReason,omitempty"`

	// ErrorMessage will be set in the event that there is a problem in executing
	// one of the Operation's RuntimeTasks and will contain a more verbose string suitable
	// for logging and human consumption.
	// +optional
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

OperationStatus defines the observed state of Operation

func (*OperationStatus) DeepCopy 

func (in *OperationStatus) DeepCopy() *OperationStatus

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

func (*OperationStatus) DeepCopyInto 

func (in *OperationStatus) DeepCopyInto(out *OperationStatus)

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

func (*OperationStatus) GetTypedPhase 

func (s *OperationStatus) GetTypedPhase() OperationPhase

GetTypedPhase attempts to parse the Phase field and return the typed OperationPhase representation.

func (*OperationStatus) ResetError 

func (s *OperationStatus) ResetError()

ResetError is a utility method for resetting the ErrorReason and ErrorMessage fields

func (*OperationStatus) SetCompletionTime 

func (s *OperationStatus) SetCompletionTime()

SetCompletionTime is a utility method for setting the CompletionTime field to Now.

func (*OperationStatus) SetError 

func (s *OperationStatus) SetError(err *operatorerrors.OperationError)

SetError is a utility method for setting the ErrorReason and ErrorMessage fields given an OperationError object.

func (*OperationStatus) SetStartTime 

func (s *OperationStatus) SetStartTime()

SetStartTime is a utility method for setting the StartTime field to Now.

func (*OperationStatus) SetTypedPhase 

func (s *OperationStatus) SetTypedPhase(p OperationPhase)

SetTypedPhase sets the Phase field to the string representation of OperationPhase.

type OperatorDescriptor 

type OperatorDescriptor struct {
	// Upgrade provide declarative support for the kubeadm upgrade workflow.
	// +optional
	Upgrade *UpgradeOperationSpec `json:"upgrade,omitempty"`

	// RenewCertificates provide declarative support for the kubeadm upgrade workflow.
	// +optional
	RenewCertificates *RenewCertificatesOperationSpec `json:"renewCertificates,omitempty"`

	// CustomOperation enable definition of custom list of RuntimeTaskGroup.
	// +optional
	CustomOperation *CustomOperationSpec `json:"custom,omitempty"`
}

OperatorDescriptor represents an operation to be performed. Only one of its members may be specified.

func (*OperatorDescriptor) DeepCopy 

func (in *OperatorDescriptor) DeepCopy() *OperatorDescriptor

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

func (*OperatorDescriptor) DeepCopyInto 

func (in *OperatorDescriptor) DeepCopyInto(out *OperatorDescriptor)

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

type PassCommandSpec 

type PassCommandSpec struct {
}

PassCommandSpec provide a dummy command for testing the kubeadm-operator workflow.

func (*PassCommandSpec) DeepCopy 

func (in *PassCommandSpec) DeepCopy() *PassCommandSpec

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

func (*PassCommandSpec) DeepCopyInto 

func (in *PassCommandSpec) DeepCopyInto(out *PassCommandSpec)

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

type PreflightCommandSpec 

type PreflightCommandSpec struct {
}

PreflightCommandSpec provides...

func (*PreflightCommandSpec) DeepCopy 

func (in *PreflightCommandSpec) DeepCopy() *PreflightCommandSpec

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

func (*PreflightCommandSpec) DeepCopyInto 

func (in *PreflightCommandSpec) DeepCopyInto(out *PreflightCommandSpec)

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

type RenewCertificatesOperationSpec 

type RenewCertificatesOperationSpec struct {
}

RenewCertificatesOperationSpec provide declarative support for the kubeadm upgrade workflow.

func (*RenewCertificatesOperationSpec) DeepCopy 

func (in *RenewCertificatesOperationSpec) DeepCopy() *RenewCertificatesOperationSpec

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

func (*RenewCertificatesOperationSpec) DeepCopyInto 

func (in *RenewCertificatesOperationSpec) DeepCopyInto(out *RenewCertificatesOperationSpec)

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

type RuntimeTask 

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

	Spec   RuntimeTaskSpec   `json:"spec,omitempty"`
	Status RuntimeTaskStatus `json:"status,omitempty"`
}

RuntimeTask is the Schema for the runtimetasks API

func (*RuntimeTask) DeepCopy 

func (in *RuntimeTask) DeepCopy() *RuntimeTask

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

func (*RuntimeTask) DeepCopyInto 

func (in *RuntimeTask) DeepCopyInto(out *RuntimeTask)

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

func (*RuntimeTask) DeepCopyObject 

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

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

type RuntimeTaskGroup 

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

	Spec   RuntimeTaskGroupSpec   `json:"spec,omitempty"`
	Status RuntimeTaskGroupStatus `json:"status,omitempty"`
}

RuntimeTaskGroup is the Schema for the runtimetaskgroups API

func (*RuntimeTaskGroup) DeepCopy 

func (in *RuntimeTaskGroup) DeepCopy() *RuntimeTaskGroup

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

func (*RuntimeTaskGroup) DeepCopyInto 

func (in *RuntimeTaskGroup) DeepCopyInto(out *RuntimeTaskGroup)

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

func (*RuntimeTaskGroup) DeepCopyObject 

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

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

type RuntimeTaskGroupCreatePolicy 

type RuntimeTaskGroupCreatePolicy string

RuntimeTaskGroupCreatePolicy is a string representation of a RuntimeTaskGroup create policy.

type RuntimeTaskGroupList 

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

RuntimeTaskGroupList contains a list of RuntimeTaskGroup

func (*RuntimeTaskGroupList) DeepCopy 

func (in *RuntimeTaskGroupList) DeepCopy() *RuntimeTaskGroupList

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

func (*RuntimeTaskGroupList) DeepCopyInto 

func (in *RuntimeTaskGroupList) DeepCopyInto(out *RuntimeTaskGroupList)

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

func (*RuntimeTaskGroupList) DeepCopyObject 

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

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

type RuntimeTaskGroupNodeFilter 

type RuntimeTaskGroupNodeFilter string

RuntimeTaskGroupNodeFilter is a string representation of a RuntimeTaskGroup node filter.

type RuntimeTaskGroupPhase 

type RuntimeTaskGroupPhase string

RuntimeTaskGroupPhase is a string representation of a RuntimeTaskGroup Phase.

This type is a high-level indicator of the status of the RuntimeTaskGroup 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 RuntimeTaskGroup, and controllers should not use the RuntimeTaskGroup Phase field value when making decisions about what action to take.

Controllers should always look at the actual state of the RuntimeTaskGroup’s fields to make those decisions.

type RuntimeTaskGroupSpec 

type RuntimeTaskGroupSpec struct {
	// NodeSelector is a label query that identifies the list of nodes that should be impacted by this RuntimeTaskGroup.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	NodeSelector metav1.LabelSelector `json:"nodeSelector,omitempty"`

	// NodeFilter allows to filter the list of nodes returned by the node selector.
	// It defaults to all.
	// +optional
	NodeFilter string `json:"nodeFilter,omitempty"`

	// Selector is a label query over RuntimeTasks that are generated by this RuntimeTaskGroup.
	// Label keys and values that must match in order to be controlled by this RuntimeTaskGroup.
	// It must match the RuntimeTask template's labels.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	Selector metav1.LabelSelector `json:"selector,omitempty"`

	// Template is the object that describes the RuntimeTask that will be created if
	// insufficient replicas are detected.
	// +optional
	Template RuntimeTaskTemplateSpec `json:"template,omitempty"`

	// CreateStrategy indicates how the controller should handle RuntimeTask creation for this RuntimeTaskGroup.
	// If missing, sequential mode will be used.
	// +optional
	CreateStrategy string `json:"createStrategy,omitempty"`
}

RuntimeTaskGroupSpec defines the RuntimeTask template that applies to a group of nodes that should be changed as part of an Operation. Please note that this is a runtime object, create with the goal to allow ensure orchestration of operation RuntimeTasks/Commands, and that this object will be deleted immediately after the operation completes. Users can refer to this object only in case of errors/for problem investigation.

func (*RuntimeTaskGroupSpec) DeepCopy 

func (in *RuntimeTaskGroupSpec) DeepCopy() *RuntimeTaskGroupSpec

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

func (*RuntimeTaskGroupSpec) DeepCopyInto 

func (in *RuntimeTaskGroupSpec) DeepCopyInto(out *RuntimeTaskGroupSpec)

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

func (*RuntimeTaskGroupSpec) GetTypedTaskGroupCreateStrategy 

func (s *RuntimeTaskGroupSpec) GetTypedTaskGroupCreateStrategy() RuntimeTaskGroupCreatePolicy

GetTypedTaskGroupCreateStrategy attempts to parse the CreateStrategy field and return the typed RuntimeTaskGroupCreatePolicy representation.

func (*RuntimeTaskGroupSpec) GetTypedTaskGroupNodeFilter 

func (s *RuntimeTaskGroupSpec) GetTypedTaskGroupNodeFilter() RuntimeTaskGroupNodeFilter

GetTypedTaskGroupNodeFilter attempts to parse the NodeFilter field and return the typed RuntimeTaskGroupNodeFilter representation.

type RuntimeTaskGroupStatus 

type RuntimeTaskGroupStatus struct {

	// StartTime represents time when the RuntimeTaskGroup execution was started by the controller.
	// It is represented in RFC3339 form and is in UTC.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// Paused indicates that the RuntimeTaskGroup is currently paused.
	// This fields is set when the OperationSpec.Paused value is processed by the controller.
	// +optional
	Paused bool `json:"paused,omitempty"`

	// CompletionTime represents time when the RuntimeTaskGroup was completed.
	// It is represented in RFC3339 form and is in UTC.
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Nodes
	// +optional
	Nodes int32 `json:"nodes,omitempty"`

	// RunningNodes
	// +optional
	RunningNodes int32 `json:"runningNodes,omitempty"`

	// SucceededNodes
	// +optional
	SucceededNodes int32 `json:"succeededNodes,omitempty"`

	// FailedNodes
	// +optional
	FailedNodes int32 `json:"failedNodes,omitempty"`

	// InvalidNodes
	// +optional
	InvalidNodes int32 `json:"invalidNodes,omitempty"`

	// Phase represents the current phase of RuntimeTaskGroup actuation.
	// E.g. pending, running, succeeded, failed etc.
	// +optional
	Phase string `json:"phase,omitempty"`

	// ErrorReason will be set in the event that there is a problem in executing
	// one of the RuntimeTaskGroup's RuntimeTasks and will contain a succinct value suitable
	// for machine interpretation.
	// +optional
	ErrorReason *operatorerrors.RuntimeTaskGroupStatusError `json:"errorReason,omitempty"`

	// ErrorMessage will be set in the event that there is a problem in executing
	// one of the RuntimeTaskGroup's RuntimeTasks and will contain a more verbose string suitable
	// for logging and human consumption.
	// +optional
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

RuntimeTaskGroupStatus defines the observed state of RuntimeTaskGroup

func (*RuntimeTaskGroupStatus) DeepCopy 

func (in *RuntimeTaskGroupStatus) DeepCopy() *RuntimeTaskGroupStatus

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

func (*RuntimeTaskGroupStatus) DeepCopyInto 

func (in *RuntimeTaskGroupStatus) DeepCopyInto(out *RuntimeTaskGroupStatus)

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

func (*RuntimeTaskGroupStatus) GetTypedPhase 

func (s *RuntimeTaskGroupStatus) GetTypedPhase() RuntimeTaskGroupPhase

GetTypedPhase attempts to parse the Phase field and return the typed RuntimeTaskGroupPhase representation.

func (*RuntimeTaskGroupStatus) ResetError 

func (s *RuntimeTaskGroupStatus) ResetError()

ResetError is a utility method for resetting the ErrorReason and ErrorMessage fields

func (*RuntimeTaskGroupStatus) SetCompletionTime 

func (s *RuntimeTaskGroupStatus) SetCompletionTime()

SetCompletionTime is a utility method for setting the CompletionTime field to Now.

func (*RuntimeTaskGroupStatus) SetError 

func (s *RuntimeTaskGroupStatus) SetError(err *operatorerrors.RuntimeTaskGroupError)

SetError is a utility method for setting the ErrorReason and ErrorMessage fields given a RuntimeTaskGroupError object.

func (*RuntimeTaskGroupStatus) SetStartTime 

func (s *RuntimeTaskGroupStatus) SetStartTime()

SetStartTime is a utility method for setting the StartTime field to Now.

func (*RuntimeTaskGroupStatus) SetTypedPhase 

func (s *RuntimeTaskGroupStatus) SetTypedPhase(p RuntimeTaskGroupPhase)

SetTypedPhase sets the Phase field to the string representation of RuntimeTaskGroupPhase.

type RuntimeTaskList 

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

RuntimeTaskList contains a list of RuntimeTask

func (*RuntimeTaskList) DeepCopy 

func (in *RuntimeTaskList) DeepCopy() *RuntimeTaskList

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

func (*RuntimeTaskList) DeepCopyInto 

func (in *RuntimeTaskList) DeepCopyInto(out *RuntimeTaskList)

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

func (*RuntimeTaskList) DeepCopyObject 

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

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

type RuntimeTaskPhase 

type RuntimeTaskPhase string

RuntimeTaskPhase is a string representation of a RuntimeTask Phase.

This type is a high-level indicator of the status of the RuntimeTask 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 RuntimeTask, and controllers should not use the RuntimeTask Phase field value when making decisions about what action to take.

Controllers should always look at the actual state of the RuntimeTask’s fields to make those decisions.

type RuntimeTaskRecoveryStrategy 

type RuntimeTaskRecoveryStrategy string

RuntimeTaskRecoveryStrategy is a string representation of a RuntimeTask error recovery policy.

type RuntimeTaskSpec 

type RuntimeTaskSpec struct {
	// NodeName is a request to schedule this RuntimeTask onto a specific node.
	// +optional
	NodeName string `json:"nodeName,omitempty"`

	// RecoveryMode sets the strategy to use when a command is failed.
	// +optional
	RecoveryMode string `json:"recoveryMode,omitempty"`

	// Commands provide the list of commands to be performed when executing a RuntimeTask on a node
	Commands []CommandDescriptor `json:"commands"`
}

RuntimeTaskSpec defines the desired state of RuntimeTask

func (*RuntimeTaskSpec) DeepCopy 

func (in *RuntimeTaskSpec) DeepCopy() *RuntimeTaskSpec

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

func (*RuntimeTaskSpec) DeepCopyInto 

func (in *RuntimeTaskSpec) DeepCopyInto(out *RuntimeTaskSpec)

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

func (*RuntimeTaskSpec) GetTypedTaskRecoveryStrategy 

func (s *RuntimeTaskSpec) GetTypedTaskRecoveryStrategy() RuntimeTaskRecoveryStrategy

GetTypedTaskRecoveryStrategy attempts to parse the mode field and return the typed RuntimeTaskRecoveryStrategy representation.

type RuntimeTaskStatus 

type RuntimeTaskStatus struct {

	// StartTime represents time when the RuntimeTask execution was started by the controller.
	// It is represented in RFC3339 form and is in UTC.
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`

	// CurrentCommand
	// +optional
	CurrentCommand int32 `json:"currentCommand,omitempty"`

	// CommandProgress
	// Please note that this field is only for allowing a better visal representation of status
	// +optional
	CommandProgress string `json:"commandProgress,omitempty"`

	// Paused indicates that the RuntimeTask is paused.
	// +optional
	Paused bool `json:"paused,omitempty"`

	// CompletionTime represents time when the RuntimeTask was completed.
	// It is represented in RFC3339 form and is in UTC.
	// +optional
	CompletionTime *metav1.Time `json:"completionTime,omitempty"`

	// Phase represents the current phase of RuntimeTask actuation.
	// E.g. Pending, Running, Completed, Failed etc.
	// +optional
	Phase string `json:"phase,omitempty"`

	// ErrorReason will be set in the event that there is a problem in executing
	// the RuntimeTasks and will contain a succinct value suitable
	// for machine interpretation.
	// +optional
	ErrorReason *operatorerrors.RuntimeTaskStatusError `json:"errorReason,omitempty"`

	// ErrorMessage will be set in the event that there is a problem in executing
	// the RuntimeTasks and will contain a more verbose string suitable
	// for logging and human consumption.
	// +optional
	ErrorMessage *string `json:"errorMessage,omitempty"`
}

RuntimeTaskStatus defines the observed state of RuntimeTask

func (*RuntimeTaskStatus) DeepCopy 

func (in *RuntimeTaskStatus) DeepCopy() *RuntimeTaskStatus

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

func (*RuntimeTaskStatus) DeepCopyInto 

func (in *RuntimeTaskStatus) DeepCopyInto(out *RuntimeTaskStatus)

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

func (*RuntimeTaskStatus) GetTypedPhase 

func (s *RuntimeTaskStatus) GetTypedPhase() RuntimeTaskPhase

GetTypedPhase attempts to parse the Phase field and return the typed RuntimeTaskPhase representation.

func (*RuntimeTaskStatus) NextCurrentCommand 

func (s *RuntimeTaskStatus) NextCurrentCommand(commands []CommandDescriptor)

NextCurrentCommand is a utility method for setting the CurrentCommand and CommandProgress.

func (*RuntimeTaskStatus) ResetError 

func (s *RuntimeTaskStatus) ResetError()

ResetError is a utility method for cleaning the ErrorReason and ErrorMessage fields

func (*RuntimeTaskStatus) SetCompletionTime 

func (s *RuntimeTaskStatus) SetCompletionTime()

SetCompletionTime is a utility method for setting the CompletionTime field to Now.

func (*RuntimeTaskStatus) SetError 

func (s *RuntimeTaskStatus) SetError(err *operatorerrors.RuntimeTaskError)

SetError is a utility method for setting the ErrorReason and ErrorMessage fields given a RuntimeTaskError object.

func (*RuntimeTaskStatus) SetStartTime 

func (s *RuntimeTaskStatus) SetStartTime()

SetStartTime is a utility method for setting the StartTime field to Now.

func (*RuntimeTaskStatus) SetTypedPhase 

func (s *RuntimeTaskStatus) SetTypedPhase(p RuntimeTaskPhase)

SetTypedPhase sets the Phase field to the string representation of RuntimeTaskPhase.

type RuntimeTaskTemplateSpec 

type RuntimeTaskTemplateSpec struct {
	// Standard object's metadata.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Specification of the desired behavior of the RuntimeTask.
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
	// +optional
	Spec RuntimeTaskSpec `json:"spec,omitempty"`
}

RuntimeTaskTemplateSpec defines the RuntimeTask that applies to a group of nodes that should be changed as part of an Operation.

func (*RuntimeTaskTemplateSpec) DeepCopy 

func (in *RuntimeTaskTemplateSpec) DeepCopy() *RuntimeTaskTemplateSpec

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

func (*RuntimeTaskTemplateSpec) DeepCopyInto 

func (in *RuntimeTaskTemplateSpec) DeepCopyInto(out *RuntimeTaskTemplateSpec)

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

type UpgradeKubeadmCommandSpec 

type UpgradeKubeadmCommandSpec struct {
}

UpgradeKubeadmCommandSpec provides...

func (*UpgradeKubeadmCommandSpec) DeepCopy 

func (in *UpgradeKubeadmCommandSpec) DeepCopy() *UpgradeKubeadmCommandSpec

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

func (*UpgradeKubeadmCommandSpec) DeepCopyInto 

func (in *UpgradeKubeadmCommandSpec) DeepCopyInto(out *UpgradeKubeadmCommandSpec)

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

type UpgradeKubeletAndKubeactlCommandSpec 

type UpgradeKubeletAndKubeactlCommandSpec struct {
}

UpgradeKubeletAndKubeactlCommandSpec provides...

func (*UpgradeKubeletAndKubeactlCommandSpec) DeepCopy 

func (in *UpgradeKubeletAndKubeactlCommandSpec) DeepCopy() *UpgradeKubeletAndKubeactlCommandSpec

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

func (*UpgradeKubeletAndKubeactlCommandSpec) DeepCopyInto 

func (in *UpgradeKubeletAndKubeactlCommandSpec) DeepCopyInto(out *UpgradeKubeletAndKubeactlCommandSpec)

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

type UpgradeOperationSpec 

type UpgradeOperationSpec struct {
	// KubernetesVersion specifies the target kubernetes version
	KubernetesVersion string `json:"kubernetesVersion"`
}

UpgradeOperationSpec provide declarative support for the kubeadm upgrade workflow.

func (*UpgradeOperationSpec) DeepCopy 

func (in *UpgradeOperationSpec) DeepCopy() *UpgradeOperationSpec

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

func (*UpgradeOperationSpec) DeepCopyInto 

func (in *UpgradeOperationSpec) DeepCopyInto(out *UpgradeOperationSpec)

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

type WaitCommandSpec 

type WaitCommandSpec struct {
	// Seconds to pause before next command.
	// +optional
	Seconds int32 `json:"seconds,omitempty"`
}

WaitCommandSpec pauses the execution on the next command for a given number of seconds.

func (*WaitCommandSpec) DeepCopy 

func (in *WaitCommandSpec) DeepCopy() *WaitCommandSpec

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

func (*WaitCommandSpec) DeepCopyInto 

func (in *WaitCommandSpec) DeepCopyInto(out *WaitCommandSpec)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.