typo fix

Signed-off-by: Tom <[email protected]>
kurator-dev · Aug 23, 2024 · d44fda8 · d44fda8
1 parent 53bb9a4
commit d44fda8
Show file tree

Hide file tree

Showing 33 changed files with 58 additions and 55 deletions.
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,3 @@
+[codespell]
+skip = .git,go.sum,go.mod,*.png,*.svg
+ignore-words-list = NotIn,te
diff --git a/cmd/kurator/app/pipeline/execution/logs/logs.go b/cmd/kurator/app/pipeline/execution/logs/logs.go
@@ -41,8 +41,8 @@ func NewCmd(opts *generic.Options) *cobra.Command {
 
 			PipelineList, err := logs.NewPipelineLogs(opts, &Args, pipelineExecutionName)
 			if err != nil {
-				logrus.Errorf("pipeline excution logs init error: %v", err)
-				return fmt.Errorf("pipeline excution logs init error: %v", err)
+				logrus.Errorf("pipeline execution logs init error: %v", err)
+				return fmt.Errorf("pipeline execution logs init error: %v", err)
 			}
 
 			logrus.Debugf("start logs pipeline execution obj, Global: %+v ", opts)

diff --git a/docs/content/en/docs/Integrations/pixie-vizier.md b/docs/content/en/docs/Integrations/pixie-vizier.md
@@ -39,8 +39,8 @@ Create a deployment key following the directions [here](https://docs.pixielabs.a
 
 Kurator provides a very simple command to install Pixie vizier to all clusters joined to karmada.
 
-- `--cloud-addr` sepcifies the address of the Pixie cloud instance that the vizier should be connected to.
-- `--deploy-key` sepcifies the deploy key is used to link the deployed vizier to a specific user/project.
+- `--cloud-addr` specifies the address of the Pixie cloud instance that the vizier should be connected to.
+- `--deploy-key` specifies the deploy key is used to link the deployed vizier to a specific user/project.
 
 ```bash
 kurator install pixie vizier --deploy-key=<your_deploy_key>

diff --git a/docs/content/en/docs/fleet-manager/_index.md b/docs/content/en/docs/fleet-manager/_index.md
@@ -31,4 +31,4 @@ The overall architecture of Kurator fleet manager is shown as below:
     >}}
 
 
-The Kurator Fleet Manager runs as a kubernetes operator, it is in charge of fleet control plane lifecycle management and also responsible for cluster registeration and un registration.
+The Kurator Fleet Manager runs as a kubernetes operator, it is in charge of fleet control plane lifecycle management and also responsible for cluster registration and un registration.
diff --git a/docs/content/en/docs/fleet-manager/application.md b/docs/content/en/docs/fleet-manager/application.md
@@ -247,7 +247,7 @@ kubectl get po -A --kubeconfig=/root/.kube/kurator-member2.config
 
 Upon examining the respective clusters, you'll find that applications originating from the same source configuration have been distributed to different clusters based on their respective policy selector labels.
 
-## Playgroud
+## Playground
 
 Kurator uses killercoda to provide [applications demo](https://killercoda.com/965010e0-4f60-4a28-bf27-597d3kurator/scenario/application-example), allowing users to experience hands-on operations.
 

diff --git a/docs/content/en/docs/fleet-manager/distributedstorage-plugin.md b/docs/content/en/docs/fleet-manager/distributedstorage-plugin.md
@@ -125,7 +125,7 @@ rook-ceph-rgw-ceph-objectstore-a-5c4df48bbb-bf6jn                   2/2     Runn
 
 ## Persistent Volume Use Guide
 
-After rook opeartor and rook ceph cluster are installed, this chapter provides examples of using Block Storage, Filesystem Storage and Object Storage.
+After rook operator and rook ceph cluster are installed, this chapter provides examples of using Block Storage, Filesystem Storage and Object Storage.
 
 ### Block Storage Class Configuration
 
@@ -168,8 +168,8 @@ allowVolumeExpansion: true
 There are a few things to note in the above block storage class configuration:
 
 - provisioner is configured in the format (operator-namespace).rbd.csi.ceph.com. Change "rook-ceph" provisioner prefix to match the operator namespace if needed.
-- `parametes.clusterID` is the namespace where the rook cluster is running.
-- `parametes.pool` is the `CephBlockPool` created before.
+- `parameters.clusterID` is the namespace where the rook cluster is running.
+- `parameters.pool` is the `CephBlockPool` created before.
 
 ### FileSystem Storage Class Configuration
 

diff --git a/docs/content/en/docs/fleet-manager/manage-attachedcluster.md b/docs/content/en/docs/fleet-manager/manage-attachedcluster.md
@@ -15,7 +15,7 @@ This guide will walk you through the process of creating AttachedCluster resourc
 
 ### Cluster operator
 
-As the AttachedCluster object is controlled by the cluster-operator, you need to first go to [Install cluser operator](/docs/setup/install-cluster-operator) page to create clusters using `hack/local-dev-setup.sh` and install cluster operator.
+As the AttachedCluster object is controlled by the cluster-operator, you need to first go to [Install cluster operator](/docs/setup/install-cluster-operator) page to create clusters using `hack/local-dev-setup.sh` and install cluster operator.
 
 ### AttachedCluster secrets
 

diff --git a/docs/content/en/docs/fleet-manager/rollout/abtest.md b/docs/content/en/docs/fleet-manager/rollout/abtest.md
@@ -400,7 +400,7 @@ An A/B Testing is triggered by changes in any of the following objects:
 If you only need to remove the Rollout Policy, simply edit the current application and remove the corresponding description:
 
 ```console
-kubectl edit applicaiton abtesting-demo
+kubectl edit application abtesting-demo
 ```
 
 To check the results of the deletion, you can observe that the rollout-related pods have been removed:
@@ -414,7 +414,7 @@ If you want to configure an A/B Testing for it again, you can simply edit the ap
 
 ### 2.Cleanup the Application
 
-When the application is delete, all associated resources will also be reomved:
+When the application is delete, all associated resources will also be removed:
 
 ```console
 kubectl delete application abtesting-demo

diff --git a/docs/content/en/docs/fleet-manager/rollout/blue-green.md b/docs/content/en/docs/fleet-manager/rollout/blue-green.md
@@ -459,7 +459,7 @@ rolloutStatus:
 If you only need to remove the Rollout Policy, simply edit the current application and remove the corresponding description:
 
 ```console
-kubectl edit applicaiton blue-green-demo
+kubectl edit application blue-green-demo
 ```
 
 To check the results of the deletion, you can observe that the rollout-related pods have been removed:
@@ -473,7 +473,7 @@ If you want to configure a Blue/Green Deployment for it again, you can simply ed
 
 ### 2.Cleanup the Application
 
-When the application is delete, all associated resources will also be reomved:
+When the application is delete, all associated resources will also be removed:
 
 ```console
 kubectl delete application abtesting-demo

diff --git a/docs/content/en/docs/fleet-manager/rollout/canary.md b/docs/content/en/docs/fleet-manager/rollout/canary.md
@@ -397,7 +397,7 @@ A canary deployment is triggered by changes in any of the following objects:
 If you only need to remove the Rollout Policy, simply edit the current application and remove the corresponding description:
 
 ```console
-kubectl edit applicaiton rollout-demo
+kubectl edit application rollout-demo
 ```
 
 To check the results of the deletion, you can observe that the rollout-related pods have been removed:
@@ -411,7 +411,7 @@ If you want to configure a canary deployment for it again, you can simply edit t
 
 ### 2.Cleanup the Application
 
-When the application is delete, all associated resources will also be reomved:
+When the application is delete, all associated resources will also be removed:
 
 ```console
 kubectl delete application rollout-demo

diff --git a/docs/content/en/docs/pipeline/setting.md b/docs/content/en/docs/pipeline/setting.md
@@ -14,7 +14,7 @@ This document provides a step-by-step guide to setting up your pipeline using Ku
 
 In the following guild, we use [Kind](https://kind.sigs.k8s.io/) clusters as examples.
 
-You need to first go to [Install cluser operator](/docs/setup/install-cluster-operator) page to create clusters using `hack/local-dev-setup.sh` and install cluster operator.
+You need to first go to [Install cluster operator](/docs/setup/install-cluster-operator) page to create clusters using `hack/local-dev-setup.sh` and install cluster operator.
 We use the host cluster `kurator-host`, where kubeconfig is located in `/root/.kube/kurator-host.config`
 Besides, you need setup Fleet manager by following the instructions in the [installation guide](/docs/setup/install-fleet-manager/).
 

diff --git a/docs/content/en/references/apps_v1alpha1_types.html b/docs/content/en/references/apps_v1alpha1_types.html
@@ -103,7 +103,7 @@ <h3 id="apps.kurator.dev/v1alpha1.Application">Application
 <td>
 <em>(Optional)</em>
 <p>Destination defines the destination clusters where the artifacts will be synced.
-It can be overriden by the syncPolicies&rsquo; destination.</p>
+It can be overridden by the syncPolicies&rsquo; destination.</p>
 </td>
 </tr>
 </table>
@@ -346,7 +346,7 @@ <h3 id="apps.kurator.dev/v1alpha1.ApplicationSpec">ApplicationSpec
 <td>
 <em>(Optional)</em>
 <p>Destination defines the destination clusters where the artifacts will be synced.
-It can be overriden by the syncPolicies&rsquo; destination.</p>
+It can be overridden by the syncPolicies&rsquo; destination.</p>
 </td>
 </tr>
 </tbody>
@@ -2306,7 +2306,7 @@ <h3 id="apps.kurator.dev/v1alpha1.Webhook">Webhook
 </td>
 <td>
 <em>(Optional)</em>
-<p>Commands define to commends that executed by webhook.</p>
+<p>Commands define to commands that executed by webhook.</p>
 </td>
 </tr>
 </tbody>

diff --git a/docs/content/en/references/fleet_v1alpha1_types.html b/docs/content/en/references/fleet_v1alpha1_types.html
@@ -1430,7 +1430,7 @@ <h3 id="fleet.kurator.dev/v1alpha1.PluginConfig">PluginConfig
 </em>
 </td>
 <td>
-<p>Flagger defines the configuretion for the kurator rollout engine.</p>
+<p>Flagger defines the configuration for the kurator rollout engine.</p>
 </td>
 </tr>
 </tbody>

diff --git a/docs/proposals/rollout/rollout.md b/docs/proposals/rollout/rollout.md
@@ -439,7 +439,7 @@ type Webhook struct {
     // Defaults to 60
     TimeoutSeconds *int `json:"timeoutSeconds,omitempty"`
 
-    // Command defines to commends that executed by webhook.
+    // Command defines to commands that executed by webhook.
     // +optional
     Command []string `json:"command,omitempty"`
 }

diff --git a/hack/util.sh b/hack/util.sh
@@ -98,7 +98,7 @@ function util::wait_file_exist() {
 }
 
 # util::wait_pod_ready waits for pod state becomes ready until timeout.
-# Parmeters:
+# Parameters:
 #  - $1: pod label, such as "app=etcd"
 #  - $2: pod namespace, such as "karmada-system"
 #  - $3: time out, such as "200s"
@@ -121,7 +121,7 @@ function util::wait_pod_ready() {
 }
 
 # util::wait_apiservice_ready waits for apiservice state becomes Available until timeout.
-# Parmeters:
+# Parameters:
 #  - $1: apiservice label, such as "app=etcd"
 #  - $3: time out, such as "200s"
 function util::wait_apiservice_ready() {
@@ -141,7 +141,7 @@ function util::wait_apiservice_ready() {
 
 # util::create_cluster creates a kubernetes cluster
 # util::create_cluster creates a kind cluster and don't wait for control plane node to be ready.
-# Parmeters:
+# Parameters:
 #  - $1: cluster name, such as "host"
 #  - $2: KUBECONFIG file, such as "/var/run/host.config"
 #  - $3: node docker image to use for booting the cluster, such as "kindest/node:v1.19.1"

diff --git a/manifests/charts/cluster-operator/crds/kubeadmconfigs.bootstrap.cluster.x-k8s.io.yaml b/manifests/charts/cluster-operator/crds/kubeadmconfigs.bootstrap.cluster.x-k8s.io.yaml
@@ -616,7 +616,7 @@ spec:
                       criSocket:
                         description: CRISocket is used to retrieve container runtime
                           info. This information will be annotated to the Node API
-                          object, for later re-use
+                          object, for later reuse
                         type: string
                       ignorePreflightErrors:
                         description: IgnorePreflightErrors provides a slice of pre-flight
@@ -722,7 +722,7 @@ spec:
                     type: string
                   caCertPath:
                     description: 'CACertPath is the path to the SSL certificate authority
-                      used to secure comunications between node and control-plane.
+                      used to secure communications between node and control-plane.
                       Defaults to "/etc/kubernetes/pki/ca.crt". TODO: revisit when
                       there is defaulting from k/k'
                     type: string
@@ -827,7 +827,7 @@ spec:
                       criSocket:
                         description: CRISocket is used to retrieve container runtime
                           info. This information will be annotated to the Node API
-                          object, for later re-use
+                          object, for later reuse
                         type: string
                       ignorePreflightErrors:
                         description: IgnorePreflightErrors provides a slice of pre-flight

diff --git a/...fests/charts/cluster-operator/crds/kubeadmconfigtemplates.bootstrap.cluster.x-k8s.io.yaml b/...fests/charts/cluster-operator/crds/kubeadmconfigtemplates.bootstrap.cluster.x-k8s.io.yaml
@@ -655,7 +655,7 @@ spec:
                               criSocket:
                                 description: CRISocket is used to retrieve container
                                   runtime info. This information will be annotated
-                                  to the Node API object, for later re-use
+                                  to the Node API object, for later reuse
                                 type: string
                               ignorePreflightErrors:
                                 description: IgnorePreflightErrors provides a slice
@@ -769,7 +769,7 @@ spec:
                             type: string
                           caCertPath:
                             description: 'CACertPath is the path to the SSL certificate
-                              authority used to secure comunications between node
+                              authority used to secure communications between node
                               and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt".
                               TODO: revisit when there is defaulting from k/k'
                             type: string
@@ -881,7 +881,7 @@ spec:
                               criSocket:
                                 description: CRISocket is used to retrieve container
                                   runtime info. This information will be annotated
-                                  to the Node API object, for later re-use
+                                  to the Node API object, for later reuse
                                 type: string
                               ignorePreflightErrors:
                                 description: IgnorePreflightErrors provides a slice

diff --git a/...ests/charts/cluster-operator/crds/kubeadmcontrolplanes.controlplane.cluster.x-k8s.io.yaml b/...ests/charts/cluster-operator/crds/kubeadmcontrolplanes.controlplane.cluster.x-k8s.io.yaml
@@ -674,7 +674,7 @@ spec:
                           criSocket:
                             description: CRISocket is used to retrieve container runtime
                               info. This information will be annotated to the Node
-                              API object, for later re-use
+                              API object, for later reuse
                             type: string
                           ignorePreflightErrors:
                             description: IgnorePreflightErrors provides a slice of
@@ -786,7 +786,7 @@ spec:
                         type: string
                       caCertPath:
                         description: 'CACertPath is the path to the SSL certificate
-                          authority used to secure comunications between node and
+                          authority used to secure communications between node and
                           control-plane. Defaults to "/etc/kubernetes/pki/ca.crt".
                           TODO: revisit when there is defaulting from k/k'
                         type: string
@@ -894,7 +894,7 @@ spec:
                           criSocket:
                             description: CRISocket is used to retrieve container runtime
                               info. This information will be annotated to the Node
-                              API object, for later re-use
+                              API object, for later reuse
                             type: string
                           ignorePreflightErrors:
                             description: IgnorePreflightErrors provides a slice of

diff --git a/...rts/cluster-operator/crds/kubeadmcontrolplanetemplates.controlplane.cluster.x-k8s.io.yaml b/...rts/cluster-operator/crds/kubeadmcontrolplanetemplates.controlplane.cluster.x-k8s.io.yaml
@@ -689,7 +689,7 @@ spec:
                                   criSocket:
                                     description: CRISocket is used to retrieve container
                                       runtime info. This information will be annotated
-                                      to the Node API object, for later re-use
+                                      to the Node API object, for later reuse
                                     type: string
                                   ignorePreflightErrors:
                                     description: IgnorePreflightErrors provides a
@@ -807,7 +807,7 @@ spec:
                                 type: string
                               caCertPath:
                                 description: 'CACertPath is the path to the SSL certificate
-                                  authority used to secure comunications between node
+                                  authority used to secure communications between node
                                   and control-plane. Defaults to "/etc/kubernetes/pki/ca.crt".
                                   TODO: revisit when there is defaulting from k/k'
                                 type: string
@@ -925,7 +925,7 @@ spec:
                                   criSocket:
                                     description: CRISocket is used to retrieve container
                                       runtime info. This information will be annotated
-                                      to the Node API object, for later re-use
+                                      to the Node API object, for later reuse
                                     type: string
                                   ignorePreflightErrors:
                                     description: IgnorePreflightErrors provides a

diff --git a/manifests/charts/fleet-manager/crds/apps.kurator.dev_applications.yaml b/manifests/charts/fleet-manager/crds/apps.kurator.dev_applications.yaml
@@ -45,7 +45,7 @@ spec:
               destination:
                 description: |-
                   Destination defines the destination clusters where the artifacts will be synced.
-                  It can be overriden by the syncPolicies' destination.
+                  It can be overridden by the syncPolicies' destination.
                 properties:
                   clusterSelector:
                     description: |-
@@ -729,7 +729,7 @@ spec:
                               type: object
                             replace:
                               description: |-
-                                Replace tells the Helm install action to re-use the 'ReleaseName', but only
+                                Replace tells the Helm install action to reuse the 'ReleaseName', but only
                                 if that name is a deleted release which remains in the history.
                               type: boolean
                             skipCRDs:
@@ -1360,7 +1360,7 @@ spec:
                                   description: Webhook list for this traffic analysis
                                   properties:
                                     command:
-                                      description: Commands define to commends that
+                                      description: Commands define to commands that
                                         executed by webhook.
                                       items:
                                         type: string

diff --git a/manifests/charts/fleet-manager/crds/fleet.kurator.dev_fleets.yaml b/manifests/charts/fleet-manager/crds/fleet.kurator.dev_fleets.yaml
@@ -2462,7 +2462,7 @@ spec:
                     - storage
                     type: object
                   flagger:
-                    description: Flagger defines the configuretion for the kurator
+                    description: Flagger defines the configuration for the kurator
                       rollout engine.
                     properties:
                       chart:

diff --git a/...profiles/prom-thanos/setup/prometheus-operator-0alertmanagerCustomResourceDefinition.yaml b/...profiles/prom-thanos/setup/prometheus-operator-0alertmanagerCustomResourceDefinition.yaml
@@ -2639,7 +2639,7 @@ spec:
                           conditions:
                             description: Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
                             items:
-                              description: PersistentVolumeClaimCondition contails details about state of pvc
+                              description: PersistentVolumeClaimCondition contains details about state of pvc
                               properties:
                                 lastProbeTime:
                                   description: Last time we probed the condition.

diff --git a/...s/profiles/prom-thanos/setup/prometheus-operator-0prometheusCustomResourceDefinition.yaml b/...s/profiles/prom-thanos/setup/prometheus-operator-0prometheusCustomResourceDefinition.yaml
@@ -3975,7 +3975,7 @@ spec:
                           conditions:
                             description: Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
                             items:
-                              description: PersistentVolumeClaimCondition contails details about state of pvc
+                              description: PersistentVolumeClaimCondition contains details about state of pvc
                               properties:
                                 lastProbeTime:
                                   description: Last time we probed the condition.

diff --git a/.../profiles/prom-thanos/setup/prometheus-operator-0thanosrulerCustomResourceDefinition.yaml b/.../profiles/prom-thanos/setup/prometheus-operator-0thanosrulerCustomResourceDefinition.yaml
@@ -2801,7 +2801,7 @@ spec:
                           conditions:
                             description: Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'.
                             items:
-                              description: PersistentVolumeClaimCondition contails details about state of pvc
+                              description: PersistentVolumeClaimCondition contains details about state of pvc
                               properties:
                                 lastProbeTime:
                                   description: Last time we probed the condition.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,4 @@ The overall architecture of Kurator fleet manager is shown as below:
		>}}


		The Kurator Fleet Manager runs as a kubernetes operator, it is in charge of fleet control plane lifecycle management and also responsible for cluster registeration and un registration.
		The Kurator Fleet Manager runs as a kubernetes operator, it is in charge of fleet control plane lifecycle management and also responsible for cluster registration and un registration.
-Original file line number
+Diff line change
@@ Expand Up @@
     </em>
     </td>
     <td>
-    <p>Flagger defines the configuretion for the kurator rollout engine.</p>
+    <p>Flagger defines the configuration for the kurator rollout engine.</p>
     </td>
     </tr>
     </tbody>
@@ Expand Down @@