Skip to content

Feat/nfs export names - #6497

Open
IanEff wants to merge 2 commits into
ceph:develfrom
IanEff:feat/nfs-export-names
Open

Feat/nfs export names#6497
IanEff wants to merge 2 commits into
ceph:develfrom
IanEff:feat/nfs-export-names

Conversation

@IanEff

@IanEff IanEff commented Aug 25, 2026

Copy link
Copy Markdown

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!)

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

IanEff commented Aug 25, 2026

Copy link
Copy Markdown
Author

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

@nixpanic nixpanic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread internal/nfs/types/volume.go
@nixpanic nixpanic added enhancement New feature or request component/nfs Issues related to NFS labels Aug 25, 2026
@IanEff

IanEff commented Aug 25, 2026

Copy link
Copy Markdown
Author

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
IanEff force-pushed the feat/nfs-export-names branch from c1fbc81 to 8d96c63 Compare August 25, 2026 13:13
@IanEff

IanEff commented Aug 25, 2026

Copy link
Copy Markdown
Author

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 nixpanic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
nixpanic requested a review from a team August 26, 2026 14:29
@nixpanic

Copy link
Copy Markdown
Member

@Mergifyio rebase

This will include the CI fixes.

@mergify

mergify Bot commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

rebase

🛑 The pull request rule doesn't match anymore

Details

This action has been cancelled.

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

Copy link
Copy Markdown
Member

GitHub Actions are not running due to an outage

image

@nixpanic

Copy link
Copy Markdown
Member

@Mergifyio rebase

GitHub Workflows should work again.

@mergify

mergify Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

rebase

🛑 The pull request rule doesn't match anymore

Details

This action has been cancelled.

IanEff and others added 2 commits August 27, 2026 13:28
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>
@ceph-csi-bot
ceph-csi-bot force-pushed the feat/nfs-export-names branch from 6dd8906 to e5d903a Compare August 27, 2026 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/nfs Issues related to NFS enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

nfs: allow users to specify NFS export name

2 participants