From 66de51d1a5a1e2bdaf21ce337c95f29afd9d0a1a Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Tue, 5 Aug 2014 12:51:33 -0400 Subject: [PATCH] be a bit more explicit about 'ceph-deploy new' in quickstart Signed-off-by: Alfredo Deza --- doc/start/quick-start-preflight.rst | 63 +++++++++++++++-------------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/doc/start/quick-start-preflight.rst b/doc/start/quick-start-preflight.rst index b270a61ad80f7..91f2d7d8ee530 100644 --- a/doc/start/quick-start-preflight.rst +++ b/doc/start/quick-start-preflight.rst @@ -21,7 +21,7 @@ Ceph Deploy Setup ================= Add Ceph repositories to the ``ceph-deploy`` admin node. Then, install -``ceph-deploy``. +``ceph-deploy``. Advanced Package Tool (APT) --------------------------- @@ -34,12 +34,12 @@ For Debian and Ubuntu distributions, perform the following steps: #. Add the Ceph packages to your repository. Replace ``{ceph-stable-release}`` with a stable Ceph release (e.g., ``cuttlefish``, ``dumpling``, - ``emperor``, ``firefly``, etc.). + ``emperor``, ``firefly``, etc.). For example:: - + echo deb http://ceph.com/debian-{ceph-stable-release}/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list -#. Update your repository and install ``ceph-deploy``:: +#. Update your repository and install ``ceph-deploy``:: sudo apt-get update && sudo apt-get install ceph-deploy @@ -53,17 +53,17 @@ Red Hat Package Manager (RPM) For Red Hat(rhel6), CentOS (el6), and Fedora 17-19 (f17-f19) perform the following steps: -#. Add the package to your repository. Open a text editor and create a +#. Add the package to your repository. Open a text editor and create a Yellowdog Updater, Modified (YUM) entry. Use the file path - ``/etc/yum.repos.d/ceph.repo``. For example:: + ``/etc/yum.repos.d/ceph.repo``. For example:: sudo vim /etc/yum.repos.d/ceph.repo - Paste the following example code. Replace ``{ceph-release}`` with + Paste the following example code. Replace ``{ceph-release}`` with the recent major release of Ceph (e.g., ``firefly``). Replace ``{distro}`` - with your Linux distribution (e.g., ``el6`` for CentOS 6, ``rhel6`` for - Red Hat 6, ``fc18`` or ``fc19`` for Fedora 18 or Fedora 19, and ``sles11`` - for SLES 11). Finally, save the contents to the + with your Linux distribution (e.g., ``el6`` for CentOS 6, ``rhel6`` for + Red Hat 6, ``fc18`` or ``fc19`` for Fedora 18 or Fedora 19, and ``sles11`` + for SLES 11). Finally, save the contents to the ``/etc/yum.repos.d/ceph.repo`` file. :: [ceph-noarch] @@ -72,17 +72,17 @@ following steps: enabled=1 gpgcheck=1 type=rpm-md - gpgkey=https://ceph.com/git/?p=ceph.git;a=blob_plain;f=keys/release.asc + gpgkey=https://ceph.com/git/?p=ceph.git;a=blob_plain;f=keys/release.asc -#. Update your repository and install ``ceph-deploy``:: +#. Update your repository and install ``ceph-deploy``:: sudo yum update && sudo yum install ceph-deploy -.. note:: Some distributions (e.g., RHEL) require you to comment out - ``Defaults requiretty`` in the ``/etc/sudoers`` file for ``ceph-deploy`` to - work properly. If editing, ``/etc/sudoers``, ensure that you use +.. note:: Some distributions (e.g., RHEL) require you to comment out + ``Defaults requiretty`` in the ``/etc/sudoers`` file for ``ceph-deploy`` to + work properly. If editing, ``/etc/sudoers``, ensure that you use ``sudo visudo`` rather than a text editor. .. note:: You can also use the EU mirror eu.ceph.com for downloading your packages. @@ -91,20 +91,21 @@ following steps: Ceph Node Setup =============== -.. important:: Do not call ``ceph-deploy`` with ``sudo`` or run it as ``root`` - if you are logged in as a different user, because it will not issue ``sudo`` +.. important:: Do not call ``ceph-deploy`` with ``sudo`` or run it as ``root`` + if you are logged in as a different user, because it will not issue ``sudo`` commands needed on the remote host. If you are using ``ceph-deploy`` version 1.1.3 and beyond, ``ceph-deploy`` -will attempt to create the SSH key and copy it to the initial monitor nodes +will attempt to create the SSH key and copy it to the initial monitor nodes automatically when you create the new cluster. Start from your ``ceph-deploy`` admin node. The admin node needs to have password-less SSH access to each Ceph Node listed below. -For example:: +For example, for three monitor nodes (with hostnames ``node1``, ``node2``, and +``node3``) it would look like:: - ceph-deploy new node1 + ceph-deploy new node1 node2 node3 This command will create the following files in the current directory of the admin node: @@ -117,29 +118,29 @@ For other Ceph Nodes in this example (and for initial monitors prior to ``ceph-deploy`` v1.1.3) perform the following steps: -#. Create a user on each Ceph Node. :: +#. Create a user on each Ceph Node. :: ssh user@ceph-server sudo useradd -d /home/ceph -m ceph sudo passwd ceph -#. Add ``sudo`` privileges for the user on each Ceph Node. :: +#. Add ``sudo`` privileges for the user on each Ceph Node. :: echo "ceph ALL = (root) NOPASSWD:ALL" | sudo tee /etc/sudoers.d/ceph sudo chmod 0440 /etc/sudoers.d/ceph -#. Install an SSH server (if necessary) on each Ceph Node:: +#. Install an SSH server (if necessary) on each Ceph Node:: sudo apt-get install openssh-server - or:: + or:: sudo yum install openssh-server - - + + #. Configure your ``ceph-deploy`` admin node with password-less SSH access to - each Ceph Node. When configuring SSH access, do not use ``sudo`` or the + each Ceph Node. When configuring SSH access, do not use ``sudo`` or the ``root`` user. Leave the passphrase empty:: ssh-keygen @@ -171,10 +172,10 @@ perform the following steps: User ceph -#. Ensure connectivity using ``ping`` with short hostnames (``hostname -s``). - Address hostname resolution issues and firewall issues as necessary. - **Note:** Hostnames should resolve to a network IP address, not to the - loopback IP address (e.g., hostnames should resolve to an IP address other +#. Ensure connectivity using ``ping`` with short hostnames (``hostname -s``). + Address hostname resolution issues and firewall issues as necessary. + **Note:** Hostnames should resolve to a network IP address, not to the + loopback IP address (e.g., hostnames should resolve to an IP address other than ``127.0.0.1``). .. note:: If you use your admin node as one of the Ceph Nodes, you must perform -- 2.39.5