Update.

Signed-off-by: GitHub <[email protected]>

Author: xuezhaojun

cluster/v1/0000_00_clusters.open-cluster-management.io_managedclusters.crd.yaml

@@ -36,16 +36,17 @@ spec:
       openAPIV3Schema:
         description: "ManagedCluster represents the desired state and current status
           of a managed cluster. ManagedCluster is a cluster-scoped resource. The name
-          is the cluster UID. \n The cluster join process follows a double opt-in
-          process: \n 1. The agent on the managed cluster creates a CSR on the hub
-          with the cluster UID and agent name. 2. The agent on the managed cluster
-          creates a ManagedCluster on the hub. 3. The cluster admin on the hub approves
-          the CSR for the UID and agent name of the ManagedCluster. 4. The cluster
-          admin sets the spec.acceptClient of the ManagedCluster to true. 5. The cluster
-          admin on the managed cluster creates a credential of the kubeconfig for
-          the hub. \n Once the hub creates the cluster namespace, the Klusterlet agent
-          on the ManagedCluster pushes the credential to the hub to use against the
-          kube-apiserver of the ManagedCluster."
+          is the cluster UID. \n The cluster join process is a double opt-in process.
+          See the following join process steps: \n 1. The agent on the managed cluster
+          creates a CSR on the hub with the cluster UID and agent name. 2. The agent
+          on the managed cluster creates a ManagedCluster on the hub. 3. The cluster
+          admin on the hub cluster approves the CSR for the UID and agent name of
+          the ManagedCluster. 4. The cluster admin sets the spec.acceptClient of the
+          ManagedCluster to true. 5. The cluster admin on the managed cluster creates
+          a credential of the kubeconfig for the hub cluster. \n After the hub cluster
+          creates the cluster namespace, the klusterlet agent on the ManagedCluster
+          pushes the credential to the hub cluster to use against the kube-apiserver
+          of the ManagedCluster."
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

cluster/v1/types.go

@@ -16,20 +16,20 @@ import (
 // +kubebuilder:printcolumn:JSONPath=`.status.conditions[?(@.type=="ManagedClusterConditionAvailable")].status`,name="Available",type=string
 // +kubebuilder:printcolumn:JSONPath=`.metadata.creationTimestamp`,name="Age",type=date
 
-// ManagedCluster represents the desired state and current status of a managed
-// cluster. ManagedCluster is a cluster-scoped resource. The name is the cluster
-// UID.
+// ManagedCluster represents the desired state and current status
+// of a managed cluster. ManagedCluster is a cluster-scoped resource. The name
+// is the cluster UID.
 //
-// The cluster join process follows a double opt-in process:
+// The cluster join process is a double opt-in process. See the following join process steps:
 //
 // 1. The agent on the managed cluster creates a CSR on the hub with the cluster UID and agent name.
 // 2. The agent on the managed cluster creates a ManagedCluster on the hub.
-// 3. The cluster admin on the hub approves the CSR for the UID and agent name of the ManagedCluster.
+// 3. The cluster admin on the hub cluster approves the CSR for the UID and agent name of the ManagedCluster.
 // 4. The cluster admin sets the spec.acceptClient of the ManagedCluster to true.
-// 5. The cluster admin on the managed cluster creates a credential of the kubeconfig for the hub.
+// 5. The cluster admin on the managed cluster creates a credential of the kubeconfig for the hub cluster.
 //
-// Once the hub creates the cluster namespace, the Klusterlet agent on the ManagedCluster
-// pushes the credential to the hub to use against the kube-apiserver of the ManagedCluster.
+// After the hub cluster creates the cluster namespace, the klusterlet agent on the ManagedCluster pushes
+// the credential to the hub cluster to use against the kube-apiserver of the ManagedCluster.
 type ManagedCluster struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

cluster/v1/zz_generated.swagger_doc_generated.go

@@ -16,11 +16,11 @@ spec:
     schema:
       openAPIV3Schema:
         description: "PlacementDecision indicates a decision from a placement. PlacementDecision
-          should have a label cluster.open-cluster-management.io/placement={placement
-          name} to reference a certain placement. \n If a placement has spec.numberOfClusters
+          must have a cluster.open-cluster-management.io/placement={placement name}
+          label to reference a certain placement. \n If a placement has spec.numberOfClusters
           specified, the total number of decisions contained in the status.decisions
-          of PlacementDecisions should always equal NumberOfClusters; otherwise, the
-          total number of decisions should equal the number of ManagedClusters that
+          of PlacementDecisions must be the same as NumberOfClusters. Otherwise, the
+          total number of decisions must equal the number of ManagedClusters that
           match the placement requirements. \n Some of the decisions might be empty
           when there are not enough ManagedClusters to meet the placement requirements."
         properties:

cluster/v1beta1/0000_03_clusters.open-cluster-management.io_placementdecisions.crd.yaml

@@ -8,15 +8,14 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 // +kubebuilder:subresource:status
 
 // PlacementDecision indicates a decision from a placement.
-// PlacementDecision should have a label cluster.open-cluster-management.io/placement={placement name}
-// to reference a certain placement.
+// PlacementDecision must have a cluster.open-cluster-management.io/placement={placement name} label to reference a certain placement.
 //
 // If a placement has spec.numberOfClusters specified, the total number of decisions contained in
-// the status.decisions of PlacementDecisions should always equal NumberOfClusters; otherwise, the total
-// number of decisions should equal the number of ManagedClusters that match the placement requirements.
+// the status.decisions of PlacementDecisions must be the same as NumberOfClusters. Otherwise, the
+// total number of decisions must equal the number of ManagedClusters that
+// match the placement requirements.
 //
-// Some of the decisions might be empty when there are not enough ManagedClusters to meet the placement
-// requirements.
+// Some of the decisions might be empty when there are not enough ManagedClusters to meet the placement requirements.
 type PlacementDecision struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

cluster/v1beta1/types_placementdecision.go

@@ -25,18 +25,18 @@ spec:
     name: v1beta2
     schema:
       openAPIV3Schema:
-        description: "ManagedClusterSet defines a group of ManagedClusters that users'
-          workloads can run on. A workload can be defined to be deployed on a ManagedClusterSet,
-          which means: 1. The workload can run on any ManagedCluster in the ManagedClusterSet
-          2. The workload cannot run on any ManagedCluster outside the ManagedClusterSet
-          3. The service exposed by the workload can be shared in any ManagedCluster
-          in the ManagedClusterSet \n In order to assign a ManagedCluster to a certain
-          ManagedClusterSet, add a label with the name `cluster.open-cluster-management.io/clusterset`
-          on the ManagedCluster to refer to the ManagedClusterSet. The user is not
-          allowed to add/remove this label on a ManagedCluster unless they have an
-          RBAC rule to CREATE on a virtual subresource of managedclustersets/join.
-          In order to update this label, the user must have the permission on both
-          the old and new ManagedClusterSet."
+        description: "ManagedClusterSet defines a group of ManagedClusters that you
+          can run workloads on. You can define a workload to be deployed on a ManagedClusterSet.
+          See the following options  for the workload: - The workload can run on any
+          ManagedCluster in the ManagedClusterSet - The workload cannot run on any
+          ManagedCluster outside the ManagedClusterSet - The service exposed by the
+          workload can be shared in any ManagedCluster in the ManagedClusterSet \n
+          To assign a ManagedCluster to a certain ManagedClusterSet, add a label with
+          the name cluster.open-cluster-management.io/clusterset on the ManagedCluster
+          to refer to the ManagedClusterSet. You are not allowed to add or remove
+          this label on a ManagedCluster unless you have an RBAC rule to CREATE on
+          a virtual subresource of managedclustersets/join. To update this label,
+          you must have the permission on both the old and new ManagedClusterSet."
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

cluster/v1beta1/zz_generated.swagger_doc_generated.go

@@ -19,11 +19,11 @@ spec:
     schema:
       openAPIV3Schema:
         description: ManagedClusterSetBinding projects a ManagedClusterSet into a
-          certain namespace. A user is able to create a ManagedClusterSetBinding in
-          a namespace and bind it to a ManagedClusterSet if they have an RBAC rule
-          to CREATE on the virtual subresource of managedclustersets/bind. Workloads
-          created in the same namespace can only be distributed to ManagedClusters
-          in ManagedClusterSets that are bound in this namespace by higher-level controllers.
+          certain namespace. You can create a ManagedClusterSetBinding in a namespace
+          and bind it to a ManagedClusterSet if both have a RBAC rules to CREATE on
+          the virtual subresource of managedclustersets/bind. Workloads that you create
+          in the same namespace can only be distributed to ManagedClusters in ManagedClusterSets
+          that are bound in this namespace by higher-level controllers.
         properties:
           apiVersion:
             description: 'APIVersion defines the versioned schema of this representation

cluster/v1beta2/0000_00_clusters.open-cluster-management.io_managedclustersets.crd.yaml

@@ -16,17 +16,18 @@ const ClusterSetLabel = "cluster.open-cluster-management.io/clusterset"
 // +kubebuilder:printcolumn:name="Empty",type="string",JSONPath=".status.conditions[?(@.type==\"ClusterSetEmpty\")].status"
 // +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 
-// ManagedClusterSet defines a group of ManagedClusters that users' workloads can run on.
-// A workload can be defined to be deployed on a ManagedClusterSet, which means:
-//  1. The workload can run on any ManagedCluster in the ManagedClusterSet
-//  2. The workload cannot run on any ManagedCluster outside the ManagedClusterSet
-//  3. The service exposed by the workload can be shared in any ManagedCluster in the ManagedClusterSet
+// ManagedClusterSet defines a group of ManagedClusters that you can run
+// workloads on. You can define a workload to be deployed on a ManagedClusterSet. See the following options  for the workload:
+// - The workload can run on any ManagedCluster in the ManagedClusterSet
+// - The workload cannot run on any ManagedCluster outside the ManagedClusterSet
+// - The service exposed by the workload can be shared in any ManagedCluster in the ManagedClusterSet
 //
-// In order to assign a ManagedCluster to a certain ManagedClusterSet, add a label with the name
-// `cluster.open-cluster-management.io/clusterset` on the ManagedCluster to refer to the ManagedClusterSet.
-// The user is not allowed to add/remove this label on a ManagedCluster unless they have an RBAC rule to CREATE on
-// a virtual subresource of managedclustersets/join. In order to update this label, the user must have the permission
-// on both the old and new ManagedClusterSet.
+// To assign a ManagedCluster to a certain ManagedClusterSet, add a label with the name cluster.open-cluster-management.io/clusterset
+// on the ManagedCluster to refer to the ManagedClusterSet. You are not
+// allowed to add or remove this label on a ManagedCluster unless you have an
+// RBAC rule to CREATE on a virtual subresource of managedclustersets/join.
+// To update this label, you must have the permission on both
+// the old and new ManagedClusterSet.
 type ManagedClusterSet struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

cluster/v1beta2/0000_01_clusters.open-cluster-management.io_managedclustersetbindings.crd.yaml

@@ -11,11 +11,10 @@ import (
 // +kubebuilder:storageversion
 
 // ManagedClusterSetBinding projects a ManagedClusterSet into a certain namespace.
-// A user is able to create a ManagedClusterSetBinding in a namespace and bind it to a
-// ManagedClusterSet if they have an RBAC rule to CREATE on the virtual subresource of
-// managedclustersets/bind. Workloads created in the same namespace can only be
-// distributed to ManagedClusters in ManagedClusterSets that are bound in this namespace by
-// higher-level controllers.
+// You can create a ManagedClusterSetBinding in a namespace and bind it to a
+// ManagedClusterSet if both have a RBAC rules to CREATE on the virtual subresource of managedclustersets/bind.
+// Workloads that you create in the same namespace can only be distributed to ManagedClusters
+// in ManagedClusterSets that are bound in this namespace by higher-level controllers.
 type ManagedClusterSetBinding struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`