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 Cluster
  • func (in *Cluster) DeepCopy() *Cluster
  • func (in *Cluster) DeepCopyInto(out *Cluster)
  • func (in *Cluster) DeepCopyObject() runtime.Object
• type ClusterCondition
  • func (in *ClusterCondition) DeepCopy() *ClusterCondition
  • func (in *ClusterCondition) DeepCopyInto(out *ClusterCondition)
• type ClusterConditionType
• type ClusterList
  • func (in *ClusterList) DeepCopy() *ClusterList
  • func (in *ClusterList) DeepCopyInto(out *ClusterList)
  • func (in *ClusterList) DeepCopyObject() runtime.Object
• type Spec
  • func (spec *Spec) ConfigDataList() []*apis.ConfigMapRef
  • func (in *Spec) DeepCopy() *Spec
  • func (in *Spec) DeepCopyInto(out *Spec)
  • func (spec *Spec) SecretDataList() []*apis.SecretRef
• 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 Cluster

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

	Spec Spec `json:"spec"`

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

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

func (*Cluster) DeepCopy

func (in *Cluster) DeepCopy() *Cluster

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

func (*Cluster) DeepCopyInto

func (in *Cluster) DeepCopyInto(out *Cluster)

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

func (*Cluster) DeepCopyObject

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

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

type ClusterCondition

type ClusterCondition struct {
	// ClusterOps refers to the name of ClusterOperation.
	// +required
	ClusterOps string `json:"clusterOps"`
	// +optional
	Status ClusterConditionType `json:"status"`
	// +optional
	StartTime *metav1.Time `json:"startTime,omitempty"`
	// +optional
	EndTime *metav1.Time `json:"endTime,omitempty"`
}

func (*ClusterCondition) DeepCopy

func (in *ClusterCondition) DeepCopy() *ClusterCondition

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

func (*ClusterCondition) DeepCopyInto

func (in *ClusterCondition) DeepCopyInto(out *ClusterCondition)

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

type ClusterConditionType

type ClusterConditionType string

const (
	ClusterConditionCreating ClusterConditionType = "Running"

	ClusterConditionRunning ClusterConditionType = "Succeeded"

	ClusterConditionUpdating ClusterConditionType = "Failed"

	BlockedStatus ClusterConditionType = "Blocked"
)

type ClusterList

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

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

ClusterList contains a list of member cluster.

func (*ClusterList) DeepCopy

func (in *ClusterList) DeepCopy() *ClusterList

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

func (*ClusterList) DeepCopyInto

func (in *ClusterList) DeepCopyInto(out *ClusterList)

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

func (*ClusterList) DeepCopyObject

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

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

type Spec

type Spec struct {
	// HostsConfRef stores hosts.yml.
	// +required
	HostsConfRef *apis.ConfigMapRef `json:"hostsConfRef"`
	// VarsConfRef stores group_vars.yml.
	// +required
	VarsConfRef *apis.ConfigMapRef `json:"varsConfRef"`
	// KubeConfRef stores cluster kubeconfig.
	// +optional
	KubeConfRef *apis.ConfigMapRef `json:"kubeconfRef"`
	// SSHAuthRef stores ssh key and if it is empty ,then use sshpass.
	// +optional
	SSHAuthRef *apis.SecretRef `json:"sshAuthRef"`
	// +optional
	PreCheckRef *apis.ConfigMapRef `json:"preCheckRef"`
}

Spec defines the desired state of a member cluster.

func (*Spec) ConfigDataList

func (spec *Spec) ConfigDataList() []*apis.ConfigMapRef

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.

func (*Spec) SecretDataList

func (spec *Spec) SecretDataList() []*apis.SecretRef

type Status

type Status struct {
	Conditions []ClusterCondition `json:"conditions"`
}

Status contains information about the current status of a cluster 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.