From: Alfredo Deza Date: Wed, 30 May 2018 19:29:37 +0000 (-0400) Subject: doc/man: remove ceph-disk, ceph-detect-init X-Git-Tag: v14.0.1~1088^2~27 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=cf0fb97eab66b4e2cda1212e1f40c3dc602c0045;p=ceph.git doc/man: remove ceph-disk, ceph-detect-init Signed-off-by: Alfredo Deza --- diff --git a/doc/man/8/ceph-detect-init.rst b/doc/man/8/ceph-detect-init.rst deleted file mode 100644 index a9207124d64e..000000000000 --- a/doc/man/8/ceph-detect-init.rst +++ /dev/null @@ -1,64 +0,0 @@ -:orphan: - -============================================================ - ceph-detect-init -- display the init system Ceph should use -============================================================ - -.. program:: ceph-detect-init - -Synopsis -======== - -| **ceph-detect-init** [--verbose] [--use-rhceph] [--default *init*] - -Description -=========== - -:program:`ceph-detect-init` is a utility that prints the init system -Ceph uses. It can be one of ``sysvinit``, ``upstart`` or ``systemd``. -The init system Ceph uses may not be the default init system of the -host operating system. For instance on Debian Jessie, Ceph may use -``sysvinit`` although ``systemd`` is the default. - -If the init system of the host operating system is unknown, return on -error, unless :option:`--default` is specified. - -Options -======= - -.. option:: --use-rhceph - - When an operating system identifies itself as Red Hat, it is - treated as if it was CentOS. With :option:`--use-rhceph` it is - treated as RHEL instead. - -.. option:: --default INIT - - If the init system of the host operating system is unknown, return - the value of *INIT* instead of failing with an error. - -.. option:: --verbose - - Display additional information for debugging. - -Bugs -==== - -:program:`ceph-detect-init` is used by :program:`ceph-disk` to figure out the init system to manage the mount directory of an OSD. But only following combinations are fully tested: - -- `systemd` on `Ubuntu 15.04` and up -- `systemd` on `Debian 8` and up -- `systemd` on `RHEL/CentOS 7` and up -- `systemd` on `Fedora 22` and up - -Availability -============ - -:program:`ceph-detect-init` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at http://ceph.com/docs for more information. - -See also -======== - -:doc:`ceph-disk `\(8), -:doc:`ceph-deploy `\(8) diff --git a/doc/man/8/ceph-disk.rst b/doc/man/8/ceph-disk.rst deleted file mode 100644 index 2760af30d724..000000000000 --- a/doc/man/8/ceph-disk.rst +++ /dev/null @@ -1,103 +0,0 @@ -:orphan: - -=================================================================== - ceph-disk -- Ceph disk utility for OSD -=================================================================== - -.. program:: ceph-disk - -Deprecation Notice -================== -This tool is now deprecated in favor of ceph-volume. Please see :doc:`ceph-volume `\(8) -for usage and examples to deploy OSDs. - -Synopsis -======== - -| **ceph-disk** [-h] [-v] [--log-stdout] [--prepend-to-path PATH] -| [--statedir PATH] [--sysconfdir PATH] -| [--setuser USER] [--setgroup GROUP] -| ... - -optional arguments ------------------- - --h, --help show this help message and exit --v, --verbose be more verbose ---log-stdout log to stdout ---prepend-to-path PATH - prepend PATH to $PATH for backward compatibility (default /usr/bin) ---statedir PATH directory in which ceph state is preserved (default /var/lib/ceph) ---sysconfdir PATH directory in which ceph configuration files are found (default /etc/ceph) ---setuser USER use the given user for subprocesses, rather than ceph or root ---setgroup GROUP use the given group for subprocesses, rather than ceph or root - -subcommands ------------ - -prepare - Prepare a directory or disk for a Ceph OSD -activate - Activate a Ceph OSD -activate-lockbox - Activate a Ceph lockbox -activate-block - Activate an OSD via its block device -activate-journal - Activate an OSD via its journal device -activate-all - Activate all tagged OSD partitions -list - List disks, partitions, and Ceph OSDs -suppress-activate - Suppress activate on a device (prefix) -unsuppress-activate - Stop suppressing activate on a device (prefix) -deactivate - Deactivate a Ceph OSD -destroy - Destroy a Ceph OSD -zap - Zap/erase/destroy a device's partition table (and contents) -trigger - Trigger an event (caled by udev) -fix - Fix SELinux labels and/or file permissions - -Description -=========== - -:program:`ceph-disk` is a utility that can prepare and activate a disk, partition or -directory as a Ceph OSD. It is run directly or triggered by :program:`ceph-deploy` -or ``udev``. It can also be triggered by other deployment utilities like ``Chef``, -``Juju``, ``Puppet`` etc. - -It actually automates the multiple steps involved in manual creation and start -of an OSD into two steps of preparing and activating the OSD by using the -subcommands ``prepare`` and ``activate``. - -:program:`ceph-disk` also automates the multiple steps involved to manually stop -and destroy an OSD into two steps of deactivating and destroying the OSD by using -the subcommands ``deactivate`` and ``destroy``. - -The documentation for each subcommand (prepare, activate, etc.) can be displayed -with its ``--help`` option. For instance ``ceph-disk prepare --help``. - -Bugs -==== - -See also the ``Bugs`` section in :doc:`ceph-detect-init `\(8). - -Availability -============ - -:program:`ceph-disk` is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to -the Ceph documentation at http://ceph.com/docs for more information. - -See also -======== - -:doc:`ceph-volume `\(8) -:doc:`ceph-detect-init `\(8) -:doc:`ceph-osd `\(8), -:doc:`ceph-deploy `\(8)