From 8399e61b0e6e4ceb502530877f1cecc4b9611896 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Alfonso=20Mart=C3=ADnez?= Date: Thu, 22 Apr 2021 14:10:25 +0200 Subject: [PATCH] mgr/dashboard: update documentation about creating NFS export. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit - You learn first that orchestrator-managed clusters are detected automatically (therefore the documentation that follows is exclusively for user-defined clusters). - Include nfs-ganesha in the security scope list. Fixes: https://tracker.ceph.com/issues/50440 Signed-off-by: Alfonso Martínez (cherry picked from commit 335a91d20d2e0ec68ddbda6d94f9e90dea16114f) --- doc/mgr/dashboard.rst | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index 1044b18d528e8..32d02fd4a6bec 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -975,6 +975,7 @@ scopes are: - **iscsi**: includes all features related to iSCSI management. - **rgw**: includes all features related to RADOS Gateway (RGW) management. - **cephfs**: includes all features related to CephFS management. +- **nfs-ganesha**: includes all features related to NFS Ganesha management. - **manager**: include all features related to Ceph Manager management. - **log**: include all features related to Ceph logs management. @@ -1211,7 +1212,26 @@ A log entry may look like this:: NFS-Ganesha Management ---------------------- -The Ceph Dashboard can manage `NFS Ganesha `_ exports that use +Support for NFS-Ganesha Clusters Deployed by the Orchestrator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The Ceph Dashboard can be used to manage NFS-Ganesha clusters deployed by the +Orchestrator and will detect them automatically. For more details +on deploying NFS-Ganesha clusters with the Orchestrator, please see: + +- Cephadm backend: :ref:`orchestrator-cli-stateless-services`. Or particularly, see + :ref:`deploy-cephadm-nfs-ganesha`. +- Rook backend: `Ceph NFS Gateway CRD `_. + +Support for NFS-Ganesha Clusters Defined by the User +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. note:: + + This configuration only applies for user-defined clusters, + NOT for Orchestrator-deployed clusters. + +The Ceph Dashboard can manage `NFS Ganesha `_ exports that use CephFS or RGW as their backstore. To enable this feature in Ceph Dashboard there are some assumptions that need @@ -1284,16 +1304,6 @@ When configuring the Ceph Dashboard with multiple NFS-Ganesha clusters, the Web UI will allow you to choose to which cluster an export belongs. -Support for NFS-Ganesha Clusters Deployed by the Orchestrator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The Ceph Dashboard can be used to manage NFS-Ganesha clusters deployed by the -Orchestrator and will detect them automatically. For more details -on deploying NFS-Ganesha clusters with the Orchestrator, please see :ref:`orchestrator-cli-stateless-services`. -Or particularly, see :ref:`deploy-cephadm-nfs-ganesha` for how to deploy -NFS-Ganesha clusters with the Cephadm backend. - - Plug-ins -------- -- 2.39.5