From: Travis Rhoden Date: Thu, 19 Mar 2015 19:17:36 +0000 (-0400) Subject: Don't use backticks in section headers X-Git-Tag: v1.5.23~9^2~5 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=35f17428f8e4e959730ea33572ecbb6d5b107772;p=ceph-deploy.git Don't use backticks in section headers They are not needed, and actually cause funny formatting issues. Signed-off-by: Travis Rhoden --- diff --git a/docs/source/install.rst b/docs/source/install.rst index bd900cd..8b3710d 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -1,7 +1,7 @@ .. _install: -``install`` +install =========== A few different distributions are supported with some flags to allow some customization for installing ceph on remote nodes. diff --git a/docs/source/mds.rst b/docs/source/mds.rst index ad85d6c..c7b1b10 100644 --- a/docs/source/mds.rst +++ b/docs/source/mds.rst @@ -1,11 +1,11 @@ .. _mds: -``mds`` +mds ======= The ``mds`` subcommand provides an interface to interact with a cluster's CephFS Metadata servers. -``create`` +create ---------- Deploy MDS instances by specifying directly like:: diff --git a/docs/source/mon.rst b/docs/source/mon.rst index 9a8dc43..075a499 100644 --- a/docs/source/mon.rst +++ b/docs/source/mon.rst @@ -1,13 +1,13 @@ .. _mon: -``mon`` +mon ======= The ``mon`` subcommand provides an interface to interact with a cluster's monitors. The tool makes a few assumptions that are needed to implement the most common scenarios. Monitors are usually very particular in what they need to work correctly. -``create-initial`` +create-initial ------------------ Will deploy for monitors defined in ``mon initial members``, wait until they form quorum and then ``gatherkeys``, reporting the monitor status along @@ -23,7 +23,7 @@ along the way. ceph-deploy mon create-initial -``create`` +create ---------- Deploy monitors by specifying directly like:: @@ -36,7 +36,7 @@ Please note that if this is an initial monitor deployment, the preferred way is to use ``create-initial``. -``add`` +add ------- Add a monitor to an existing cluster:: @@ -67,7 +67,7 @@ of the provided host. .. versionadded:: 1.4.0 -``destroy`` +destroy ----------- Completely remove monitors on a remote host. Requires hostname(s) as arguments:: @@ -75,7 +75,7 @@ arguments:: ceph-deploy mon destroy node1 -``--keyrings`` +--keyrings -------------- Both ``create`` and ``create-initial`` subcommands can be used with the ``--keyrings`` flag that accepts a path to search for keyring files. diff --git a/docs/source/new.rst b/docs/source/new.rst index 455307b..b619efe 100644 --- a/docs/source/new.rst +++ b/docs/source/new.rst @@ -1,6 +1,6 @@ .. _new: -``new`` +new ======= This subcommand is used to generate a working ``ceph.conf`` file that will contain important information for provisioning nodes and/or adding them to @@ -62,7 +62,7 @@ contact to authenticate to the cluster, and they need to be reachable both by external client-facing hosts and internal cluster daemons. -``--cluster-network`` ``--public-network`` +--cluster-network --public-network ========================================== Are used to provide subnets so that nodes can communicate within that network. If passed, validation will occur by looking at the remote IP addresses diff --git a/docs/source/pkg.rst b/docs/source/pkg.rst index bd942c5..2f70d08 100644 --- a/docs/source/pkg.rst +++ b/docs/source/pkg.rst @@ -1,7 +1,7 @@ .. _pkg: -``pkg`` +pkg ======= Provides a simple interface to install or remove packages on a remote host (or a number of remote hosts). @@ -16,7 +16,7 @@ than one package in the argument. .. _pkg-install: -``--install`` +--install ------------- This flag will use the package (or packages) passed in to perform an installation using the distribution package manager in a non-interactive way. Package managers @@ -38,7 +38,7 @@ An example call to install a few packages on 2 hosts (with hostnames like .. _pkg-remove: -``--remove`` +--remove ------------ This flag will use the package (or packages) passed in to remove them using the distribution package manager in a non-interactive way. Package managers diff --git a/docs/source/rgw.rst b/docs/source/rgw.rst index 4cff9ea..102e654 100644 --- a/docs/source/rgw.rst +++ b/docs/source/rgw.rst @@ -1,11 +1,11 @@ .. _rgw: -``rgw`` +rgw ======= The ``rgw`` subcommand provides an interface to interact with a cluster's RADOS Gateway instances. -``create`` +create ---------- Deploy RGW instances by specifying directly like::