From: Danny Al-Gaaf Date: Tue, 23 Feb 2016 05:55:19 +0000 (+0100) Subject: ceph-deploy.rst: document missing --mkfs option X-Git-Tag: v11.1.0~327^2~18 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=bf634d23a3569c6009b7b9da6efad805b415dc27;p=ceph.git ceph-deploy.rst: document missing --mkfs option Add missing option to the correct section to fix build warnings. Resort the 'Options' section to alphabetical order. Signed-off-by: Danny Al-Gaaf --- diff --git a/doc/man/8/ceph-deploy.rst b/doc/man/8/ceph-deploy.rst index 82507146899..3f197504ed9 100644 --- a/doc/man/8/ceph-deploy.rst +++ b/doc/man/8/ceph-deploy.rst @@ -484,109 +484,113 @@ Another option :option:`--master` can also be used with this command. Options ======= -.. option:: --version - - The current installed version of :program:`ceph-deploy`. - -.. option:: --username - - The username to connect to the remote host. - -.. option:: --overwrite-conf +.. option:: --address - Overwrite an existing conf file on remote host (if present). + IP address of the host node to be added to the cluster. -.. option:: --cluster +.. option:: --adjust-repos - Name of the cluster. + Install packages modifying source repos. .. option:: --ceph-conf Use (or reuse) a given ``ceph.conf`` file. -.. option:: --no-ssh-copykey +.. option:: --cluster - Do not attempt to copy ssh keys. + Name of the cluster. -.. option:: --fsid +.. option:: --dev - Provide an alternate FSID for ``ceph.conf`` generation. + Install a bleeding edge built from Git branch or tag (default: master). .. option:: --cluster-network Specify the (internal) cluster network. -.. option:: --public-network +.. option:: --dmcrypt - Specify the public network for a cluster. + Encrypt [data-path] and/or journal devices with ``dm-crypt``. -.. option:: --testing +.. option:: --dmcrypt-key-dir - Install the latest development release. + Directory where ``dm-crypt`` keys are stored. -.. option:: --dev +.. option:: --install - Install a bleeding edge built from Git branch or tag (default: master). + Comma-separated package(s) to install on remote hosts. -.. option:: --adjust-repos +.. option:: --fs-type - Install packages modifying source repos. + Filesystem to use to format disk ``(xfs, btrfs or ext4)``. -.. option:: --no-adjust-repos +.. option:: --fsid - Install packages without modifying source repos. + Provide an alternate FSID for ``ceph.conf`` generation. -.. option:: --repo +.. option:: --gpg-url - Install repo files only (skips package installation). + Specify a GPG key url to be used with custom repos (defaults to ceph.com). + +.. option:: --keyrings + + Concatenate multiple keyrings to be seeded on new monitors. .. option:: --local-mirror Fetch packages and push them to hosts for a local repo mirror. -.. option:: --repo-url +.. option:: --master - Specify a repo url that mirrors/contains Ceph packages. + The domain for the Calamari master server. -.. option:: --gpg-url +.. option:: --mkfs - Specify a GPG key url to be used with custom repos (defaults to ceph.com). + Inject keys to MONs on remote nodes. -.. option:: --address +.. option:: --no-adjust-repos - IP address of the host node to be added to the cluster. + Install packages without modifying source repos. -.. option:: --keyrings +.. option:: --no-ssh-copykey - Concatenate multiple keyrings to be seeded on new monitors. + Do not attempt to copy ssh keys. -.. option:: --zap-disk +.. option:: --overwrite-conf - Destroy the partition table and content of a disk. + Overwrite an existing conf file on remote host (if present). -.. option:: --fs-type +.. option:: --public-network - Filesystem to use to format disk (e.g., ``xfs``, ``btrfs``). + Specify the public network for a cluster. -.. option:: --dmcrypt +.. option:: --remove - Encrypt [data-path] and/or journal devices with ``dm-crypt``. + Comma-separated package(s) to remove from remote hosts. -.. option:: --dmcrypt-key-dir +.. option:: --repo - Directory where ``dm-crypt`` keys are stored. + Install repo files only (skips package installation). -.. option:: --install +.. option:: --repo-url - Comma-separated package(s) to install on remote hosts. + Specify a repo url that mirrors/contains Ceph packages. -.. option:: --remove +.. option:: --testing - Comma-separated package(s) to remove from remote hosts. + Install the latest development release. -.. option:: --master +.. option:: --username - The domain for the Calamari master server. + The username to connect to the remote host. + +.. option:: --version + + The current installed version of :program:`ceph-deploy`. + +.. option:: --zap-disk + + Destroy the partition table and content of a disk. Availability