Merge pull request #5 from RainbowMango/pr_sync_9

Sync APIs from karmada repo based on v0.9.0

cluster/v1alpha1/types.go

@@ -79,6 +79,13 @@ type ClusterSpec struct {
 	Taints []corev1.Taint `json:"taints,omitempty"`
 }
 
+const (
+	// SecretTokenKey is the name of secret token key.
+	SecretTokenKey = "token"
+	// SecretCADataKey is the name of secret caBundle key.
+	SecretCADataKey = "caBundle"
+)
+
 // ClusterSyncMode describes the mode of synchronization between member cluster and karmada control plane.
 type ClusterSyncMode string
 

go.mod

@@ -1,6 +1,6 @@
 module github.com/karmada-io/api
 
-go 1.14
+go 1.16
 
 require (
 	k8s.io/api v0.21.3

policy/v1alpha1/replicascheduling_types.go

@@ -5,6 +5,7 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 // +genclient
 // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
 // +kubebuilder:resource:shortName=rsp
+// +kubebuilder:deprecatedversion
 
 // ReplicaSchedulingPolicy represents the policy that propagates total number of replicas for deployment.
 type ReplicaSchedulingPolicy struct {
@@ -45,6 +46,7 @@ type StaticClusterWeight struct {
 	TargetCluster ClusterAffinity `json:"targetCluster"`
 
 	// Weight expressing the preference to the cluster(s) specified by 'TargetCluster'.
+	// +kubebuilder:validation:Minimum=1
 	// +required
 	Weight int64 `json:"weight"`
 }

work/v1alpha2/binding_types.go

@@ -0,0 +1,179 @@
+package v1alpha2
+
+import (
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+)
+
+// +genclient
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:subresource:status
+// +kubebuilder:resource:shortName=rb
+// +kubebuilder:storageversion
+
+// ResourceBinding represents a binding of a kubernetes resource with a propagation policy.
+type ResourceBinding struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// Spec represents the desired behavior.
+	Spec ResourceBindingSpec `json:"spec"`
+
+	// Status represents the most recently observed status of the ResourceBinding.
+	// +optional
+	Status ResourceBindingStatus `json:"status,omitempty"`
+}
+
+// ResourceBindingSpec represents the expectation of ResourceBinding.
+type ResourceBindingSpec struct {
+	// Resource represents the Kubernetes resource to be propagated.
+	Resource ObjectReference `json:"resource"`
+
+	// ReplicaRequirements represents the requirements required by each replica.
+	// +optional
+	ReplicaRequirements *ReplicaRequirements `json:"replicaRequirements,omitempty"`
+
+	// Replicas represents the replica number of the referencing resource.
+	// +optional
+	Replicas int32 `json:"replicas,omitempty"`
+
+	// Clusters represents target member clusters where the resource to be deployed.
+	// +optional
+	Clusters []TargetCluster `json:"clusters,omitempty"`
+}
+
+// ObjectReference contains enough information to locate the referenced object inside current cluster.
+type ObjectReference struct {
+	// APIVersion represents the API version of the referent.
+	APIVersion string `json:"apiVersion"`
+
+	// Kind represents the Kind of the referent.
+	Kind string `json:"kind"`
+
+	// Namespace represents the namespace for the referent.
+	// For non-namespace scoped resources(e.g. 'ClusterRole')，do not need specify Namespace,
+	// and for namespace scoped resources, Namespace is required.
+	// If Namespace is not specified, means the resource is non-namespace scoped.
+	// +optional
+	Namespace string `json:"namespace,omitempty"`
+
+	// Name represents the name of the referent.
+	Name string `json:"name"`
+
+	// ResourceVersion represents the internal version of the referenced object, that can be used by clients to
+	// determine when object has changed.
+	// +optional
+	ResourceVersion string `json:"resourceVersion,omitempty"`
+}
+
+// ReplicaRequirements represents the requirements required by each replica.
+type ReplicaRequirements struct {
+	// NodeClaim represents the node claim HardNodeAffinity, NodeSelector and Tolerations required by each replica.
+	// +optional
+	NodeClaim *NodeClaim `json:"nodeClaim,omitempty"`
+
+	// ResourceRequest represents the resources required by each replica.
+	// +optional
+	ResourceRequest corev1.ResourceList `json:"resourceRequest,omitempty"`
+}
+
+// NodeClaim represents the node claim HardNodeAffinity, NodeSelector and Tolerations required by each replica.
+type NodeClaim struct {
+	// A node selector represents the union of the results of one or more label queries over a set of
+	// nodes; that is, it represents the OR of the selectors represented by the node selector terms.
+	// Note that only PodSpec.Affinity.NodeAffinity.RequiredDuringSchedulingIgnoredDuringExecution
+	// is included here because it has a hard limit on pod scheduling.
+	// +optional
+	HardNodeAffinity *corev1.NodeSelector `json:"hardNodeAffinity,omitempty"`
+	// NodeSelector is a selector which must be true for the pod to fit on a node.
+	// Selector which must match a node's labels for the pod to be scheduled on that node.
+	// +optional
+	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
+	// If specified, the pod's tolerations.
+	// +optional
+	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
+}
+
+// TargetCluster represents the identifier of a member cluster.
+type TargetCluster struct {
+	// Name of target cluster.
+	Name string `json:"name"`
+	// Replicas in target cluster
+	// +optional
+	Replicas int32 `json:"replicas,omitempty"`
+}
+
+// ResourceBindingStatus represents the overall status of the strategy as well as the referenced resources.
+type ResourceBindingStatus struct {
+	// Conditions contain the different condition statuses.
+	// +optional
+	Conditions []metav1.Condition `json:"conditions,omitempty"`
+	// AggregatedStatus represents status list of the resource running in each member cluster.
+	// +optional
+	AggregatedStatus []AggregatedStatusItem `json:"aggregatedStatus,omitempty"`
+}
+
+// AggregatedStatusItem represents status of the resource running in a member cluster.
+type AggregatedStatusItem struct {
+	// ClusterName represents the member cluster name which the resource deployed on.
+	// +required
+	ClusterName string `json:"clusterName"`
+
+	// Status reflects running status of current manifest.
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +optional
+	Status *runtime.RawExtension `json:"status,omitempty"`
+	// Applied represents if the resource referencing by ResourceBinding or ClusterResourceBinding
+	// is successfully applied on the cluster.
+	// +optional
+	Applied bool `json:"applied,omitempty"`
+
+	// AppliedMessage is a human readable message indicating details about the applied status.
+	// This is usually holds the error message in case of apply failed.
+	// +optional
+	AppliedMessage string `json:"appliedMessage,omitempty"`
+}
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// ResourceBindingList contains a list of ResourceBinding.
+type ResourceBindingList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	// Items is the list of ResourceBinding.
+	Items []ResourceBinding `json:"items"`
+}
+
+// +genclient
+// +genclient:nonNamespaced
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+// +kubebuilder:resource:scope="Cluster",shortName=crb
+// +kubebuilder:subresource:status
+// +kubebuilder:storageversion
+
+// ClusterResourceBinding represents a binding of a kubernetes resource with a ClusterPropagationPolicy.
+type ClusterResourceBinding struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	// Spec represents the desired behavior.
+	Spec ResourceBindingSpec `json:"spec"`
+
+	// Status represents the most recently observed status of the ResourceBinding.
+	// +optional
+	Status ResourceBindingStatus `json:"status,omitempty"`
+}
+
+// +kubebuilder:resource:scope="Cluster"
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// ClusterResourceBindingList contains a list of ClusterResourceBinding.
+type ClusterResourceBindingList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+
+	// Items is the list of ClusterResourceBinding.
+	Items []ClusterResourceBinding `json:"items"`
+}

work/v1alpha2/doc.go

@@ -0,0 +1,4 @@
+// Package v1alpha2 is the v1alpha2 version of the API.
+// +k8s:deepcopy-gen=package,register
+// +groupName=work.karmada.io
+package v1alpha2

work/v1alpha2/well_known_labels.go

@@ -0,0 +1,18 @@
+package v1alpha2
+
+const (
+	// ResourceBindingNamespaceLabel is added to objects to specify associated ResourceBinding's namespace.
+	ResourceBindingNamespaceLabel = "resourcebinding.karmada.io/namespace"
+
+	// ResourceBindingNameLabel is added to objects to specify associated ResourceBinding's name.
+	ResourceBindingNameLabel = "resourcebinding.karmada.io/name"
+
+	// ClusterResourceBindingLabel is added to objects to specify associated ClusterResourceBinding.
+	ClusterResourceBindingLabel = "clusterresourcebinding.karmada.io/name"
+
+	// WorkNamespaceLabel is added to objects to specify associated Work's namespace.
+	WorkNamespaceLabel = "work.karmada.io/namespace"
+
+	// WorkNameLabel is added to objects to specify associated Work's name.
+	WorkNameLabel = "work.karmada.io/name"
+)