]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephadm: enrich "service status"
authorZac Dover <zac.dover@gmail.com>
Thu, 27 May 2021 01:28:38 +0000 (11:28 +1000)
committerSage Weil <sage@newdream.net>
Thu, 3 Jun 2021 12:42:31 +0000 (07:42 -0500)
This PR improves the syntax of the "Service
Status" section of the "Service Managment"
section of the cephadm guide. This includes
pretty significant reworking of the information
in the section, so vetting this one might be
annoying. Anyway, I think I've lowered the
cognitive load on the reader.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 31558e5568da5b445b2da1b98ac2eb626d8efdf3)

doc/cephadm/service-management.rst

index e3baf87bac8d434e3055c95ac944bbb2f081f47a..fb8a35c131cc640ec437b0783d7cfea4e41d2d1d 100644 (file)
@@ -5,31 +5,38 @@ Service Management
 Service Status
 ==============
 
-A service is a group of daemons that are configured together.
+A service is a group of daemons configured together. To see the status of one
+of the services running in the Ceph cluster, do the following:
 
-Print a list of services known to the orchestrator. The list can be limited to
-services on a particular host with the optional --host parameter and/or
-services of a particular type via optional --type parameter
-(mon, osd, mgr, mds, rgw):
+#. Use the command line to print a list of services. 
+#. Locate the service whose status you want to check. 
+#. Print the status of the service.
+
+The following command prints a list of services known to the orchestrator. To
+limit the output to services only on a specified host, use the optional
+``--host`` parameter. To limit the output to services of only a particular
+type, use the optional ``--type`` parameter (mon, osd, mgr, mds, rgw):
 
    .. prompt:: bash #
 
-    ceph orch ls [--service_type type] [--service_name name] [--export] [--format f] [--refresh]
+     ceph orch ls [--service_type type] [--service_name name] [--export] [--format f] [--refresh]
 
-Discover the status of a particular service or daemons:
+Discover the status of a particular service or daemon:
 
    .. prompt:: bash #
 
-    ceph orch ls --service_type type --service_name <name> [--refresh]
+     ceph orch ls --service_type type --service_name <name> [--refresh]
 
-Export the service specs known to the orchestrator as yaml in format
-that is compatible to ``ceph orch apply -i``:
+To export the service specifications knows to the orchestrator, run the following command.
 
    .. prompt:: bash #
 
-    ceph orch ls --export
+     ceph orch ls --export
+
+The service specifications exported with this command will be exported as yaml
+and that yaml can be used with the ``ceph orch apply -i`` command.
 
-For examples about retrieving specs of single services see :ref:`orchestrator-cli-service-spec-retrieve`.
+For information about retrieving the specifications of single services (including examples of commands), see :ref:`orchestrator-cli-service-spec-retrieve`.
 
 Daemon Status
 =============