From 496afdbad366a22a45d39a0bada6eb8e1623ff9c Mon Sep 17 00:00:00 2001 From: momantech Date: Wed, 17 Apr 2024 17:29:29 +0800 Subject: [PATCH] docs: delete duplicate words and revise the names of some methods delete duplicate words and revise the names of some methods Signed-off-by: momantech --- Documentation/CRDs/Cluster/network-providers.md | 2 +- Documentation/Storage-Configuration/NFS/nfs.md | 2 +- cmd/rook/util/cmdreporter.go | 2 +- pkg/daemon/util/cmdreporter.go | 2 +- pkg/operator/ceph/cluster/osd/key_rotation.go | 2 +- pkg/operator/ceph/cluster/osd/osd.go | 2 +- pkg/operator/ceph/cluster/osd/topology/topology.go | 2 +- pkg/operator/ceph/cluster/watcher.go | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/CRDs/Cluster/network-providers.md b/Documentation/CRDs/Cluster/network-providers.md index db83e7482..183cec22d 100644 --- a/Documentation/CRDs/Cluster/network-providers.md +++ b/Documentation/CRDs/Cluster/network-providers.md @@ -211,7 +211,7 @@ kubectl --namespace rook-ceph exec -it deploy/rook-ceph-operator -- rook multus Then, update the args in the [multus-validation](https://github.com/rook/rook/blob/master/deploy/examples/multus-validation.yaml) -job template. Minimally, add the NAD names(s) for public and/or cluster as needed and and then, +job template. Minimally, add the NAD names(s) for public and/or cluster as needed and then, create the job to validate the Multus configuration. If the tool fails, it will suggest what things may be preventing Multus networks from working diff --git a/Documentation/Storage-Configuration/NFS/nfs.md b/Documentation/Storage-Configuration/NFS/nfs.md index 21a1d940f..5d15154fb 100644 --- a/Documentation/Storage-Configuration/NFS/nfs.md +++ b/Documentation/Storage-Configuration/NFS/nfs.md @@ -10,7 +10,7 @@ filesystem storage from within the Kubernetes cluster via PVC while simultaneous via direct client connection from within or outside of the Kubernetes cluster. !!! warning - Simultaneous access to NFS storage from Pods and from from external clients complicates NFS user + Simultaneous access to NFS storage from Pods and from external clients complicates NFS user ID mapping significantly. Client IDs mapped from external clients will not be the same as the IDs associated with the NFS CSI driver, which mount exports for Kubernetes pods. diff --git a/cmd/rook/util/cmdreporter.go b/cmd/rook/util/cmdreporter.go index a693fceb0..0383381e0 100644 --- a/cmd/rook/util/cmdreporter.go +++ b/cmd/rook/util/cmdreporter.go @@ -44,7 +44,7 @@ reported, even if the command's return code is nonzero (failure). Run will terminate if the command could not be run for any reason or if there was an error storing the command results into the ConfigMap. An application label is applied to the ConfigMap. Run will also terminate if the label already -exists and has a different application's name name; this may indicate that +exists and has a different application's name; this may indicate that it is not safe for cmd-reporter to edit the ConfigMap.`, Args: cobra.NoArgs, Run: runCmdReporter, diff --git a/pkg/daemon/util/cmdreporter.go b/pkg/daemon/util/cmdreporter.go index f1cc77624..7ae64263e 100644 --- a/pkg/daemon/util/cmdreporter.go +++ b/pkg/daemon/util/cmdreporter.go @@ -133,7 +133,7 @@ func CmdReporterFlagArgumentToCommand(flagArg string) (cmd []string, args []stri // return an error if the command could not be run for any reason or if there was // an error storing the command results into the ConfigMap. An application label // is applied to the ConfigMap, and if the label already exists and has a -// different application's name name, this returns an error, as this may indicate +// different application's name, this returns an error, as this may indicate // that it is not safe for cmd-reporter to edit the ConfigMap. func (r *CmdReporter) Run() error { stdout, stderr, retcode, err := r.runCommand() diff --git a/pkg/operator/ceph/cluster/osd/key_rotation.go b/pkg/operator/ceph/cluster/osd/key_rotation.go index b1af021af..f9a427100 100644 --- a/pkg/operator/ceph/cluster/osd/key_rotation.go +++ b/pkg/operator/ceph/cluster/osd/key_rotation.go @@ -219,7 +219,7 @@ func (c *Cluster) makeKeyRotationCronJob(pvcName string, osd OSDInfo, osdProps o return cronJob, nil } -// reconcileKeyRotationCronJobs reconciles the key rotation cron jobs for the OSDs. +// reconcileKeyRotationCronJob reconciles the key rotation cron jobs for the OSDs. func (c *Cluster) reconcileKeyRotationCronJob() error { if !c.spec.Security.KeyRotation.Enabled { listOpts := metav1.ListOptions{LabelSelector: fmt.Sprintf("%s=%s", k8sutil.AppAttr, keyRotationCronJobAppName)} diff --git a/pkg/operator/ceph/cluster/osd/osd.go b/pkg/operator/ceph/cluster/osd/osd.go index 1c9b2b5c4..ae96ce125 100644 --- a/pkg/operator/ceph/cluster/osd/osd.go +++ b/pkg/operator/ceph/cluster/osd/osd.go @@ -824,7 +824,7 @@ func (c *Cluster) applyUpgradeOSDFunctionality() { } } -// replaceOSDForNewStore deletes an existing OSD deployment that does not not match the expected OSD backend store provided in the storage spec +// replaceOSDForNewStore deletes an existing OSD deployment that does not match the expected OSD backend store provided in the storage spec func (c *Cluster) replaceOSDForNewStore() error { if c.spec.Storage.Store.UpdateStore != OSDStoreUpdateConfirmation { logger.Debugf("no OSD migration to a new backend store is requested") diff --git a/pkg/operator/ceph/cluster/osd/topology/topology.go b/pkg/operator/ceph/cluster/osd/topology/topology.go index ab25bc173..a69552b14 100644 --- a/pkg/operator/ceph/cluster/osd/topology/topology.go +++ b/pkg/operator/ceph/cluster/osd/topology/topology.go @@ -46,7 +46,7 @@ const ( labelHostname = "kubernetes.io/hostname" ) -// ExtractTopologyFromLabels extracts rook topology from labels and returns a map from topology type to value +// ExtractOSDTopologyFromLabels extracts rook topology from labels and returns a map from topology type to value func ExtractOSDTopologyFromLabels(labels map[string]string) (map[string]string, string) { topology, topologyAffinity := extractTopologyFromLabels(labels) diff --git a/pkg/operator/ceph/cluster/watcher.go b/pkg/operator/ceph/cluster/watcher.go index 4f899450e..f16b0458e 100644 --- a/pkg/operator/ceph/cluster/watcher.go +++ b/pkg/operator/ceph/cluster/watcher.go @@ -79,7 +79,7 @@ func checkStorageForNode(cluster *cephv1.CephCluster) bool { return true } -// onK8sNodeAdd is triggered when a node is added in the Kubernetes cluster +// onK8sNode is triggered when a node is added in the Kubernetes cluster func (c *clientCluster) onK8sNode(ctx context.Context, object runtime.Object) bool { node, ok := object.(*corev1.Node) if !ok {