Store userid in metadata by iPraveenParihar · Pull Request #5445 · ceph/ceph-csi

iPraveenParihar · 2025-07-23T11:40:06Z

Describe what this PR does

Problem

Without a mechanism to track nodeID:userID mappings per volume, it becomes challenging to:

Monitor which userIDs are actively being used across the cluster
Make informed decisions about key rotation, allowing safe cleanup of old keys

Proposed Solution

The solution involves tracking userID information by storing it in the metadata of RBD images and CephFS subvolumes using the key: .[rbd|cephfs].csi.ceph.com/userID/:

refer design doc (here)for more details:

doc: design doc for userID mapping metadata #5425

Checklist:

Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
Reviewed the developer guide on [Submitting a Pull Request](https://github.com/ceph/ceph csi/blob/devel/docs/development-guide.md#development-workflow)
Pending release notes updated with breaking and/or notable changes for the next major release.
Documentation has been updated, if necessary.
Unit tests have been added, if necessary.
Integration tests have been added, if necessary.

Show available bot commands

These commands are normally not required, but in case of issues, leave any of
the following bot commands in an otherwise empty comment in this PR:

/retest ci/centos/<job-name>: retest the <job-name> after unrelated
failure (please report the failure too!)

nixpanic · 2025-07-23T14:41:16Z

-	fs.cd = csicommon.NewCSIDriver(conf.DriverName, util.DriverVersion, conf.NodeID, conf.InstanceID,
-		conf.EnableFencing)
+	fs.cd = csicommon.NewCSIDriver(conf.DriverName, util.DriverVersion, conf.NodeID, conf.InstanceID)
+	fs.cd.SetEnableFencing(conf.EnableFencing)


Instead of having Set... functions for everything, consider passing options like WithFencing to NewCSIDriver(). Similar to how gRPC CallOptions work, that makes it a little more dynamic and easier extendible.

addressed now, Thanks for the suggestion.

nixpanic

surely there should be e2e tests for this?

Madhu-1 · 2025-07-24T06:51:14Z

 - rbd: add support for [CSI Snapshot Metadata Service RPCs](https://github.com/container-storage-interface/spec/blob/master/spec.md#snapshot-metadata-service-rpcs)
 - feature: handle non graceful node shutdown [PR](https://github.com/ceph/ceph-csi/pull/5429/)
   - refer design doc for more details - [here](docs/design/proposals/non-graceful-node-shutdown.md)
+- feature: set nodeId:userId mapping metadata [PR](https://github.com/ceph/ceph-csi/pull/5445)


This is already feature section. we dont need to add feature: here

Madhu-1 · 2025-07-24T06:51:47Z

+// removeUserIdMapping attempts to remove nodeId:userId mapping metadata from the subvolume.
+//
+// Parameters:
+//   - nodeId: The ID of the node that may be fenced.


typo, addressed.

Madhu-1 · 2025-07-24T06:55:48Z

 	return d.enableFencing
 }

+func (d *CSIDriver) SetEnableFencing(value bool) {


value is too generate please use better names

removed now,

iPraveenParihar · 2025-07-24T07:36:21Z

Thanks @Madhu-1, for the early reviews.
Am working on avoiding duplications.

iPraveenParihar · 2025-07-24T11:30:04Z

/test ci/centos/mini-e2e/k8s-1.31

iPraveenParihar · 2025-07-24T11:30:13Z

@Rakshith-R @nixpanic PTAL

iPraveenParihar · 2025-07-24T11:33:09Z

/test ci/centos/mini-e2e/k8s-1.31

iPraveenParihar · 2025-07-24T15:09:18Z

/test ci/centos/mini-e2e/k8s-1.31

iPraveenParihar · 2025-07-24T16:07:35Z

/test ci/centos/mini-e2e/k8s-1.31

iPraveenParihar · 2025-07-24T17:14:17Z

/test ci/centos/mini-e2e/k8s-1.31

iPraveenParihar · 2025-07-25T02:55:17Z

/test ci/centos/mini-e2e/k8s-1.31

iPraveenParihar · 2025-07-25T05:22:09Z

/test ci/centos/mini-e2e/k8s-1.31

Madhu-1

small nits and few previous comments need to be addressed in E2E, LGTM

Madhu-1 · 2025-07-25T09:23:47Z

- feature: handle non graceful node shutdown [PR](https://github.com/ceph/ceph-csi/pull/5429/)
+- handle non graceful node shutdown [PR](https://github.com/ceph/ceph-csi/pull/5429/)
   - refer design doc for more details - [here](docs/design/proposals/non-graceful-node-shutdown.md)
+- set nodeId:userId mapping metadata [PR](https://github.com/ceph/ceph-csi/pull/5445)


nodeId:userId mapping in metadata

iPraveenParihar · 2025-08-25T11:34:00Z

/test ci/centos/mini-e2e-helm/k8s-1.33

Rakshith-R

Thanks

Dismissing requested changes since they have been addressed.

Rakshith-R · 2025-08-26T11:09:38Z

@Mergifyio queue

mergify · 2025-08-26T11:10:10Z

queue

✅ The pull request has been merged automatically

Details

The pull request has been merged automatically at df84cab

This commit does the following operations: 1. In NodeStageVolume(): sets nodeId:userId mapping in image metadata. The userId is the ceph user used for mounting the subvolume. 2. In ControllerUnpulishVolume(): removes the nodeId:userId mapping from the image metadata. Signed-off-by: Praveen M <m.praveen@ibm.com>

This commit does the following operations: 1. In NodeStageVolume(): sets nodeId:userId mapping in subvolume metadata. The userId is the ceph user used for mounting the subvolume. 2. In ControllerUnpulishVolume(): removes the nodeId:userId mapping from the subvolume metadata. Signed-off-by: Praveen M <m.praveen@ibm.com>

Signed-off-by: Praveen M <m.praveen@ibm.com>

ceph-csi-bot · 2025-08-26T11:10:30Z

/test ci/centos/k8s-e2e-external-storage/1.32

ceph-csi-bot · 2025-08-26T11:10:30Z

/test ci/centos/k8s-e2e-external-storage/1.31

ceph-csi-bot · 2025-08-26T11:10:30Z

/test ci/centos/mini-e2e-helm/k8s-1.32

ceph-csi-bot · 2025-08-26T11:10:30Z

/test ci/centos/mini-e2e-helm/k8s-1.31

ceph-csi-bot · 2025-08-26T11:10:31Z

/test ci/centos/mini-e2e/k8s-1.32

ceph-csi-bot · 2025-08-26T11:10:31Z

/test ci/centos/mini-e2e/k8s-1.31

ceph-csi-bot · 2025-08-26T11:10:34Z

/test ci/centos/upgrade-tests-cephfs

ceph-csi-bot · 2025-08-26T11:10:35Z

/test ci/centos/upgrade-tests-rbd

ceph-csi-bot · 2025-08-26T11:10:35Z

/test ci/centos/k8s-e2e-external-storage/1.33

ceph-csi-bot · 2025-08-26T11:10:36Z

/test ci/centos/mini-e2e-helm/k8s-1.33

ceph-csi-bot · 2025-08-26T11:10:37Z

/test ci/centos/mini-e2e/k8s-1.33

iPraveenParihar force-pushed the store-userid-in-metadata branch 5 times, most recently from 6efc0f4 to 4cb8950 Compare July 23, 2025 13:13

nixpanic reviewed Jul 23, 2025

View reviewed changes

Madhu-1 requested changes Jul 24, 2025

View reviewed changes

iPraveenParihar force-pushed the store-userid-in-metadata branch 2 times, most recently from 2cb79f8 to ca1ef84 Compare July 24, 2025 11:19

iPraveenParihar marked this pull request as ready for review July 24, 2025 11:28

iPraveenParihar requested a review from Madhu-1 July 24, 2025 11:29

Madhu-1 reviewed Jul 24, 2025

View reviewed changes

Comment thread e2e/pod.go Outdated

Comment thread e2e/rbd.go

Comment thread e2e/cephfs.go

Comment thread internal/rbd/controllerserver.go

Comment thread internal/rbd/controllerserver.go

iPraveenParihar force-pushed the store-userid-in-metadata branch from ca1ef84 to fcaf5c2 Compare July 24, 2025 13:36

iPraveenParihar requested a review from Rakshith-R July 24, 2025 13:55

iPraveenParihar force-pushed the store-userid-in-metadata branch 2 times, most recently from 5ae51ff to 590381a Compare July 24, 2025 15:07

iPraveenParihar force-pushed the store-userid-in-metadata branch from 590381a to b96d4d8 Compare July 24, 2025 16:07

iPraveenParihar force-pushed the store-userid-in-metadata branch from b96d4d8 to 4baffa6 Compare July 24, 2025 17:14

iPraveenParihar force-pushed the store-userid-in-metadata branch from 4baffa6 to 7c07363 Compare July 25, 2025 02:55

Madhu-1 reviewed Jul 25, 2025

View reviewed changes

iPraveenParihar requested a review from nixpanic August 25, 2025 05:06

iPraveenParihar changed the title ~~[WIP]: Store userid in metadata~~ Store userid in metadata Aug 25, 2025

iPraveenParihar force-pushed the store-userid-in-metadata branch from 5178685 to b20201d Compare August 25, 2025 11:23

Rakshith-R approved these changes Aug 26, 2025

View reviewed changes

Rakshith-R requested review from Nikhil-Ladha and black-dragon74 August 26, 2025 06:34

black-dragon74 approved these changes Aug 26, 2025

View reviewed changes

iPraveenParihar added 4 commits August 26, 2025 11:10

e2e: add tests to verify userid mapping metadata

7df2564

Signed-off-by: Praveen M <m.praveen@ibm.com>

doc: update PendingReleaseNotes.md

d033047

Signed-off-by: Praveen M <m.praveen@ibm.com>

mergify bot force-pushed the store-userid-in-metadata branch from b20201d to d033047 Compare August 26, 2025 11:10

mergify bot added the ok-to-test Label to trigger E2E tests label Aug 26, 2025

ceph-csi-bot removed the ok-to-test Label to trigger E2E tests label Aug 26, 2025

mergify bot merged commit df84cab into ceph:devel Aug 26, 2025
37 checks passed

Conversation

iPraveenParihar commented Jul 23, 2025

Describe what this PR does

Problem

Proposed Solution

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nixpanic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

iPraveenParihar commented Jul 24, 2025

Uh oh!

iPraveenParihar commented Jul 25, 2025

Uh oh!

iPraveenParihar commented Jul 25, 2025

Uh oh!

Madhu-1 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

iPraveenParihar commented Aug 25, 2025

Uh oh!

Rakshith-R left a comment

Choose a reason for hiding this comment

Uh oh!

Rakshith-R commented Aug 26, 2025

Uh oh!

mergify bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ The pull request has been merged automatically

Uh oh!

ceph-csi-bot commented Aug 26, 2025

Uh oh!

ceph-csi-bot commented Aug 26, 2025

Uh oh!

ceph-csi-bot commented Aug 26, 2025

Uh oh!

ceph-csi-bot commented Aug 26, 2025

Uh oh!

ceph-csi-bot commented Aug 26, 2025

Uh oh!

ceph-csi-bot commented Aug 26, 2025

Uh oh!

mergify bot commented Aug 26, 2025 •

edited

Loading