doc/cephadm: linking to log material

This PR rewrites a section in the Troubleshooting
chapter of the Cephadm Guide. The material that this
section discusses has been covered already in the
Cephadm Guide in the Cephadm Operations chapter.
There's no reason to repeat this information twice,
unless adding technical debt to the documentation
is our goal (which of course it is not, and the
opposite of adding technical debt to the documentation
has been the aim that has guided my work these past
six months).

Signed-off-by: Zac Dover <zac.dover@gmail.com>

diff --git a/doc/cephadm/operations.rst b/doc/cephadm/operations.rst
index ed8b8696fc5571f47fc987208d8566ff73f78576..e5f59ccf9299912375062f3b8870df743090f478 100644 (file)
--- a/doc/cephadm/operations.rst
+++ b/doc/cephadm/operations.rst
@@ -2,6 +2,8 @@
 Cephadm Operations
 ==================
 
+.. _watching_cephadm_logs:
+
 Watching cephadm log messages
 =============================
 
@@ -15,7 +17,7 @@ up. Run the following command to see the logs in real time:
 
 By default, this command shows info-level events and above.  To see
 debug-level messages as well as info-level events, run the following
-command:
+commands:
 
 .. prompt:: bash #
 

diff --git a/doc/cephadm/troubleshooting.rst b/doc/cephadm/troubleshooting.rst
index 1f1b52468af7863a9880f523076a79ac8fff046e..1b6764dd7628fab9be54c68ab80e00edb1fed35d 100644 (file)
--- a/doc/cephadm/troubleshooting.rst
+++ b/doc/cephadm/troubleshooting.rst
@@ -109,16 +109,11 @@ This will return something in the following form:
 Checking cephadm logs
 ---------------------
 
-You can monitor the cephadm log in real time with::
+To learn how to monitor the cephadm logs as they are generated, read :ref:`watching_cephadm_logs`.
 
-  ceph -W cephadm
-
-You can see the last few messages with::
-
-  ceph log last cephadm
-
-If you have enabled logging to files, you can see a cephadm log file called
-``ceph.cephadm.log`` on monitor hosts (see :ref:`cephadm-logs`).
+If your Ceph cluster has been configured to log events to files, there will exist a
+cephadm log file called ``ceph.cephadm.log`` on all monitor hosts (see
+:ref:`cephadm-logs` for a more complete explanation of this).
 
 Gathering log files
 -------------------