From db9189a1d6ac7c7052602249b4b1007e9bc21621 Mon Sep 17 00:00:00 2001 From: Lenz Grimmer Date: Sun, 31 Mar 2019 13:32:15 -0500 Subject: [PATCH] doc: Updated dashboard iSCSI configuration, added labels Added note about the requirement for the latest ceph-iscsi version 3 to the dashboard documentation. Added some doc references and replaced some URLs in the iSCSI docs with reST labels instead. Signed-off-by: Lenz Grimmer (cherry picked from commit 71e46887d4b0f1afd7dc8af461879dc0f9440d50) --- doc/mgr/dashboard.rst | 14 ++++++++++---- doc/rados/configuration/ceph-conf.rst | 2 ++ doc/rbd/iscsi-overview.rst | 2 ++ doc/rbd/iscsi-requirements.rst | 7 ++++--- doc/releases/nautilus.rst | 4 ++-- doc/start/hardware-recommendations.rst | 2 ++ 6 files changed, 22 insertions(+), 9 deletions(-) diff --git a/doc/mgr/dashboard.rst b/doc/mgr/dashboard.rst index 9d99f25ee4517..0e2fd5a9aacaa 100644 --- a/doc/mgr/dashboard.rst +++ b/doc/mgr/dashboard.rst @@ -316,12 +316,18 @@ The default value is 45 seconds. Enabling iSCSI Management ^^^^^^^^^^^^^^^^^^^^^^^^^ -The Ceph Dashboard can manage iSCSI targets using the REST API provided -by the `rbd-target-api` service of the `ceph-iscsi `_ -project. Please make sure that it's installed and enabled on the iSCSI gateways. +The Ceph Dashboard can manage iSCSI targets using the REST API provided by the +`rbd-target-api` service of the :ref:`ceph-iscsi`. Please make sure that it's +installed and enabled on the iSCSI gateways. + +.. note:: + The iSCSI management functionality of Ceph Dashboard depends on the latest + version 3 of the `ceph-iscsi `_ project. + Make sure that your operating system provides the correct version, otherwise + the dashboard won't enable the managemement features. If ceph-iscsi REST API is configured in HTTPS mode and its using a self-signed -certificate, then we need to configure the dashboard to avoid SSL certificate +certificate, then you need to configure the dashboard to avoid SSL certificate verification when accessing ceph-iscsi API. To disable API SSL verification run the following commmand:: diff --git a/doc/rados/configuration/ceph-conf.rst b/doc/rados/configuration/ceph-conf.rst index 09c8e973da3ea..5b7264a8c765a 100644 --- a/doc/rados/configuration/ceph-conf.rst +++ b/doc/rados/configuration/ceph-conf.rst @@ -1,3 +1,5 @@ +.. _configuring-ceph: + ================== Configuring Ceph ================== diff --git a/doc/rbd/iscsi-overview.rst b/doc/rbd/iscsi-overview.rst index 6383982919bd1..034dc1bc7330e 100644 --- a/doc/rbd/iscsi-overview.rst +++ b/doc/rbd/iscsi-overview.rst @@ -1,3 +1,5 @@ +.. _ceph-iscsi: + ================== Ceph iSCSI Gateway ================== diff --git a/doc/rbd/iscsi-requirements.rst b/doc/rbd/iscsi-requirements.rst index 973fac05cf663..57e42be90e415 100644 --- a/doc/rbd/iscsi-requirements.rst +++ b/doc/rbd/iscsi-requirements.rst @@ -6,8 +6,8 @@ To implement the Ceph iSCSI gateway there are a few requirements. It is recommen to use two to four iSCSI gateway nodes for a highly available Ceph iSCSI gateway solution. -For hardware recommendations, see the `Hardware Recommendation page `_ -for more details. +For hardware recommendations, see :ref:`hardware-recommendations` for more +details. .. note:: On the iSCSI gateway nodes, the memory footprint of the RBD images @@ -46,4 +46,5 @@ cluster:: ceph daemon osd.0 config set osd_heartbeat_grace 20 ceph daemon osd.0 config set osd_heartbeat_interval 5 -For more details on setting Ceph's configuration options, see the `Configuration page `_. +For more details on setting Ceph's configuration options, see +:ref:`configuring-ceph`. diff --git a/doc/releases/nautilus.rst b/doc/releases/nautilus.rst index 4ac6b9a390e83..145f2d158077e 100644 --- a/doc/releases/nautilus.rst +++ b/doc/releases/nautilus.rst @@ -13,7 +13,7 @@ Major Changes from Mimic - *Dashboard*: - The Ceph Dashboard has gained a lot of new functionality: + The :ref:`mgr-dashboard` has gained a lot of new functionality: * Support for multiple users / roles * SSO (SAMLv2) for user authentication @@ -32,7 +32,7 @@ Major Changes from Mimic * Embedded Grafana Dashboards (derived from Ceph Metrics) * CRUSH map viewer * NFS Ganesha management - * iSCSI target management (via ceph-iscsi) + * iSCSI target management (via :ref:`ceph-iscsi`) * RBD QoS configuration * Ceph Manager (ceph-mgr) module management * Prometheus alert Management diff --git a/doc/start/hardware-recommendations.rst b/doc/start/hardware-recommendations.rst index a92c476d81895..30e00a892461a 100644 --- a/doc/start/hardware-recommendations.rst +++ b/doc/start/hardware-recommendations.rst @@ -1,3 +1,5 @@ +.. _hardware-recommendations: + ========================== Hardware Recommendations ========================== -- 2.39.5