Documentation
¶
Overview ¶
Package v1alpha2 is the v1alpha2 version of the API. +groupName=multicluster.crd.antrea.io
Package v1alpha2 contains API Schema definitions for the multicluster v1alpha2 API group +kubebuilder:object:generate=true +groupName=multicluster.crd.antrea.io
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type ClusterClaim
- type ClusterClaimList
- type ClusterCondition
- type ClusterConditionType
- type ClusterSet
- type ClusterSetCondition
- type ClusterSetConditionType
- type ClusterSetList
- type ClusterSetSpec
- type ClusterSetStatus
- type ClusterStatus
- type LeaderClusterInfo
Constants ¶
const ( // Identify this cluster. WellKnownClusterClaimID = "id.k8s.io" // Identify a ClusterSet that this cluster is a member of. WellKnownClusterClaimClusterSet = "clusterset.k8s.io" )
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "multicluster.crd.antrea.io", Version: "v1alpha2"} // 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 )
var SchemeGroupVersion = GroupVersion
SchemeGroupVersion is group version used to register these objects.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type ClusterClaim ¶
type ClusterClaim struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // Value of the ClusterClaim. // +kubebuilder:validation:Required Value string `json:"value"` }
+kubebuilder:printcolumn:name="Value",type=string,JSONPath=`.value`,description="Value of the ClusterClaim" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp` ClusterClaim is the Schema for the clusterclaims API.
func (*ClusterClaim) DeepCopy ¶
func (in *ClusterClaim) DeepCopy() *ClusterClaim
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterClaim.
func (*ClusterClaim) DeepCopyInto ¶
func (in *ClusterClaim) DeepCopyInto(out *ClusterClaim)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterClaim) DeepCopyObject ¶
func (in *ClusterClaim) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterClaimList ¶
type ClusterClaimList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ClusterClaim `json:"items"` }
ClusterClaimList contains a list of ClusterClaim
func (*ClusterClaimList) DeepCopy ¶
func (in *ClusterClaimList) DeepCopy() *ClusterClaimList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterClaimList.
func (*ClusterClaimList) DeepCopyInto ¶
func (in *ClusterClaimList) DeepCopyInto(out *ClusterClaimList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterClaimList) DeepCopyObject ¶
func (in *ClusterClaimList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterCondition ¶ added in v1.13.0
type ClusterCondition struct { Type ClusterConditionType `json:"type,omitempty"` // Status of the condition, one of True, False, Unknown. Status v1.ConditionStatus `json:"status,omitempty"` // +optional // Last time the condition transited from one status to another. LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // +optional // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` // +optional // Unique, one-word, CamelCase reason for the condition's last transition. Reason string `json:"reason,omitempty"` }
ClusterCondition indicates the readiness condition of a cluster.
func (*ClusterCondition) DeepCopy ¶ added in v1.13.0
func (in *ClusterCondition) DeepCopy() *ClusterCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterCondition.
func (*ClusterCondition) DeepCopyInto ¶ added in v1.13.0
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 ¶ added in v1.13.0
type ClusterConditionType string
const ( // ClusterReady indicates whether cluster is ready and connected. ClusterReady ClusterConditionType = "Ready" // ClusterIsLeader indicates whether the cluster is the leader of the local cluster. // Used in member clusters only. ClusterIsLeader ClusterConditionType = "IsLeader" // ClusterConnected indicates whether the member cluster has connected to the // local cluster as the leader. // Used in leader clusters only. ClusterConnected ClusterConditionType = "ClusterConnected" )
type ClusterSet ¶ added in v1.13.0
type ClusterSet struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ClusterSetSpec `json:"spec,omitempty"` Status ClusterSetStatus `json:"status,omitempty"` }
+kubebuilder:printcolumn:name="Leader Cluster Namespace",type=string,JSONPath=`.spec.namespace`,description="The leader cluster Namespace for the ClusterSet" +kubebuilder:printcolumn:name="Total Clusters",type=string,JSONPath=`.status.totalClusters`,description="Total number of clusters in the ClusterSet" +kubebuilder:printcolumn:name="Ready Clusters",type=string,JSONPath=`.status.readyClusters`,description="Number of ready clusters in the ClusterSet" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=`.metadata.creationTimestamp` ClusterSet represents a ClusterSet.
func (*ClusterSet) DeepCopy ¶ added in v1.13.0
func (in *ClusterSet) DeepCopy() *ClusterSet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSet.
func (*ClusterSet) DeepCopyInto ¶ added in v1.13.0
func (in *ClusterSet) DeepCopyInto(out *ClusterSet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterSet) DeepCopyObject ¶ added in v1.13.0
func (in *ClusterSet) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSetCondition ¶ added in v1.13.0
type ClusterSetCondition struct { Type ClusterSetConditionType `json:"type,omitempty"` // Status of the condition, one of True, False, Unknown. Status v1.ConditionStatus `json:"status,omitempty"` // +optional // Last time the condition transited from one status to another. LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty"` // +optional // A human readable message indicating details about the transition. Message string `json:"message,omitempty"` // +optional // Unique, one-word, CamelCase reason for the condition's last transition. Reason string `json:"reason,omitempty"` }
ClusterSetCondition indicates the readiness condition of the clusterSet.
func (*ClusterSetCondition) DeepCopy ¶ added in v1.13.0
func (in *ClusterSetCondition) DeepCopy() *ClusterSetCondition
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSetCondition.
func (*ClusterSetCondition) DeepCopyInto ¶ added in v1.13.0
func (in *ClusterSetCondition) DeepCopyInto(out *ClusterSetCondition)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterSetConditionType ¶ added in v1.13.0
type ClusterSetConditionType string
const ( // ClusterSetReady indicates whether ClusterSet is ready. ClusterSetReady ClusterSetConditionType = "Ready" )
type ClusterSetList ¶ added in v1.13.0
type ClusterSetList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ClusterSet `json:"items"` }
ClusterSetList contains a list of ClusterSet.
func (*ClusterSetList) DeepCopy ¶ added in v1.13.0
func (in *ClusterSetList) DeepCopy() *ClusterSetList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSetList.
func (*ClusterSetList) DeepCopyInto ¶ added in v1.13.0
func (in *ClusterSetList) DeepCopyInto(out *ClusterSetList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterSetList) DeepCopyObject ¶ added in v1.13.0
func (in *ClusterSetList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSetSpec ¶ added in v1.13.0
type ClusterSetSpec struct { // ClusterID identifies the local cluster. // +kubebuilder:validation:Required ClusterID string `json:"clusterID"` // Leaders include leader clusters known to the member clusters. // +kubebuilder:validation:MinItems=1 // +kubebuilder:validation:MaxItems=1 // +kubebuilder:validation:Required Leaders []LeaderClusterInfo `json:"leaders"` // The leader cluster Namespace in which the ClusterSet is defined. // Used in a member cluster. Namespace string `json:"namespace,omitempty"` }
ClusterSetSpec defines the desired state of ClusterSet.
func (*ClusterSetSpec) DeepCopy ¶ added in v1.13.0
func (in *ClusterSetSpec) DeepCopy() *ClusterSetSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSetSpec.
func (*ClusterSetSpec) DeepCopyInto ¶ added in v1.13.0
func (in *ClusterSetSpec) DeepCopyInto(out *ClusterSetSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterSetStatus ¶ added in v1.13.0
type ClusterSetStatus struct { // Total number of member clusters configured in the ClusterSet. TotalClusters int32 `json:"totalClusters,omitempty"` // Total number of clusters ready and connected. ReadyClusters int32 `json:"readyClusters,omitempty"` // The overall condition of the cluster set. Conditions []ClusterSetCondition `json:"conditions,omitempty"` // The status of individual member clusters. ClusterStatuses []ClusterStatus `json:"clusterStatuses,omitempty"` // The generation observed by the controller. ObservedGeneration int64 `json:"observedGeneration,omitempty"` }
ClusterSetStatus defines the observed state of ClusterSet.
func (*ClusterSetStatus) DeepCopy ¶ added in v1.13.0
func (in *ClusterSetStatus) DeepCopy() *ClusterSetStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSetStatus.
func (*ClusterSetStatus) DeepCopyInto ¶ added in v1.13.0
func (in *ClusterSetStatus) DeepCopyInto(out *ClusterSetStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶ added in v1.13.0
type ClusterStatus struct { // ClusterID is the unique identifier of this cluster. ClusterID string `json:"clusterID,omitempty"` Conditions []ClusterCondition `json:"conditions,omitempty"` }
func (*ClusterStatus) DeepCopy ¶ added in v1.13.0
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶ added in v1.13.0
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type LeaderClusterInfo ¶ added in v1.13.0
type LeaderClusterInfo struct { // Identify a leader cluster in the ClusterSet. ClusterID string `json:"clusterID,omitempty"` // API server endpoint of the leader cluster. // E.g. "https://172.18.0.1:6443", "https://example.com:6443". Server string `json:"server,omitempty"` // Name of the Secret resource in the member cluster, which stores // the token to access the leader cluster's API server. Secret string `json:"secret,omitempty"` // ServiceAccount in the leader cluster, from which the member cluster's token // is generated. This is an optional field which helps admin to check // which ServiceAccount is used by a member cluster to access the leader cluster. // // DEPRECATED // This field is planned to be removed in the future releases. ServiceAccount string `json:"serviceAccount,omitempty"` }
LeaderClusterInfo specifies information of a leader cluster.
func (*LeaderClusterInfo) DeepCopy ¶ added in v1.13.0
func (in *LeaderClusterInfo) DeepCopy() *LeaderClusterInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LeaderClusterInfo.
func (*LeaderClusterInfo) DeepCopyInto ¶ added in v1.13.0
func (in *LeaderClusterInfo) DeepCopyInto(out *LeaderClusterInfo)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.