diff options
author | John Wilkins <john.wilkins@inktank.com> | 2013-05-09 12:48:59 -0700 |
---|---|---|
committer | John Wilkins <john.wilkins@inktank.com> | 2013-05-09 12:48:59 -0700 |
commit | 270ca6232d297af53ddbb79543e604c514adb92e (patch) | |
tree | 651bf6a3999efeced5e912ed1a2984f9142cb4e2 | |
parent | e4173123d4476b383076e5182d1ee1ae9e056de9 (diff) | |
download | ceph-270ca6232d297af53ddbb79543e604c514adb92e.tar.gz |
doc: Updated doc for connectivity. Updated text with glossary terms.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
-rw-r--r-- | doc/start/quick-start-preflight.rst | 52 |
1 files changed, 33 insertions, 19 deletions
diff --git a/doc/start/quick-start-preflight.rst b/doc/start/quick-start-preflight.rst index fe319493825..bfef248c58a 100644 --- a/doc/start/quick-start-preflight.rst +++ b/doc/start/quick-start-preflight.rst @@ -7,33 +7,33 @@ Thank you for trying Ceph! Petabyte-scale data clusters are quite an undertaking. Before delving deeper into Ceph, we recommend setting up a two-node demo cluster to explore some of the functionality. This **Preflight Checklist** -will help you prepare an admin host and a server host for use with +will help you prepare an admin node and a server node for use with ``ceph-deploy``. .. ditaa:: /----------------\ /----------------\ - | Admin Host |<------->| Server Host | + | Admin Node |<------->| Server Node | | cCCC | | cCCC | \----------------/ \----------------/ Before you can deploy Ceph using ``ceph-deploy``, you need to ensure that you -have a few things set up first on your admin host and on hosts running Ceph +have a few things set up first on your admin node and on nodes running Ceph daemons. Install an Operating System =========================== -Install a recent release of Debian or Ubuntu (e.g., 12.04, 12.10) on your -hosts. For additional details on operating systems or to use other operating +Install a recent release of Debian or Ubuntu (e.g., 12.04, 12.10, 13.04) on your +nodes. For additional details on operating systems or to use other operating systems other than Debian or Ubuntu, see `OS Recommendations`_. Install an SSH Server ===================== -The ``ceph-deploy`` utility requires ``ssh``, so your server host(s) require an +The ``ceph-deploy`` utility requires ``ssh``, so your server node(s) require an SSH server. :: sudo apt-get install openssh-server @@ -42,7 +42,7 @@ SSH server. :: Create a User ============= -Create a user on hosts running Ceph daemons. +Create a user on nodes running Ceph daemons. .. tip:: We recommend a username that brute force attackers won't guess easily (e.g., something other than ``root``, ``ceph``, etc). @@ -54,7 +54,7 @@ Create a user on hosts running Ceph daemons. sudo passwd ceph -``ceph-deploy`` installs packages onto your hosts. This means that +``ceph-deploy`` installs packages onto your nodes. This means that the user you create requires passwordless ``sudo`` privileges. .. note:: We **DO NOT** recommend enabling the ``root`` password @@ -70,7 +70,7 @@ To provide full privileges to the user, add the following to Configure SSH ============= -Configure your admin machine with password-less SSH access to each host +Configure your admin machine with password-less SSH access to each node running Ceph daemons (leave the passphrase empty). :: ssh-keygen @@ -81,11 +81,11 @@ running Ceph daemons (leave the passphrase empty). :: Your identification has been saved in /ceph-client/.ssh/id_rsa. Your public key has been saved in /ceph-client/.ssh/id_rsa.pub. -Copy the key to each host running Ceph daemons:: +Copy the key to each node running Ceph daemons:: ssh-copy-id ceph@ceph-server -Modify your ~/.ssh/config file of your admin host so that it defaults +Modify your ~/.ssh/config file of your admin node so that it defaults to logging in as the user you created when no username is specified. :: Host ceph-server @@ -97,7 +97,7 @@ Install git =========== To clone the ``ceph-deploy`` repository, you will need install ``git`` -on your admin host. :: +on your admin node. :: sudo apt-get install git @@ -112,6 +112,7 @@ To begin working with ``ceph-deploy``, clone its repository. :: If you do not specify a directory name, ``git clone`` will use the repository name ``ceph-deploy``. + Install python-virtualenv ========================= @@ -129,20 +130,33 @@ After you clone the repository, bootstrap ``ceph-deploy``. :: cd ceph-deploy ./bootstrap -Add ``ceph-deploy`` to your path so that you can execute it without -remaining in ``ceph-deploy`` directory (e.g., ``/etc/environment``, -``~/.pam_environment``). Once you have completed this pre-flight checklist, you -are ready to begin using ``ceph-deploy``. +Add ``ceph-deploy`` to your path (e.g., ``/etc/environment``, +``~/.pam_environment``) so that you can execute it without remaining in the +directory that contains ``ceph-deploy``. + + +Ensure Connectivity +=================== +Ensure that your Admin node has connectivity to the network and to your Server +node (e.g., ensure ``iptables``, ``ufw`` or other tools that may prevent +connections, traffic forwarding, etc. to allow what you need). + +.. tip:: The ``ceph-deploy`` tool is new and you may encounter some issues + without effective error messages. + +Once you have completed this pre-flight checklist, you are ready to begin using +``ceph-deploy``. Summary ======= -Once you have passwordless ``ssh`` connectivity, passwordless ``sudo``, and -a bootstrapped ``ceph-deploy``, proceed to the `Object Store Quick Start`_. +Once you have passwordless ``ssh`` connectivity, passwordless ``sudo``, a +bootstrapped ``ceph-deploy``, and appropriate connectivity, proceed to the +`Object Store Quick Start`_. .. tip:: The ``ceph-deploy`` utility can install Ceph packages on remote - machines from the admin host! + machines from the admin node! .. _Object Store Quick Start: ../quick-ceph-deploy .. _OS Recommendations: ../../install/os-recommendations
\ No newline at end of file |