From a7c818026ebedfa5ea4362f5b317b93596f88c6c Mon Sep 17 00:00:00 2001 From: Sebastian Wagner Date: Sat, 11 Sep 2021 20:02:44 +0200 Subject: [PATCH] doc/cephadm: Add lots of links to other chapters Signed-off-by: Sebastian Wagner (cherry picked from commit d9ec8eb7a8da3c7dff40d7ed89feaebf7cadd37d) --- doc/cephadm/iscsi.rst | 5 +++++ doc/cephadm/mds.rst | 3 +++ doc/cephadm/mon.rst | 10 +++++++++- doc/cephadm/nfs.rst | 6 ++++++ doc/cephadm/osd.rst | 6 ++++++ doc/cephadm/rgw.rst | 7 +++++++ doc/cephadm/troubleshooting.rst | 2 ++ doc/cephfs/nfs.rst | 2 ++ doc/rados/index.rst | 2 ++ doc/rados/operations/index.rst | 2 ++ doc/rados/troubleshooting/troubleshooting-mon.rst | 2 ++ 11 files changed, 46 insertions(+), 1 deletion(-) diff --git a/doc/cephadm/iscsi.rst b/doc/cephadm/iscsi.rst index d34ff6abfa615..581d2c9d40612 100644 --- a/doc/cephadm/iscsi.rst +++ b/doc/cephadm/iscsi.rst @@ -67,3 +67,8 @@ The specification can then be applied using: See :ref:`orchestrator-cli-placement-spec` for details of the placement specification. + +Further Reading +=============== + +* RBD: :ref:`ceph-iscsi` diff --git a/doc/cephadm/mds.rst b/doc/cephadm/mds.rst index fbee8d6bdc297..949a0fa5d8e7a 100644 --- a/doc/cephadm/mds.rst +++ b/doc/cephadm/mds.rst @@ -41,6 +41,9 @@ The specification can then be applied using: See :ref:`orchestrator-cli-stateless-services` for manually deploying MDS daemons on the CLI. +Further Reading +=============== +* :ref:`ceph-file-system` diff --git a/doc/cephadm/mon.rst b/doc/cephadm/mon.rst index e66df6171269d..6326b73f46d39 100644 --- a/doc/cephadm/mon.rst +++ b/doc/cephadm/mon.rst @@ -5,7 +5,7 @@ MON Service .. _deploy_additional_monitors: Deploying additional monitors ------------------------------ +============================= A typical Ceph cluster has three or five monitor daemons that are spread across different hosts. We recommend deploying five monitors if there are @@ -169,3 +169,11 @@ network ``10.1.2.0/24``, run the following commands: .. prompt:: bash # ceph orch apply mon --placement="newhost1,newhost2,newhost3" + +Futher Reading +============== + +* :ref:`rados-operations` +* :ref:`rados-troubleshooting-mon` +* :ref:`cephadm-restore-quorum` + diff --git a/doc/cephadm/nfs.rst b/doc/cephadm/nfs.rst index 99b7e35c59eee..c48d0f7658f71 100644 --- a/doc/cephadm/nfs.rst +++ b/doc/cephadm/nfs.rst @@ -112,3 +112,9 @@ A few notes: * The backend service (``nfs.mynfs`` in this example) should include a *port* property that is not 2049 to avoid conflicting with the ingress service, which could be placed on the same host(s). + +Further Reading +=============== + +* CephFS: :ref:`cephfs-nfs` +* MGR: :ref:`mgr-nfs` diff --git a/doc/cephadm/osd.rst b/doc/cephadm/osd.rst index f0bf47cfe547c..1c2b36e71d5d5 100644 --- a/doc/cephadm/osd.rst +++ b/doc/cephadm/osd.rst @@ -880,3 +880,9 @@ activates all existing OSDs on a host. ceph cephadm osd activate ... This will scan all existing disks for OSDs and deploy corresponding daemons. + +Futher Reading +============== + +* :ref:`ceph-volume` +* :ref:`rados-index` diff --git a/doc/cephadm/rgw.rst b/doc/cephadm/rgw.rst index 3283fdbdf2b51..75387742d6ff0 100644 --- a/doc/cephadm/rgw.rst +++ b/doc/cephadm/rgw.rst @@ -82,6 +82,8 @@ something like: See :ref:`orchestrator-cli-placement-spec` for details of the placement specification. See :ref:`multisite` for more information of setting up multisite RGW. +See also :ref:`multisite`. + Setting up HTTPS ---------------- @@ -250,3 +252,8 @@ Useful hints for ingress * It is good to have at least 3 RGW daemons. * We recommend at least 3 hosts for the ingress service. + +Further Reading +=============== + +* :ref:`object-gateway` diff --git a/doc/cephadm/troubleshooting.rst b/doc/cephadm/troubleshooting.rst index 1b6764dd7628f..4dfe3e6296221 100644 --- a/doc/cephadm/troubleshooting.rst +++ b/doc/cephadm/troubleshooting.rst @@ -253,6 +253,8 @@ To access the admin socket, first enter the daemon container on the host:: [ceph: root@mon1 /]# ceph --admin-daemon /var/run/ceph/ceph-.asok config show +.. _cephadm-restore-quorum: + Restoring the MON quorum ------------------------ diff --git a/doc/cephfs/nfs.rst b/doc/cephfs/nfs.rst index a34151fbc51f6..6c44b86504226 100644 --- a/doc/cephfs/nfs.rst +++ b/doc/cephfs/nfs.rst @@ -1,3 +1,5 @@ +.. _cephfs-nfs: + === NFS === diff --git a/doc/rados/index.rst b/doc/rados/index.rst index 27d1daad14e4d..5f3f112e8544b 100644 --- a/doc/rados/index.rst +++ b/doc/rados/index.rst @@ -1,3 +1,5 @@ +.. _rados-index: + ====================== Ceph Storage Cluster ====================== diff --git a/doc/rados/operations/index.rst b/doc/rados/operations/index.rst index c8dff51a1fbc6..2136918c724cf 100644 --- a/doc/rados/operations/index.rst +++ b/doc/rados/operations/index.rst @@ -1,3 +1,5 @@ +.. _rados-operations: + ==================== Cluster Operations ==================== diff --git a/doc/rados/troubleshooting/troubleshooting-mon.rst b/doc/rados/troubleshooting/troubleshooting-mon.rst index 48e3483916c07..7bbc72e13660d 100644 --- a/doc/rados/troubleshooting/troubleshooting-mon.rst +++ b/doc/rados/troubleshooting/troubleshooting-mon.rst @@ -1,3 +1,5 @@ +.. _rados-troubleshooting-mon: + ================================= Troubleshooting Monitors ================================= -- 2.39.5