]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados/ops: line-edit operating.rst 50928/head
authorZac Dover <zac.dover@proton.me>
Fri, 7 Apr 2023 00:46:50 +0000 (10:46 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 7 Apr 2023 00:46:50 +0000 (10:46 +1000)
Line-edit doc/rados/operations/operating.rst.

https://tracker.ceph.com/issues/58485

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/rados/operations/operating.rst

index 60855a8eaf52e3de07aeb5041116a71dfcb6ac99..f4a2fd98879f7c64d95b4e11d3bb9aebe515da48 100644 (file)
@@ -6,50 +6,52 @@
 
 
 Running Ceph with systemd
-==========================
+=========================
 
-For all distributions that support systemd (CentOS 7, Fedora, Debian
-Jessie 8 and later, SUSE), ceph daemons are now managed using native
-systemd files instead of the legacy sysvinit scripts.  For example:
+In all distributions that support systemd (CentOS 7, Fedora, Debian
+Jessie 8 and later, and SUSE), systemd files (and NOT legacy SysVinit scripts) 
+are used to manage Ceph daemons. Ceph daemons therefore behave like any other daemons 
+that can be controlled by the ``systemctl`` command, as in the following examples:
 
 .. prompt:: bash $
 
    sudo systemctl start ceph.target       # start all daemons
    sudo systemctl status ceph-osd@12      # check status of osd.12
 
-To list the Ceph systemd units on a node, execute:
+To list all of the Ceph systemd units on a node, run the following command:
 
 .. prompt:: bash $
 
    sudo systemctl status ceph\*.service ceph\*.target
 
-Starting all Daemons
+
+Starting all daemons
 --------------------
 
-To start all daemons on a Ceph Node (irrespective of type), execute the
-following:
+To start all of the daemons on a Ceph node (regardless of their type), run the
+following command:
 
 .. prompt:: bash $
 
    sudo systemctl start ceph.target
 
 
-Stopping all Daemons
+Stopping all daemons
 --------------------
 
-To stop all daemons on a Ceph Node (irrespective of type), execute the
-following:
+To stop all of the daemons on a Ceph node (regardless of their type), run the
+following command:
 
 .. prompt:: bash $
 
    sudo systemctl stop ceph\*.service ceph\*.target
 
 
-Starting all Daemons by Type
+Starting all daemons by type
 ----------------------------
 
-To start all daemons of a particular type on a Ceph Node, execute one of the
-following:
+To start all of the daemons of a particular type on a Ceph node, run one of the
+following commands:
 
 .. prompt:: bash $
 
@@ -58,24 +60,24 @@ following:
    sudo systemctl start ceph-mds.target
 
 
-Stopping all Daemons by Type
+Stopping all daemons by type
 ----------------------------
 
-To stop all daemons of a particular type on a Ceph Node, execute one of the
-following:
+To stop all of the daemons of a particular type on a Ceph node, run one of the
+following commands:
 
 .. prompt:: bash $
 
-   sudo systemctl stop ceph-mon\*.service ceph-mon.target
    sudo systemctl stop ceph-osd\*.service ceph-osd.target
+   sudo systemctl stop ceph-mon\*.service ceph-mon.target
    sudo systemctl stop ceph-mds\*.service ceph-mds.target
 
 
-Starting a Daemon
+Starting a daemon
 -----------------
 
-To start a specific daemon instance on a Ceph Node, execute one of the
-following:
+To start a specific daemon instance on a Ceph node, run one of the
+following commands:
 
 .. prompt:: bash $
 
@@ -92,11 +94,11 @@ For example:
    sudo systemctl start ceph-mds@ceph-server
 
 
-Stopping a Daemon
+Stopping a daemon
 -----------------
 
-To stop a specific daemon instance on a Ceph Node, execute one of the
-following:
+To stop a specific daemon instance on a Ceph node, run one of the
+following commands:
 
 .. prompt:: bash $
 
@@ -115,15 +117,14 @@ For example:
 
 .. index:: sysvinit; operating a cluster
 
-Running Ceph with sysvinit
+Running Ceph with SysVinit
 ==========================
 
-Each time you to **start**, **restart**, and  **stop** Ceph daemons (or your
-entire cluster) you must specify at least one option and one command. You may
-also specify a daemon type or a daemon instance. ::
-
-       {commandline} [options] [commands] [daemons]
+Each time you start, restart, or stop Ceph daemons, you must specify at least one option and one command.
+Likewise, each time you start, restart, or stop your entire cluster, you must specify at least one option and one command.
+In both cases, you can also specify a daemon type or a daemon instance. ::
 
+    {commandline} [options] [commands] [daemons]
 
 The ``ceph`` options include:
 
@@ -134,12 +135,12 @@ The ``ceph`` options include:
 +-----------------+----------+-------------------------------------------------+
 | ``--valgrind``  | ``N/A``  | (Dev and QA only) Use `Valgrind`_ debugging.    |
 +-----------------+----------+-------------------------------------------------+
-| ``--allhosts``  |  ``-a``  | Execute on all nodes in ``ceph.conf.``          |
+| ``--allhosts``  |  ``-a``  | Execute on all nodes listed in ``ceph.conf``.   |
 |                 |          | Otherwise, it only executes on ``localhost``.   |
 +-----------------+----------+-------------------------------------------------+
 | ``--restart``   | ``N/A``  | Automatically restart daemon if it core dumps.  |
 +-----------------+----------+-------------------------------------------------+
-| ``--norestart`` | ``N/A``  | Don't restart a daemon if it core dumps.        |
+| ``--norestart`` | ``N/A``  | Do not restart a daemon if it core dumps.       |
 +-----------------+----------+-------------------------------------------------+
 | ``--conf``      |  ``-c``  | Use an alternate configuration file.            |
 +-----------------+----------+-------------------------------------------------+
@@ -153,24 +154,21 @@ The ``ceph`` commands include:
 +------------------+------------------------------------------------------------+
 |    ``stop``      | Stop the daemon(s).                                        |
 +------------------+------------------------------------------------------------+
-|  ``forcestop``   | Force the daemon(s) to stop. Same as ``kill -9``           |
+|  ``forcestop``   | Force the daemon(s) to stop. Same as ``kill -9``.          |
 +------------------+------------------------------------------------------------+
-|   ``killall``    | Kill all daemons of a particular type.                     | 
+|   ``killall``    | Kill all daemons of a particular type.                     |
 +------------------+------------------------------------------------------------+
 |  ``cleanlogs``   | Cleans out the log directory.                              |
 +------------------+------------------------------------------------------------+
 | ``cleanalllogs`` | Cleans out **everything** in the log directory.            |
 +------------------+------------------------------------------------------------+
 
-For subsystem operations, the ``ceph`` service can target specific daemon types
-by adding a particular daemon type for the ``[daemons]`` option. Daemon types
-include: 
+The ``[daemons]`` option allows the ``ceph`` service to target specific daemon types
+in order to perform subsystem operations. Daemon types include:
 
 - ``mon``
 - ``osd``
 - ``mds``
 
-
-
 .. _Valgrind: http://www.valgrind.org/
 .. _initctl: http://manpages.ubuntu.com/manpages/raring/en/man8/initctl.8.html