Feat/nfs export names by IanEff · Pull Request #6497 · ceph/ceph-csi

IanEff · 2026-08-25T11:36:47Z

Describe what this PR does

NFS export names are currently derived from ComposeCSIID(), a long alphanumeric string that's meaningless to humans. This PR adds an opt-in friendlyExportNames StorageClass parameter that names exports <namespace>/<pvc-name> instead.

The name is sourced from PVC metadata supplied by the external provisioner, enabled with --extra-create-metadata=true, and persisted in the CephFS journal so that DeleteExport and SetClients can resolve the volume path later on.

Is there anything that requires special attention

This feature is gated behind an explicit StorageClass parameter rather than firing automatically whenever --extra-create-metadata is set because that flag is already used unconditionally by the CephFS backend for per-tenant KMS scoping.

It's entirely backwards compatible, as the parameter is set to off by default. No existing exports are affected

Related issues

Fixes: #4414

Future concerns

None.

Checklist:

Commit Message Formatting: Commit titles and messages follow
guidelines in the developer
guide.
Reviewed the developer guide on Submitting a Pull
Request
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!)

CI job ordering.

Depends-on: #6538

IanEff · 2026-08-25T11:52:32Z

This doesn't address the degenerate export names issue. I'll re-submit.

nixpanic

Looks reasonable, thanks for the PR.

Can you please create a clean series of commits, instead of fixups that tidy the code after it was added? Note that we do want Co-authored-by referencing your AI agent on each commit where it assisted.

It would be good to add a test-case in e2e/nfs.go for the functionality too.

IanEff · 2026-08-25T12:55:54Z

Both of those CI tests failed on downloading from the repo(https://download.ceph.com/rpm-${CEPH_VERSION}/el10/noarch/ceph-release-1-0.el10.noarch.rpm). I don't know that I can do anything about that.

IanEff · 2026-08-25T13:24:54Z

Can you please create a clean series of commits, instead of fixups that tidy the code after it was added?

Resubmitted. Thanks for the guidance!

nixpanic

Thanks, this looks complete to me. Unfortunately we do not have any documentation specific to NFS (or other backends), otherwise it would have been nice to add this option and an example there.

nixpanic · 2026-08-26T15:11:02Z

@Mergifyio rebase

This will include the CI fixes.

mergify · 2026-08-26T15:11:07Z

rebase

🛑 The pull request rule doesn't match anymore

Details

This action has been cancelled.

nixpanic · 2026-08-26T15:14:49Z

GitHub Actions are not running due to an outage

nixpanic · 2026-08-27T13:28:12Z

@Mergifyio rebase

GitHub Workflows should work again.

mergify · 2026-08-27T13:28:29Z

rebase

🛑 The pull request rule doesn't match anymore

Details

This action has been cancelled.

Copilot

🟡 Changes recommended

Validation can orphan backend volumes, and the new E2E test lacks the required provisioner metadata flag.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds opt-in human-readable NFS export paths derived from PVC metadata.

Changes:

Persists friendly export names for create, delete, and client updates.
Detects export-name conflicts and documents the new StorageClass parameter.
Adds unit and end-to-end coverage.

File summaries

File	Description
`PendingReleaseNotes.md`	Documents the feature and conflict behavior.
`internal/util/k8s/parameters.go`	Exposes PVC-name metadata.
`internal/nfs/types/volume.go`	Persists and resolves friendly export paths.
`internal/nfs/types/volume_test.go`	Tests export-path selection.
`internal/nfs/types/errors.go`	Defines the export-name conflict error.
`internal/nfs/controller/controllerserver.go`	Parses the option and maps conflicts.
`internal/nfs/controller/controllerserver_test.go`	Tests friendly-name derivation.
`examples/nfs/storageclass.yaml`	Documents StorageClass configuration.
`e2e/utils.go`	Adds export pseudo-path lookup support.
`e2e/nfs.go`	Adds a friendly-export-name scenario.

Review details

Files reviewed: 10/10 changed files
Comments generated: 2
Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Pull request has been modified.

IanEff · 2026-09-04T17:42:50Z

@Madhu-1 , @nixpanic: all Copilot issues addressed in the last PR.

iPraveenParihar

Thanks! LGTM :)
have more info on the error logs

Pull request has been modified.

iPraveenParihar

@IanEff squash commits into one?

Currently, NFS-export names are derived from ComposeCSIID(), a long alphanumeric string that isn't meaningful to users. Add an opt-in "<namespace>/<pvc-name>" naming scheme, gated behind a new friendlyExportNames StorageClass parameter, sourced from PVC metadata supplied by the external-provisioner (--extra-create-metadata=true). The friendly name is persisted in the CephFS journal so DeleteExport and SetClients, which only have the CSI volume ID to work from, can resolve the same export path later. Gated behind an explicit StorageClass parameter rather than being automatic whenever --extra-create-metadata is set, since that flag is already used unconditionally by the CephFS backend for per-tenant KMS scoping (store.Owner, cephfs/store/volumeoptions.go). Keying export naming purely off metadata presence would silently rename exports for any existing encrypted CephFS-backed NFS deployment. Fixes: ceph#4414 Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Signed-off-by: Ian Furst <ian.furst@gmail.com>

Unlike a volume-ID derived export name, "<namespace>/<pvc-name>" is not guaranteed unique over time (e.g. a PVC recreated under the same name before its old export was cleaned up). CreateExport treated any "Export already exists" response as a safe idempotent retry, which would silently reuse another volume's export and serve its data. Compare the existing export's subvolume path before accepting the collision as our own retry; otherwise fail with ErrExportNameConflict, surfaced to CSI callers as codes.AlreadyExists. Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com> Signed-off-by: Ian Furst <ian.furst@gmail.com>

IanEff · 2026-09-09T01:19:27Z

@iPraveenParihar Squashed!

nixpanic · 2026-09-09T08:15:38Z

Wait for #6538 to be merged before starting CI jobs in this PR.

mergify · 2026-09-09T08:15:49Z

Merge Protections

🔴 1 of 2 protections blocking · waiting on ⛓️ dependency

	Protection	Waiting on
🔴	⛓️ Depends-On Requirements	⛓️ dependency
🟢	🚦 Auto-queue	—

🔴 ⛓️ Depends-On Requirements

Waiting for

depends-on = ceph/ceph-csi#6538 [⛓️ deploy: use single worker thread in csi-provisioner for NVMe-oF #6538]

This rule is failing.

Requirement based on the presence of Depends-On in the body of the pull request

depends-on = ceph/ceph-csi#6538 [⛓️ deploy: use single worker thread in csi-provisioner for NVMe-oF #6538]

Show 1 satisfied protection

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

IanEff requested review from a team as code owners August 25, 2026 11:36

nixpanic reviewed Aug 25, 2026

View reviewed changes

Comment thread internal/nfs/types/volume.go

nixpanic added enhancement New feature or request component/nfs Issues related to NFS labels Aug 25, 2026

IanEff force-pushed the feat/nfs-export-names branch from c1fbc81 to 8d96c63 Compare August 25, 2026 13:13

nixpanic previously approved these changes Aug 26, 2026

View reviewed changes

nixpanic requested a review from a team August 26, 2026 14:29

ceph-csi-bot force-pushed the feat/nfs-export-names branch from 8d96c63 to 6dd8906 Compare August 26, 2026 15:11

ceph-csi-bot force-pushed the feat/nfs-export-names branch from 6dd8906 to e5d903a Compare August 27, 2026 13:28

Madhu-1 previously approved these changes Sep 4, 2026

View reviewed changes

Madhu-1 requested a balanced review from Copilot September 4, 2026 05:33

Copilot started reviewing on behalf of Madhu-1 September 4, 2026 05:33 View session

Copilot AI reviewed Sep 4, 2026

View reviewed changes

Comment thread e2e/nfs.go

Comment thread internal/nfs/controller/controllerserver.go Outdated

IanEff force-pushed the feat/nfs-export-names branch from e5d903a to bb171b7 Compare September 4, 2026 11:03

Madhu-1 previously approved these changes Sep 7, 2026

View reviewed changes

Madhu-1 requested a review from nixpanic September 7, 2026 05:09

iPraveenParihar requested changes Sep 8, 2026

View reviewed changes

Comment thread internal/nfs/controller/controllerserver.go Outdated

Comment thread internal/nfs/controller/controllerserver.go Outdated

Comment thread PendingReleaseNotes.md

IanEff force-pushed the feat/nfs-export-names branch from 4a3388e to 280cf40 Compare September 8, 2026 09:24

iPraveenParihar reviewed Sep 8, 2026

View reviewed changes

Comment thread internal/nfs/controller/controllerserver.go Outdated

IanEff force-pushed the feat/nfs-export-names branch from 280cf40 to 792cfac Compare September 8, 2026 11:28

IanEff and others added 2 commits September 8, 2026 07:49

IanEff force-pushed the feat/nfs-export-names branch from 792cfac to 2a544db Compare September 8, 2026 11:49

iPraveenParihar approved these changes Sep 9, 2026

View reviewed changes

Madhu-1 approved these changes Sep 9, 2026

View reviewed changes

nixpanic mentioned this pull request Sep 9, 2026

cephfs: move fscrypt lock into the CephFS RADOS namespace #6539

Open

6 tasks

Uh oh!

Conversation

IanEff commented Aug 25, 2026 • edited by nixpanic Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe what this PR does

Is there anything that requires special attention

Related issues

Future concerns

Uh oh!

IanEff commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nixpanic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

IanEff commented Aug 25, 2026

Uh oh!

IanEff commented Aug 25, 2026

Uh oh!

nixpanic left a comment

Choose a reason for hiding this comment

Uh oh!

nixpanic commented Aug 26, 2026

Uh oh!

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

Uh oh!

🛑 The pull request rule doesn't match anymore

Uh oh!

nixpanic commented Aug 26, 2026

Uh oh!

nixpanic commented Aug 27, 2026

Uh oh!

mergify Bot commented Aug 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🛑 The pull request rule doesn't match anymore

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

IanEff commented Sep 4, 2026

Uh oh!

iPraveenParihar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

iPraveenParihar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

IanEff commented Sep 9, 2026

Uh oh!

nixpanic commented Sep 9, 2026

Uh oh!

mergify Bot commented Sep 9, 2026

Merge Protections

🔴 ⛓️ Depends-On Requirements

🟢 🚦 Auto-queue

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

IanEff commented Aug 25, 2026 •

edited by nixpanic

Loading

IanEff commented Aug 25, 2026 •

edited

Loading

mergify Bot commented Aug 26, 2026 •

edited

Loading

mergify Bot commented Aug 27, 2026 •

edited

Loading