From 7d781f7a09479c5f049cb665968f683c77e5d890 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Fri, 4 Sep 2015 15:59:34 -0400 Subject: [PATCH] doc: 'ceph --admin-daemon ...' -> 'ceph daemon ...' Signed-off-by: Sage Weil --- doc/dev/mon-bootstrap.rst | 4 ++-- doc/dev/perf_counters.rst | 4 ++-- doc/man/8/ceph.rst | 4 ++-- doc/rados/operations/monitoring.rst | 10 ++++++++-- doc/rados/troubleshooting/log-and-debug.rst | 11 +++++++---- doc/rados/troubleshooting/troubleshooting-mon.rst | 4 ++-- doc/rados/troubleshooting/troubleshooting-osd.rst | 11 ++++++++--- doc/radosgw/troubleshooting.rst | 6 +++--- 8 files changed, 34 insertions(+), 20 deletions(-) diff --git a/doc/dev/mon-bootstrap.rst b/doc/dev/mon-bootstrap.rst index 3c0a3ddc96c17..86f06dcaada37 100644 --- a/doc/dev/mon-bootstrap.rst +++ b/doc/dev/mon-bootstrap.rst @@ -146,7 +146,7 @@ their own address). For example:: When these daemons are started, they will know their own address, but not their peers. They can learn those addresses via the admin socket:: - ceph --admin-daemon /var/run/ceph/mon..asok add_bootstrap_peer_hint + ceph mon. add_bootstrap_peer_hint Once they learn enough of their peers from the initial member set, they will be able to create the cluster. @@ -174,7 +174,7 @@ example:: Once the daemon starts, you can give it one or more peer addresses to join with:: - ceph --admin-daemon /var/run/ceph/mon..asok add_bootstrap_peer_hint + ceph daemon mon. add_bootstrap_peer_hint This monitor will never participate in cluster creation; it can only join an existing cluster. diff --git a/doc/dev/perf_counters.rst b/doc/dev/perf_counters.rst index 6e004391457e8..91589f47a9dee 100644 --- a/doc/dev/perf_counters.rst +++ b/doc/dev/perf_counters.rst @@ -11,8 +11,8 @@ Access The perf counter data is accessed via the admin socket. For example:: - ceph --admin-daemon /var/run/ceph/ceph-osd.0.asok perf schema - ceph --admin-daemon /var/run/ceph/ceph-osd.0.asok perf dump + ceph daemon osd.0 perf schema + ceph daemon osd.0 perf dump Collections diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst index 38d782d9f6cf3..37bb897262631 100644 --- a/doc/man/8/ceph.rst +++ b/doc/man/8/ceph.rst @@ -1365,9 +1365,9 @@ Options Name of the Ceph cluster. -.. option:: --admin-daemon ADMIN_SOCKET +.. option:: daemon ADMIN_SOCKET, daemon DAEMON_NAME, --admin-socket ADMIN_SOCKET, --admin-socket DAEMON_NAME - Submit admin-socket commands. + Submit admin-socket commands via admin sockets in /var/run/ceph. .. option:: --admin-socket ADMIN_SOCKET_NOPE diff --git a/doc/rados/operations/monitoring.rst b/doc/rados/operations/monitoring.rst index c269e99bf89db..1ea3231ba544a 100644 --- a/doc/rados/operations/monitoring.rst +++ b/doc/rados/operations/monitoring.rst @@ -267,11 +267,17 @@ By default, Ceph sockets reside under ``/var/run/ceph``. To access a daemon via the admin socket, login to the host running the daemon and use the following command:: - ceph --admin-daemon /var/run/ceph/{socket-name} + ceph daemon {daemon-name} + ceph daemon {path-to-socket-file} + +For example, the following are equivalent:: + + ceph daemon osd.0 foo + ceph daemon /var/run/ceph/ceph-osd.0.asok foo To view the available admin socket commands, execute the following command:: - ceph --admin-daemon /var/run/ceph/{socket-name} help + ceph daemon {daemon-name} help The admin socket command enables you to show and set your configuration at runtime. See `Viewing a Configuration at Runtime`_ for details. diff --git a/doc/rados/troubleshooting/log-and-debug.rst b/doc/rados/troubleshooting/log-and-debug.rst index 1b9317a3c7b77..d618a880d95f3 100644 --- a/doc/rados/troubleshooting/log-and-debug.rst +++ b/doc/rados/troubleshooting/log-and-debug.rst @@ -34,8 +34,11 @@ Runtime If you would like to see the configuration settings at runtime, you must log in to a host with a running daemon and execute the following:: - ceph --admin-daemon {/path/to/admin/socket} config show | less - ceph --admin-daemon /var/run/ceph/ceph-osd.0.asok config show | less + ceph daemon {daemon-name} config show | less + +For example,:: + + ceph daemon osd.0 config show | less To activate Ceph's debugging output (*i.e.*, ``dout()``) at runtime, use the ``ceph tell`` command to inject arguments into the runtime configuration:: @@ -51,10 +54,10 @@ debug logging for a ``ceph-osd`` daemon named ``osd.0``, execute the following:: The ``ceph tell`` command goes through the monitors. If you cannot bind to the monitor, you can still make the change by logging into the host of the daemon -whose configuration you'd like to change using ``ceph --admin-daemon``. +whose configuration you'd like to change using ``ceph daemon``. For example:: - sudo ceph --admin-daemon /var/run/ceph/ceph-osd.0.asok config set debug_osd 0/5 + sudo ceph daemon osd.0 config set debug_osd 0/5 See `Subsystem, Log and Debug Settings`_ for details on available settings. diff --git a/doc/rados/troubleshooting/troubleshooting-mon.rst b/doc/rados/troubleshooting/troubleshooting-mon.rst index dff673b39bddd..4dcd5a429b734 100644 --- a/doc/rados/troubleshooting/troubleshooting-mon.rst +++ b/doc/rados/troubleshooting/troubleshooting-mon.rst @@ -82,12 +82,12 @@ admin socket, with ``ceph`` likely returning ``Error 111: Connection Refused``. Accessing the admin socket is as simple as telling the ``ceph`` tool to use the ``asok`` file. In pre-Dumpling Ceph, this can be achieved by:: - ceph --admin-daemon /var/run/ceph/ceph-mon.ID.asok + ceph --admin-daemon /var/run/ceph/ceph-mon..asok while in Dumpling and beyond you can use the alternate (and recommended) format:: - ceph daemon mon.ID + ceph daemon mon. Using ``help`` as the command to the ``ceph`` tool will show you the supported commands available through the admin socket. Please take a look diff --git a/doc/rados/troubleshooting/troubleshooting-osd.rst b/doc/rados/troubleshooting/troubleshooting-osd.rst index 1cbdaeec8e29a..e1fb30e8320e3 100644 --- a/doc/rados/troubleshooting/troubleshooting-osd.rst +++ b/doc/rados/troubleshooting/troubleshooting-osd.rst @@ -42,10 +42,15 @@ the sockets for your Ceph processes:: ls /var/run/ceph -Then, execute the following, replacing ``{socket-name}`` with an actual -socket name to show the list of available options:: +Then, execute the following, replacing ``{daemon-name}`` with an actual +daemon (e.g., ``osd.0``):: + + ceph daemon osd.0 help + +Alternatively, you can specify a ``{socket-file}`` (e.g., something in ``/var/run/ceph``):: + + ceph daemon {socket-file} help - ceph --admin-daemon /var/run/ceph/{socket-name} help The admin socket, among other things, allows you to: diff --git a/doc/radosgw/troubleshooting.rst b/doc/radosgw/troubleshooting.rst index 84f17607b75b9..3e4a057776889 100644 --- a/doc/radosgw/troubleshooting.rst +++ b/doc/radosgw/troubleshooting.rst @@ -56,7 +56,7 @@ some insight into the internal state of the ``radosgw`` daemon via its admin socket. By default, there will be a socket configured to reside in ``/var/run/ceph``, and the daemon can be queried with:: - ceph --admin-daemon /var/run/ceph/client.rgw help + ceph daemon /var/run/ceph/client.rgw help help list available commands objecter_requests show in-progress osd requests @@ -66,7 +66,7 @@ reside in ``/var/run/ceph``, and the daemon can be queried with:: Of particular interest:: - ceph --admin-daemon /var/run/ceph/client.rgw objecter_requests + ceph daemon /var/run/ceph/client.rgw objecter_requests ... will dump information about current in-progress requests with the @@ -114,7 +114,7 @@ check the OSD status with:: This tells us to look at ``osd.1``, the primary copy for this PG:: - ceph --admin-daemon /var/run/ceph/osd.1.asok + ceph daemon osd.1 ops { "num_ops": 651, "ops": [ { "description": "osd_op(client.4124.0:1858 fatty_25647_object1857 [write 0~4096] 2.d2041a48)", -- 2.39.5