mirror of
https://github.com/ceph/ceph
synced 2025-04-01 23:02:17 +00:00
doc: fix mgr literal block rST syntax
Prior to this change, there were double-colon ("::") characters in the HTML docs to indicate literal blocks. The proceeding paragraphs were not pre-formatted because there was no newline between the double-colon and the to-be-pre-formatted paragraph. Move the "::" characters inline to simplify the syntax and make Sphinx properly interpret these texts as literal blocks. Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
This commit is contained in:
parent
f7a761ac22
commit
be7de7ab0d
doc/mgr
@ -5,23 +5,20 @@ ceph-mgr administrator's guide
|
||||
Setup
|
||||
-----
|
||||
|
||||
Create an authentication key for your daemon:
|
||||
Create an authentication key for your daemon::
|
||||
|
||||
::
|
||||
ceph auth get-or-create mgr.$name mon 'allow *'
|
||||
|
||||
Place that key into ``mgr data`` path, which for a cluster "ceph"
|
||||
and mgr $name "foo" would be ``/var/lib/ceph/mgr/ceph-foo``.
|
||||
|
||||
Start the ceph-mgr daemon:
|
||||
Start the ceph-mgr daemon::
|
||||
|
||||
::
|
||||
ceph-mgr -i $name
|
||||
|
||||
Check that the mgr has come up by looking at the output
|
||||
of ``ceph status``, which should now include a mgr status line:
|
||||
of ``ceph status``, which should now include a mgr status line::
|
||||
|
||||
::
|
||||
mgr active: $name
|
||||
|
||||
High availability
|
||||
@ -45,9 +42,7 @@ Calling module commands
|
||||
-----------------------
|
||||
|
||||
Where a module implements command line hooks, using the Ceph CLI's
|
||||
``tell`` command to call them like this:
|
||||
|
||||
::
|
||||
``tell`` command to call them like this::
|
||||
|
||||
ceph tell mgr <command | help>
|
||||
|
||||
|
@ -48,9 +48,8 @@ Exposing commands
|
||||
-----------------
|
||||
|
||||
Set the ``COMMANDS`` class attribute of your plugin to a list of dicts
|
||||
like this:
|
||||
like this::
|
||||
|
||||
::
|
||||
COMMANDS = [
|
||||
{
|
||||
"cmd": "foobar name=myarg,type=CephString",
|
||||
|
Loading…
Reference in New Issue
Block a user