nfs: make rados.namespace optional

Fix the CephNFS spec.rados API specifiation to be clear that spec.rados is optional for all Ceph v16 versions, including that spec.rados.namespace is optional. Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
rook · Dec 8, 2021 · 0bbab6d · 0bbab6d
1 parent 6ad2026
commit 0bbab6d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 13 deletions.
diff --git a/deploy/charts/rook-ceph/templates/resources.yaml b/deploy/charts/rook-ceph/templates/resources.yaml
@@ -6008,13 +6008,11 @@ spec:
                   nullable: true
                   properties:
                     namespace:
-                      description: Namespace is the RADOS namespace where NFS client recovery data is stored.
+                      description: The namespace inside the Ceph pool (set by 'pool') where shared NFS-Ganesha config is stored. This setting is required for Ceph v15 and ignored for Ceph v16. As of Ceph Pacific v16+, this is internally set to the name of the CephNFS.
                       type: string
                     pool:
-                      description: Pool used to represent the Ganesha's pool name in version older than 16.2.7 As of Ceph Pacific 16.2.7, NFS Ganesha's pool name is hardcoded to ".nfs", so this setting will be ignored.
+                      description: The Ceph pool used store the shared configuration for NFS-Ganesha daemons. This setting is required for Ceph v15 and ignored for Ceph v16. As of Ceph Pacific 16.2.7+, this is internally hardcoded to ".nfs".
                       type: string
-                  required:
-                    - namespace
                   type: object
                 server:
                   description: Server is the Ganesha Server specification

diff --git a/deploy/examples/crds.yaml b/deploy/examples/crds.yaml
@@ -6004,13 +6004,11 @@ spec:
                   nullable: true
                   properties:
                     namespace:
-                      description: Namespace is the RADOS namespace where NFS client recovery data is stored.
+                      description: The namespace inside the Ceph pool (set by 'pool') where shared NFS-Ganesha config is stored. This setting is required for Ceph v15 and ignored for Ceph v16. As of Ceph Pacific v16+, this is internally set to the name of the CephNFS.
                       type: string
                     pool:
-                      description: Pool used to represent the Ganesha's pool name in version older than 16.2.7 As of Ceph Pacific 16.2.7, NFS Ganesha's pool name is hardcoded to ".nfs", so this setting will be ignored.
+                      description: The Ceph pool used store the shared configuration for NFS-Ganesha daemons. This setting is required for Ceph v15 and ignored for Ceph v16. As of Ceph Pacific 16.2.7+, this is internally hardcoded to ".nfs".
                       type: string
-                  required:
-                    - namespace
                   type: object
                 server:
                   description: Server is the Ganesha Server specification

diff --git a/pkg/apis/ceph.rook.io/v1/types.go b/pkg/apis/ceph.rook.io/v1/types.go
@@ -1812,14 +1812,17 @@ type NFSGaneshaSpec struct {
 
 // GaneshaRADOSSpec represents the specification of a Ganesha RADOS object
 type GaneshaRADOSSpec struct {
-	// Pool used to represent the Ganesha's pool name in version older than 16.2.7
-	// As of Ceph Pacific 16.2.7, NFS Ganesha's pool name is hardcoded to ".nfs", so this
-	// setting will be ignored.
+	// The Ceph pool used store the shared configuration for NFS-Ganesha daemons.
+	// This setting is required for Ceph v15 and ignored for Ceph v16.
+	// As of Ceph Pacific 16.2.7+, this is internally hardcoded to ".nfs".
 	// +optional
 	Pool string `json:"pool,omitempty"`
 
-	// Namespace is the RADOS namespace where NFS client recovery data is stored.
-	Namespace string `json:"namespace"`
+	// The namespace inside the Ceph pool (set by 'pool') where shared NFS-Ganesha config is stored.
+	// This setting is required for Ceph v15 and ignored for Ceph v16.
+	// As of Ceph Pacific v16+, this is internally set to the name of the CephNFS.
+	// +optional
+	Namespace string `json:"namespace,omitempty"`
 }
 
 // GaneshaServerSpec represents the specification of a Ganesha Server