Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the tower v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:defaulter-gen=TypeMeta +groupName=cluster.kubesphere.io
Index ¶
- Constants
- Variables
- func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
- func Resource(resource string) schema.GroupResource
- type Cluster
- type ClusterCondition
- type ClusterConditionType
- type ClusterList
- type ClusterSpec
- type ClusterStatus
- type Connection
- type ConnectionType
Constants ¶
const ( ResourceKindCluster = "Cluster" ResourcesSingularCluster = "cluster" ResourcesPluralCluster = "clusters" HostCluster = "cluster-role.kubesphere.io/host" // Description of which region the cluster been placed ClusterRegion = "cluster.kubesphere.io/region" // Name of the cluster group ClusterGroup = "cluster.kubesphere.io/group" Finalizer = "finalizer.cluster.kubesphere.io" )
Variables ¶
var ( // GroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "cluster.kubesphere.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func GetOpenAPIDefinitions ¶
func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
func Resource ¶
func Resource(resource string) schema.GroupResource
Types ¶
type Cluster ¶
type Cluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterSpec `json:"spec,omitempty"` Status ClusterStatus `json:"status,omitempty"` }
Cluster is the schema for the clusters API
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterCondition ¶
type ClusterCondition struct { // Type of the condition Type ClusterConditionType `json:"type"` // Status of the condition, one of True, False, Unknown. Status v1.ConditionStatus `json:"status"` // The last time this condition was updated. LastUpdateTime metav1.Time `json:"lastUpdateTime,omitempty"` // Last time the condition transitioned from one status to another. LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // The reason for the condition's last transition. Reason string `json:"reason,omitempty"` // A human readable message indicating details about the transition. Message string `json:"message,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 ( // Cluster agent is initialized and waiting for connecting ClusterInitialized ClusterConditionType = "Initialized" // Cluster agent is available ClusterAgentAvailable ClusterConditionType = "AgentAvailable" // Cluster has been one of federated clusters ClusterFederated ClusterConditionType = "Federated" // Cluster is all available for requests ClusterReady ClusterConditionType = "Ready" // Openpitrix runtime is created ClusterOpenPitrixRuntimeReady ClusterConditionType = "OpenPitrixRuntimeReady" )
type ClusterList ¶
type ClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Cluster `json:"items"` }
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 ClusterSpec ¶
type ClusterSpec struct { // Join cluster as a kubefed cluster JoinFederation bool `json:"joinFederation,omitempty"` // Desired state of the cluster Enable bool `json:"enable,omitempty"` // Provider of the cluster, this field is just for description Provider string `json:"provider,omitempty"` // Connection holds info to connect to the member cluster Connection Connection `json:"connection,omitempty"` }
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct { // Represents the latest available observations of a cluster's current state. Conditions []ClusterCondition `json:"conditions,omitempty"` // GitVersion of the kubernetes cluster, this field is populated by cluster controller KubernetesVersion string `json:"kubernetesVersion,omitempty"` // GitVersion of the /kapis/version api response, this field is populated by cluster controller KubeSphereVersion string `json:"kubeSphereVersion,omitempty"` // Count of the kubernetes cluster nodes // This field may not reflect the instant status of the cluster. NodeCount int `json:"nodeCount,omitempty"` // Zones are the names of availability zones in which the nodes of the cluster exist, e.g. 'us-east1-a'. // +optional Zones []string `json:"zones,omitempty"` // Region is the name of the region in which all of the nodes in the cluster exist. e.g. 'us-east1'. // +optional Region *string `json:"region,omitempty"` // Configz is status of components enabled in the member cluster. This is synchronized with member cluster // every amount of time, like 5 minutes. // +optional Configz map[string]bool `json:"configz,omitempty"` }
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Connection ¶
type Connection struct { // type defines how host cluster will connect to host cluster // ConnectionTypeDirect means direct connection, this requires // kubeconfig and kubesphere apiserver endpoint provided // ConnectionTypeProxy means using kubesphere proxy, no kubeconfig // or kubesphere apiserver endpoint required Type ConnectionType `json:"type,omitempty"` // KubeSphere API Server endpoint. Example: http://10.10.0.11:8080 // Should provide this field explicitly if connection type is direct. // Will be populated by ks-apiserver if connection type is proxy. KubeSphereAPIEndpoint string `json:"kubesphereAPIEndpoint,omitempty"` // Kubernetes API Server endpoint. Example: https://10.10.0.1:6443 // Should provide this field explicitly if connection type is direct. // Will be populated by ks-apiserver if connection type is proxy. KubernetesAPIEndpoint string `json:"kubernetesAPIEndpoint,omitempty"` // KubeConfig content used to connect to cluster api server // Should provide this field explicitly if connection type is direct. // Will be populated by ks-proxy if connection type is proxy. KubeConfig []byte `json:"kubeconfig,omitempty"` // Token used by agents of member cluster to connect to host cluster proxy. // This field is populated by apiserver only if connection type is proxy. Token string `json:"token,omitempty"` // KubeAPIServerPort is the port which listens for forwarding kube-apiserver traffic // Only applicable when connection type is proxy. KubernetesAPIServerPort uint16 `json:"kubernetesAPIServerPort,omitempty"` // KubeSphereAPIServerPort is the port which listens for forwarding kubesphere apigateway traffic // Only applicable when connection type is proxy. KubeSphereAPIServerPort uint16 `json:"kubesphereAPIServerPort,omitempty"` }
func (*Connection) DeepCopy ¶
func (in *Connection) DeepCopy() *Connection
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Connection.
func (*Connection) DeepCopyInto ¶
func (in *Connection) DeepCopyInto(out *Connection)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConnectionType ¶
type ConnectionType string
const ( ConnectionTypeDirect ConnectionType = "direct" ConnectionTypeProxy ConnectionType = "proxy" )