From dcd4dfb2bd1fe8e64edf8e59fe979ce3fe60b79c Mon Sep 17 00:00:00 2001 From: Joshua Hoblitt Date: Fri, 26 Jun 2026 12:25:38 -0700 Subject: [PATCH] docs: fix function comments to match their declaration names Several godoc comments led with a stale or incorrect identifier, left over from renames, exported/unexported changes, copy-paste between sibling declarations, or plain typos. As a result the documented name no longer matched the function, method, type, or var it describes. Correct each leading word to the name of the declaration it documents. Signed-off-by: Joshua Hoblitt (cherry picked from commit 49612461a4c3734e871c3a7a54b268946686b12a) --- Documentation/CRDs/specification.md | 8 ++++---- deploy/charts/rook-ceph/templates/resources.yaml | 4 ++-- deploy/examples/crds.yaml | 4 ++-- pkg/apis/ceph.rook.io/v1/types.go | 10 +++++----- pkg/daemon/ceph/client/filesystem.go | 2 +- pkg/daemon/ceph/osd/kms/envs.go | 2 +- pkg/operator/ceph/cluster/mgr/mgr.go | 2 +- pkg/operator/ceph/cluster/mon/endpoint.go | 2 +- pkg/operator/ceph/cluster/mon/mon.go | 2 +- pkg/operator/ceph/cluster/osd/topology/topology.go | 2 +- pkg/operator/ceph/cluster/rbd/mirror.go | 2 +- pkg/operator/ceph/controller/spec.go | 2 +- pkg/operator/ceph/cr_manager.go | 2 +- pkg/operator/ceph/file/filesystem.go | 2 +- pkg/operator/ceph/file/mds/livenessprobe.go | 2 +- pkg/operator/ceph/file/mirror/mirror.go | 2 +- pkg/operator/ceph/object/bucket/provisioner.go | 2 +- pkg/operator/ceph/object/objectstore.go | 2 +- pkg/util/sys/parse.go | 2 +- tests/framework/clients/notification.go | 2 +- tests/framework/installer/ceph_installer.go | 2 +- tests/framework/utils/k8s_helper.go | 4 ++-- tests/integration/ceph_upgrade_test.go | 2 +- 23 files changed, 33 insertions(+), 33 deletions(-) diff --git a/Documentation/CRDs/specification.md b/Documentation/CRDs/specification.md index f8b702256..ef8cb17fe 100644 --- a/Documentation/CRDs/specification.md +++ b/Documentation/CRDs/specification.md @@ -2941,7 +2941,7 @@ KeystoneSpec (Appears on:BucketNotificationSpec)

-

BucketNotificationSpec represent the event type of the bucket notification +

BucketNotificationEvent represent the event type of the bucket notification See: https://docs.ceph.com/en/latest/radosgw/s3-notification-compatibility/#event-types

BucketNotificationSpec @@ -5339,7 +5339,7 @@ was reinstalled but OSD disk still contains the metadata from previous ceph clus (Appears on:ClientSpec)

-

ClinetSecuritySpec represents security settings for a Ceph Client

+

ClientSecuritySpec represents security settings for a Ceph Client

@@ -7414,7 +7414,7 @@ PeerStatSpec (Appears on:FilesystemMirroringInfoSpec)

-

FilesystemMirrorInfoSpec is the filesystem mirror status of a given filesystem

+

FilesystemMirroringInfo is the filesystem mirror status of a given filesystem

@@ -7458,7 +7458,7 @@ int (Appears on:CephFilesystemStatus)

-

FilesystemMirroringInfo is the status of the pool mirroring

+

FilesystemMirroringInfoSpec is the status of the pool mirroring

diff --git a/deploy/charts/rook-ceph/templates/resources.yaml b/deploy/charts/rook-ceph/templates/resources.yaml index 897ca2aaa..fe3eea419 100644 --- a/deploy/charts/rook-ceph/templates/resources.yaml +++ b/deploy/charts/rook-ceph/templates/resources.yaml @@ -948,7 +948,7 @@ spec: description: List of events that should trigger the notification items: description: |- - BucketNotificationSpec represent the event type of the bucket notification + BucketNotificationEvent represent the event type of the bucket notification See: https://docs.ceph.com/en/latest/radosgw/s3-notification-compatibility/#event-types enum: - s3:ObjectCreated:* @@ -9211,7 +9211,7 @@ spec: daemonsStatus: description: PoolMirroringStatus is the mirroring status of a filesystem items: - description: FilesystemMirrorInfoSpec is the filesystem mirror status of a given filesystem + description: FilesystemMirroringInfo is the filesystem mirror status of a given filesystem properties: daemon_id: description: DaemonID is the cephfs-mirror name diff --git a/deploy/examples/crds.yaml b/deploy/examples/crds.yaml index 85b06e75f..f272aa0e3 100644 --- a/deploy/examples/crds.yaml +++ b/deploy/examples/crds.yaml @@ -949,7 +949,7 @@ spec: description: List of events that should trigger the notification items: description: |- - BucketNotificationSpec represent the event type of the bucket notification + BucketNotificationEvent represent the event type of the bucket notification See: https://docs.ceph.com/en/latest/radosgw/s3-notification-compatibility/#event-types enum: - s3:ObjectCreated:* @@ -9206,7 +9206,7 @@ spec: daemonsStatus: description: PoolMirroringStatus is the mirroring status of a filesystem items: - description: FilesystemMirrorInfoSpec is the filesystem mirror status of a given filesystem + description: FilesystemMirroringInfo is the filesystem mirror status of a given filesystem properties: daemon_id: description: DaemonID is the cephfs-mirror name diff --git a/pkg/apis/ceph.rook.io/v1/types.go b/pkg/apis/ceph.rook.io/v1/types.go index 186e077fd..e12fe5d7d 100755 --- a/pkg/apis/ceph.rook.io/v1/types.go +++ b/pkg/apis/ceph.rook.io/v1/types.go @@ -1637,7 +1637,7 @@ type CephFilesystemStatus struct { ObservedGeneration int64 `json:"observedGeneration,omitempty"` } -// FilesystemMirroringInfo is the status of the pool mirroring +// FilesystemMirroringInfoSpec is the status of the pool mirroring type FilesystemMirroringInfoSpec struct { // PoolMirroringStatus is the mirroring status of a filesystem // +nullable @@ -1718,7 +1718,7 @@ type FilesystemSnapshotScheduleStatusRetention struct { Active bool `json:"active,omitempty"` } -// FilesystemMirrorInfoSpec is the filesystem mirror status of a given filesystem +// FilesystemMirroringInfo is the filesystem mirror status of a given filesystem type FilesystemMirroringInfo struct { // DaemonID is the cephfs-mirror name // +optional @@ -2811,7 +2811,7 @@ type CephBucketNotificationList struct { Items []CephBucketNotification `json:"items"` } -// BucketNotificationSpec represent the event type of the bucket notification +// BucketNotificationEvent represent the event type of the bucket notification // See: https://docs.ceph.com/en/latest/radosgw/s3-notification-compatibility/#event-types // +kubebuilder:validation:Enum="s3:ObjectCreated:*";"s3:ObjectCreated:Put";"s3:ObjectCreated:Post";"s3:ObjectCreated:Copy";"s3:ObjectCreated:CompleteMultipartUpload";"s3:ObjectRemoved:*";"s3:ObjectRemoved:Delete";"s3:ObjectRemoved:DeleteMarkerCreated";"s3:ObjectLifecycle:Expiration:Current";"s3:ObjectLifecycle:Expiration:NonCurrent";"s3:ObjectLifecycle:Expiration:DeleteMarker";"s3:ObjectLifecycle:Expiration:AbortMultipartUpload";"s3:ObjectLifecycle:Transition:Current";"s3:ObjectLifecycle:Transition:NonCurrent";"s3:LifecycleExpiration:*";"s3:LifecycleExpiration:Delete";"s3:LifecycleExpiration:DeleteMarkerCreated";"s3:LifecycleTransition";"s3:ObjectSynced:*";"s3:ObjectSynced:Create";"s3:ObjectSynced:Delete";"s3:ObjectSynced:DeletionMarkerCreated";"s3:Replication:*";"s3:Replication:Create";"s3:Replication:Delete";"s3:Replication:DeletionMarkerCreated";"s3:ObjectRestore:*";"s3:ObjectRestore:Post";"s3:ObjectRestore:Completed";"s3:ObjectRestore:Delete" type BucketNotificationEvent string @@ -3475,7 +3475,7 @@ type ClientSpec struct { Security ClientSecuritySpec `json:"security,omitempty"` } -// ClinetSecuritySpec represents security settings for a Ceph Client +// ClientSecuritySpec represents security settings for a Ceph Client type ClientSecuritySpec struct { // CephX configures CephX key settings. More: https://docs.ceph.com/en/latest/dev/cephx/ // +optional @@ -3932,7 +3932,7 @@ type CephFilesystemSubVolumeGroup struct { // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// CephFilesystemSubVolumeGroup represents a list of Ceph Clients +// CephFilesystemSubVolumeGroupList represents a list of Ceph filesystem subvolume groups type CephFilesystemSubVolumeGroupList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` diff --git a/pkg/daemon/ceph/client/filesystem.go b/pkg/daemon/ceph/client/filesystem.go index af5137cb5..4a6935e7a 100644 --- a/pkg/daemon/ceph/client/filesystem.go +++ b/pkg/daemon/ceph/client/filesystem.go @@ -476,7 +476,7 @@ type SubVolumeSnapshot struct { // SubVolumeSnapshots is the list of snapshots in a CephFS subvolume type SubVolumeSnapshots []SubVolumeSnapshot -// ListSubVolumeSnaphots lists all the subvolume snapshots present in the subvolume in the given filesystem's subvolume group. +// ListSubVolumeSnapshots lists all the subvolume snapshots present in the subvolume in the given filesystem's subvolume group. var ListSubVolumeSnapshots = listSubVolumeSnapshots func listSubVolumeSnapshots(context *clusterd.Context, clusterInfo *ClusterInfo, fsName, subVolumeName, groupName string) (SubVolumeSnapshots, error) { diff --git a/pkg/daemon/ceph/osd/kms/envs.go b/pkg/daemon/ceph/osd/kms/envs.go index 89d8c9924..a7deaa094 100644 --- a/pkg/daemon/ceph/osd/kms/envs.go +++ b/pkg/daemon/ceph/osd/kms/envs.go @@ -34,7 +34,7 @@ var ( knownKMSPrefix = []string{"VAULT_", "IBM_", kmipKMSPrefix, "AZURE_"} ) -// VaultTokenEnvVarFromSecret returns the kms token secret value as an env var +// vaultTokenEnvVarFromSecret returns the kms token secret value as an env var func vaultTokenEnvVarFromSecret(tokenSecretName string) v1.EnvVar { return v1.EnvVar{ Name: api.EnvVaultToken, diff --git a/pkg/operator/ceph/cluster/mgr/mgr.go b/pkg/operator/ceph/cluster/mgr/mgr.go index 1986ed2c6..7815fe76f 100644 --- a/pkg/operator/ceph/cluster/mgr/mgr.go +++ b/pkg/operator/ceph/cluster/mgr/mgr.go @@ -580,7 +580,7 @@ func (c *Cluster) EnableServiceMonitor() error { return nil } -// ApplyMonitoringLabels function adds the name of the resource that manages +// applyMonitoringLabels function adds the name of the resource that manages // cephcluster, as a label on the ceph metrics func applyMonitoringLabels(c *Cluster, serviceMonitor *monitoringv1.ServiceMonitor) { if c.spec.Labels != nil { diff --git a/pkg/operator/ceph/cluster/mon/endpoint.go b/pkg/operator/ceph/cluster/mon/endpoint.go index 0d494c4c5..c95adfcfa 100644 --- a/pkg/operator/ceph/cluster/mon/endpoint.go +++ b/pkg/operator/ceph/cluster/mon/endpoint.go @@ -23,7 +23,7 @@ import ( cephclient "github.com/rook/rook/pkg/daemon/ceph/client" ) -// FlattenMonEndpoints returns a comma-delimited string of all mons and endpoints in the form +// flattenMonEndpoints returns a comma-delimited string of all mons and endpoints in the form // = func flattenMonEndpoints(mons map[string]*cephclient.MonInfo) string { endpoints := []string{} diff --git a/pkg/operator/ceph/cluster/mon/mon.go b/pkg/operator/ceph/cluster/mon/mon.go index 3f66a3f2e..9b313b157 100644 --- a/pkg/operator/ceph/cluster/mon/mon.go +++ b/pkg/operator/ceph/cluster/mon/mon.go @@ -822,7 +822,7 @@ func scheduleMonitor(c *Cluster, mon *monConfig) (*apps.Deployment, error) { return d, nil } -// GetMonPlacement returns the placement for the MON service +// getMonPlacement returns the placement for the MON service func (c *Cluster) getMonPlacement(zone string) cephv1.Placement { // If the mon is the arbiter in a stretch cluster and its placement is specified, return it // without merging with the "all" placement so it can be handled separately from all other daemons diff --git a/pkg/operator/ceph/cluster/osd/topology/topology.go b/pkg/operator/ceph/cluster/osd/topology/topology.go index 454cd6412..00b973c99 100644 --- a/pkg/operator/ceph/cluster/osd/topology/topology.go +++ b/pkg/operator/ceph/cluster/osd/topology/topology.go @@ -89,7 +89,7 @@ func kubernetesTopologyLabelToCRUSHLabel(label string) string { return crushLabel[len(crushLabel)-1] } -// ExtractTopologyFromLabels extracts rook topology from labels and returns a map from topology type to value +// extractTopologyFromLabels extracts rook topology from labels and returns a map from topology type to value func extractTopologyFromLabels(labels map[string]string) (map[string]string, string) { topology := make(map[string]string) diff --git a/pkg/operator/ceph/cluster/rbd/mirror.go b/pkg/operator/ceph/cluster/rbd/mirror.go index 308a95c1c..cfe4cb91a 100644 --- a/pkg/operator/ceph/cluster/rbd/mirror.go +++ b/pkg/operator/ceph/cluster/rbd/mirror.go @@ -44,7 +44,7 @@ const ( var updateDeploymentAndWait = mon.UpdateCephDeploymentAndWait -// Start begins the process of running rbd mirroring daemons. +// start begins the process of running rbd mirroring daemons. func (r *ReconcileCephRBDMirror) start(cephRBDMirror *cephv1.CephRBDMirror) error { // Validate pod's memory if specified err := controller.CheckPodMemory(cephv1.ResourcesKeyRBDMirror, cephRBDMirror.Spec.Resources, cephRbdMirrorPodMinimumMemory) diff --git a/pkg/operator/ceph/controller/spec.go b/pkg/operator/ceph/controller/spec.go index 5d245560a..3893b6100 100644 --- a/pkg/operator/ceph/controller/spec.go +++ b/pkg/operator/ceph/controller/spec.go @@ -855,7 +855,7 @@ func RgwOpsLogSidecarContainer(opsLogFile, ns string, c cephv1.ClusterSpec, env } } -// CreateExternalMetricsEndpoints creates external metric endpoint +// createExternalMetricsEndpoints creates external metric endpoint func createExternalMetricsEndpoints(namespace string, monitoringSpec cephv1.MonitoringSpec, ownerInfo *k8sutil.OwnerInfo) (*discoveryv1.EndpointSlice, error) { labels := AppLabels("rook-ceph-mgr", namespace) labels[discoveryv1.LabelServiceName] = ExternalMgrAppName diff --git a/pkg/operator/ceph/cr_manager.go b/pkg/operator/ceph/cr_manager.go index 54d19570e..4565df0ab 100644 --- a/pkg/operator/ceph/cr_manager.go +++ b/pkg/operator/ceph/cr_manager.go @@ -101,7 +101,7 @@ var AddToManagerFuncs = []func(manager.Manager, *clusterd.Context, context.Conte // controller) // var AddToManagerOpFunc = []func(manager.Manager, *clusterd.Context, opcontroller.OperatorConfig) error{} -// AddToManager adds all the registered controllers to the passed manager. +// addToManager adds all the registered controllers to the passed manager. // each controller package will have an Add method listed in AddToManagerFuncs // which will setup all the necessary watch func (o *Operator) addToManager(m manager.Manager, c *controllerconfig.Context, opManagerContext context.Context, opconfig opcontroller.OperatorConfig) error { diff --git a/pkg/operator/ceph/file/filesystem.go b/pkg/operator/ceph/file/filesystem.go index 737a2512a..a8c3b3809 100644 --- a/pkg/operator/ceph/file/filesystem.go +++ b/pkg/operator/ceph/file/filesystem.go @@ -345,7 +345,7 @@ func GenerateMetaDataPoolName(fsName string) string { return generateMetaDataPoolName(fsName, nil) } -// GenerateMetaDataPoolName generates MetaDataPool name as specified in FilesystemSpec +// generateMetaDataPoolName generates MetaDataPool name as specified in FilesystemSpec func generateMetaDataPoolName(fsName string, spec *cephv1.FilesystemSpec) string { poolName := "" diff --git a/pkg/operator/ceph/file/mds/livenessprobe.go b/pkg/operator/ceph/file/mds/livenessprobe.go index 4a6e5105b..c1e0b0722 100644 --- a/pkg/operator/ceph/file/mds/livenessprobe.go +++ b/pkg/operator/ceph/file/mds/livenessprobe.go @@ -55,7 +55,7 @@ func renderProbe(mdsLivenessProbeConfigValue mdsLivenessProbeConfig) (string, er return writer.String(), nil } -// GenerateMDSLivenessProbeExecDaemon generates a liveness probe that makes sure mds daemon is present in fs map, +// generateMDSLivenessProbeExecDaemon generates a liveness probe that makes sure mds daemon is present in fs map, // that it can be called, and that it returns 0 func generateMDSLivenessProbeExecDaemon(daemonID, filesystemName, keyring string) *v1.Probe { mdsLivenessProbeConfigValue := mdsLivenessProbeConfig{ diff --git a/pkg/operator/ceph/file/mirror/mirror.go b/pkg/operator/ceph/file/mirror/mirror.go index f242fd97f..20c83cbed 100644 --- a/pkg/operator/ceph/file/mirror/mirror.go +++ b/pkg/operator/ceph/file/mirror/mirror.go @@ -41,7 +41,7 @@ const ( var updateDeploymentAndWait = mon.UpdateCephDeploymentAndWait -// Start begins the process of running filesystem mirroring daemons. +// start begins the process of running filesystem mirroring daemons. func (r *ReconcileFilesystemMirror) start(filesystemMirror *cephv1.CephFilesystemMirror) error { nsName := controller.NsName(filesystemMirror.Namespace, filesystemMirror.Name) // Validate pod's memory if specified diff --git a/pkg/operator/ceph/object/bucket/provisioner.go b/pkg/operator/ceph/object/bucket/provisioner.go index 1a051b5a5..9e92b0a60 100644 --- a/pkg/operator/ceph/object/bucket/provisioner.go +++ b/pkg/operator/ceph/object/bucket/provisioner.go @@ -555,7 +555,7 @@ func (p *Provisioner) setObjectContext() error { return nil } -// setObjectStoreDomainName sets the provisioner.storeDomainName and provisioner.port +// setObjectStoreDomainNameAndPort sets the provisioner.storeDomainName and provisioner.port // must be called after setObjectStoreName and setObjectStoreNamespace func (p *Provisioner) setObjectStoreDomainNameAndPort(sc *storagev1.StorageClass) error { // make sure the object store actually exists diff --git a/pkg/operator/ceph/object/objectstore.go b/pkg/operator/ceph/object/objectstore.go index 87420ac70..144d808e7 100644 --- a/pkg/operator/ceph/object/objectstore.go +++ b/pkg/operator/ceph/object/objectstore.go @@ -1100,7 +1100,7 @@ func GetObjectBucketProvisioner(namespace string) (string, error) { return provName, nil } -// CheckDashboardUser returns true if the dashboard user exists and has the same credentials as the given user, else return false +// checkDashboardUser returns true if the dashboard user exists and has the same credentials as the given user, else return false func checkDashboardUser(context *Context, user ObjectUser) (bool, error) { dUser, errId, err := GetUser(context, DashboardUser) diff --git a/pkg/util/sys/parse.go b/pkg/util/sys/parse.go index f36c50ad2..4d7d0cbed 100644 --- a/pkg/util/sys/parse.go +++ b/pkg/util/sys/parse.go @@ -20,7 +20,7 @@ import ( "strings" ) -// grep finds the *first* line that matches, rather than multiple lines +// Grep finds the *first* line that matches, rather than multiple lines func Grep(input, searchFor string) string { if input == "" || searchFor == "" { return "" diff --git a/tests/framework/clients/notification.go b/tests/framework/clients/notification.go index d7805441f..b0041a19d 100644 --- a/tests/framework/clients/notification.go +++ b/tests/framework/clients/notification.go @@ -47,7 +47,7 @@ func (n *NotificationOperation) UpdateNotification(notificationName string, topi return n.k8sh.ResourceOperation("apply", n.manifests.GetBucketNotification(notificationName, topicName)) } -// CheckNotification if notification was set +// CheckNotificationCR if notification was set func (t *NotificationOperation) CheckNotificationCR(notificationName string) bool { // TODO: return result based on reconcile status of the CR const resourceName = "cephbucketnotification" diff --git a/tests/framework/installer/ceph_installer.go b/tests/framework/installer/ceph_installer.go index feb15c66f..5b092b44a 100644 --- a/tests/framework/installer/ceph_installer.go +++ b/tests/framework/installer/ceph_installer.go @@ -394,7 +394,7 @@ func (h *CephInstaller) CreateRookExternalCluster(externalManifests CephManifest return errors.Errorf("failed to start external cluster, state: %v", clusterStatus) } -// InjectRookExternalClusterInfo inject connection information for an external cluster +// injectRookExternalClusterInfo inject connection information for an external cluster func (h *CephInstaller) injectRookExternalClusterInfo(externalSettings *TestCephSettings) error { ctx := context.TODO() // get config map diff --git a/tests/framework/utils/k8s_helper.go b/tests/framework/utils/k8s_helper.go index 89927712c..c98c35fbc 100644 --- a/tests/framework/utils/k8s_helper.go +++ b/tests/framework/utils/k8s_helper.go @@ -313,7 +313,7 @@ func (k8sh *K8sHelper) WaitForCustomResourceDeletion(namespace, name string, che return fmt.Errorf("timed out waiting for deletion of custom resource %q", name) } -// DeleteResource performs a kubectl delete on give args. +// DeleteResourceAndWait performs a kubectl delete on give args. // If wait is false, a flag will be passed to indicate the delete should return immediately func (k8sh *K8sHelper) DeleteResourceAndWait(wait bool, args ...string) error { if !wait { @@ -987,7 +987,7 @@ func (k8sh *K8sHelper) IsDefaultStorageClassPresent() (bool, error) { return false, nil } -// CheckPvcCount returns True if expected number pvs for a app are found +// CheckPvcCountAndStatus returns True if expected number pvs for a app are found func (k8sh *K8sHelper) CheckPvcCountAndStatus(podName string, namespace string, expectedPvcCount int, expectedStatus string) bool { logger.Infof("wait until %d pvc for app=%s are present", expectedPvcCount, podName) listOpts := metav1.ListOptions{LabelSelector: "app=" + podName} diff --git a/tests/integration/ceph_upgrade_test.go b/tests/integration/ceph_upgrade_test.go index ed284f488..a58066d26 100644 --- a/tests/integration/ceph_upgrade_test.go +++ b/tests/integration/ceph_upgrade_test.go @@ -439,7 +439,7 @@ func (s *UpgradeSuite) verifyFilesAfterUpgrade(newFileToWrite string, rbdFilesTo assert.NoError(s.T(), s.k8sh.ReadFromPodRetry(s.namespace, filePodName, newFileToWrite, simpleTestMessage, retryCount)) } -// UpgradeToMaster performs the steps necessary to upgrade a Rook v1.4 cluster to master. It does not +// upgradeToMaster performs the steps necessary to upgrade a Rook v1.4 cluster to master. It does not // verify the upgrade but merely starts the upgrade process. func (s *UpgradeSuite) upgradeToMaster() { // Apply the CRDs for the latest master