v1alpha1

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +k8s:deepcopy-gen=package,register +groupName=kubean.io

Index

• Constants
• Variables
• func Resource(resource string) schema.GroupResource
• type ActionSource
• type ActionType
• type ClusterOperation
  • func (in *ClusterOperation) DeepCopy() *ClusterOperation
  • func (in *ClusterOperation) DeepCopyInto(out *ClusterOperation)
  • func (in *ClusterOperation) DeepCopyObject() runtime.Object
• type ClusterOperationList
  • func (in *ClusterOperationList) DeepCopy() *ClusterOperationList
  • func (in *ClusterOperationList) DeepCopyInto(out *ClusterOperationList)
  • func (in *ClusterOperationList) DeepCopyObject() runtime.Object
• type HookAction
  • func (in *HookAction) DeepCopy() *HookAction
  • func (in *HookAction) DeepCopyInto(out *HookAction)
• type OpsStatus
• type Spec
  • func (in *Spec) DeepCopy() *Spec
  • func (in *Spec) DeepCopyInto(out *Spec)
• type Status
  • func (in *Status) DeepCopy() *Status
  • func (in *Status) DeepCopyInto(out *Status)

Constants

const GroupName = "kubean.io"

GroupName specifies the group name used to register the objects.

Variables

var (
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	// Depreciated: use Install instead
	AddToScheme = localSchemeBuilder.AddToScheme
	Install     = localSchemeBuilder.AddToScheme
)

var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1alpha1"}

GroupVersion specifies the group and the version used to register the objects.

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

Functions

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ActionSource

type ActionSource string

const (
	BuiltinActionSource   ActionSource = "builtin"
	ConfigMapActionSource ActionSource = "configmap"
)

type ActionType

type ActionType string

const (
	PlaybookActionType ActionType = "playbook"
	ShellActionType    ActionType = "shell"
)

type ClusterOperation

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

	// +required
	Spec Spec `json:"spec"`

	// +optional
	Status Status `json:"status,omitempty"`
}

ClusterOperation represents the desire state and status of a member cluster.

func (*ClusterOperation) DeepCopy

func (in *ClusterOperation) DeepCopy() *ClusterOperation

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

func (*ClusterOperation) DeepCopyInto

func (in *ClusterOperation) DeepCopyInto(out *ClusterOperation)

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

func (*ClusterOperation) DeepCopyObject

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

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

type ClusterOperationList

type ClusterOperationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items holds a list of ClusterOperation.
	Items []ClusterOperation `json:"items"`
}

ClusterOperationList contains a list of member cluster.

func (*ClusterOperationList) DeepCopy

func (in *ClusterOperationList) DeepCopy() *ClusterOperationList

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

func (*ClusterOperationList) DeepCopyInto

func (in *ClusterOperationList) DeepCopyInto(out *ClusterOperationList)

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

func (*ClusterOperationList) DeepCopyObject

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

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

type HookAction

type HookAction struct {
	// +required
	ActionType ActionType `json:"actionType"`
	// +required
	Action string `json:"action"`
	// +optional
	// +kubebuilder:default="builtin"
	ActionSource *ActionSource `json:"actionSource"`
	// +optional
	ActionSourceRef *apis.ConfigMapRef `json:"actionSourceRef,omitempty"`
	// +optional
	ExtraArgs string `json:"extraArgs"`
}

func (*HookAction) DeepCopy

func (in *HookAction) DeepCopy() *HookAction

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

func (*HookAction) DeepCopyInto

func (in *HookAction) DeepCopyInto(out *HookAction)

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

type OpsStatus

type OpsStatus string

const (
	RunningStatus   OpsStatus = "Running"
	SucceededStatus OpsStatus = "Succeeded"
	FailedStatus    OpsStatus = "Failed"
	BlockedStatus   OpsStatus = "Blocked"
)

type Spec

type Spec struct {
	// Cluster the name of Cluster.kubean.io.
	// +required
	Cluster string `json:"cluster"`
	// HostsConfRef will be filled by operator when it performs backup.
	// +optional
	HostsConfRef *apis.ConfigMapRef `json:"hostsConfRef"`
	// VarsConfRef will be filled by operator when it performs backup.
	// +optional
	VarsConfRef *apis.ConfigMapRef `json:"varsConfRef,omitempty"`
	// SSHAuthRef will be filled by operator when it performs backup.
	// +optional
	SSHAuthRef *apis.SecretRef `json:"sshAuthRef,omitempty"`
	// +optional
	// EntrypointSHRef will be filled by operator when it renders entrypoint.sh.
	EntrypointSHRef *apis.ConfigMapRef `json:"entrypointSHRef,omitempty"`
	// +required
	ActionType ActionType `json:"actionType"`
	// +required
	Action string `json:"action"`
	// +optional
	// +kubebuilder:default="builtin"
	ActionSource *ActionSource `json:"actionSource"`
	// +optional
	ActionSourceRef *apis.ConfigMapRef `json:"actionSourceRef,omitempty"`
	// +optional
	ExtraArgs string `json:"extraArgs"`
	// +required
	BackoffLimit int `json:"backoffLimit"`
	// +required
	Image string `json:"image"`
	// +optional
	PreHook []HookAction `json:"preHook"`
	// +optional
	PostHook []HookAction `json:"postHook"`
	// +optional
	Resources corev1.ResourceRequirements `json:"resources"`
	// +optional
	ActiveDeadlineSeconds *int64 `json:"activeDeadlineSeconds,omitempty"`
}

Spec defines the desired state of a member cluster.

func (*Spec) DeepCopy

func (in *Spec) DeepCopy() *Spec

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

func (*Spec) DeepCopyInto

func (in *Spec) DeepCopyInto(out *Spec)

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

type Status

type Status struct {
	// +optional
	Action string `json:"action"`
	// +optional
	JobRef *apis.JobRef `json:"jobRef,omitempty"`
	// +optional
	Status OpsStatus `json:"status"`
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`
	// +optional
	EndTime *metav1.Time `json:"endTime,omitempty"`
	// Digest is used to avoid the change of clusterOps by others. it will be filled by operator. Do Not change this value.
	// +optional
	Digest string `json:"digest,omitempty"`
	// HasModified indicates the spec has been modified by others after created.
	// +optional
	HasModified bool `json:"hasModified,omitempty"`
}

Status contains information about the current status of a cluster operation job updated periodically by cluster controller.

func (*Status) DeepCopy

func (in *Status) DeepCopy() *Status

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

func (*Status) DeepCopyInto

func (in *Status) DeepCopyInto(out *Status)

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