summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn Wilkins <john.wilkins@inktank.com>2012-05-30 14:29:10 -0700
committerJohn Wilkins <john.wilkins@inktank.com>2012-05-30 14:29:10 -0700
commitcb5c6b5db6b99a67898f8eb1bb5f5085fabaf56d (patch)
treed49e9a043e779ea727afc7a27f588796b6f5930d /doc
parentdd1d38806138216a3963c507e7ea5c4f39840142 (diff)
downloadceph-cb5c6b5db6b99a67898f8eb1bb5f5085fabaf56d.tar.gz
doc: Consolidated mkcephfs deployment files.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/config-cluster/deploying-ceph-conf.rst39
-rw-r--r--doc/config-cluster/deploying-ceph-with-mkcephfs.rst18
-rw-r--r--doc/config-cluster/index.rst3
-rw-r--r--doc/config-cluster/mkcephfs.rst63
-rw-r--r--doc/start/quick-start.rst9
5 files changed, 67 insertions, 65 deletions
diff --git a/doc/config-cluster/deploying-ceph-conf.rst b/doc/config-cluster/deploying-ceph-conf.rst
deleted file mode 100644
index c5bc485e1f1..00000000000
--- a/doc/config-cluster/deploying-ceph-conf.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-==================================
- Deploying the Ceph Configuration
-==================================
-Ceph's ``mkcephfs`` deployment script does not copy the configuration file you
-created from the Administration host to the OSD Cluster hosts. Copy the
-configuration file you created (*i.e.,* ``mycluster.conf`` in the example below)
-from the Administration host to ``etc/ceph/ceph.conf`` on each OSD Cluster host
-if you are using ``mkcephfs`` to deploy Ceph.
-
-::
-
- ssh myserver01 sudo tee /etc/ceph/ceph.conf <mycluster.conf
- ssh myserver02 sudo tee /etc/ceph/ceph.conf <mycluster.conf
- ssh myserver03 sudo tee /etc/ceph/ceph.conf <mycluster.conf
-
-The current deployment script does not create the default server directories. Create
-server directories for each instance of a Ceph daemon. Using the exemplary
-``ceph.conf`` file, you would perform the following:
-
-On ``myserver01``::
-
- sudo mkdir srv/osd.0
- sudo mkdir srv/mon.a
-
-On ``myserver02``::
-
- sudo mkdir srv/osd.1
- sudo mkdir srv/mon.b
-
-On ``myserver03``::
-
- sudo mkdir srv/osd.2
- sudo mkdir srv/mon.c
-
-On ``myserver04``::
-
- sudo mkdir srv/osd.3
-
-.. important:: The ``host`` variable determines which host runs each instance of a Ceph daemon.
diff --git a/doc/config-cluster/deploying-ceph-with-mkcephfs.rst b/doc/config-cluster/deploying-ceph-with-mkcephfs.rst
deleted file mode 100644
index 3a14fabeacd..00000000000
--- a/doc/config-cluster/deploying-ceph-with-mkcephfs.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-==================================
- Deploying Ceph with ``mkcephfs``
-==================================
-
-Once you have copied your Ceph Configuration to the OSD Cluster hosts,
-you may deploy Ceph with the ``mkcephfs`` script.
-
-.. note:: ``mkcephfs`` is a quick bootstrapping tool. It does not handle more
- complex operations, such as upgrades.
-
-For production environments, you deploy Ceph using Chef cookbooks. To run
-``mkcephfs``, execute the following::
-
- cd /etc/ceph
- sudo mkcephfs -a -c /etc/ceph/ceph.conf -k ceph.keyring
-
-The script adds an admin key to the ``ceph.keyring``, which is analogous to a
-root password.
diff --git a/doc/config-cluster/index.rst b/doc/config-cluster/index.rst
index 1fbe0d8c485..831ea337458 100644
--- a/doc/config-cluster/index.rst
+++ b/doc/config-cluster/index.rst
@@ -25,8 +25,7 @@ instance (a single context).
file-system-recommendations
Configuration <ceph-conf>
- Deploy Config <deploying-ceph-conf>
- deploying-ceph-with-mkcephfs
+ Deploy with mkcephfs <mkcephfs>
Deploy with Chef <chef>
Storage Pools <pools>
Authentication <authentication>
diff --git a/doc/config-cluster/mkcephfs.rst b/doc/config-cluster/mkcephfs.rst
new file mode 100644
index 00000000000..325c2bf587a
--- /dev/null
+++ b/doc/config-cluster/mkcephfs.rst
@@ -0,0 +1,63 @@
+=============================
+ Deploying with ``mkcephfs``
+=============================
+
+Copy Configuration File to All Hosts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Ceph's ``mkcephfs`` deployment script does not copy the configuration file you
+created from the Administration host to the OSD Cluster hosts. Copy the
+configuration file you created (*i.e.,* ``mycluster.conf`` in the example below)
+from the Administration host to ``etc/ceph/ceph.conf`` on each OSD Cluster host
+if you are using ``mkcephfs`` to deploy Ceph.
+
+::
+
+ ssh myserver01 sudo tee /etc/ceph/ceph.conf <mycluster.conf
+ ssh myserver02 sudo tee /etc/ceph/ceph.conf <mycluster.conf
+ ssh myserver03 sudo tee /etc/ceph/ceph.conf <mycluster.conf
+
+
+Create the Default Directories
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The ``mkcephfs`` deployment script does not create the default server directories.
+Create server directories for each instance of a Ceph daemon. The ``host``
+variables in the ``ceph.conf`` file determine which host runs each instance of
+a Ceph daemon. Using the exemplary ``ceph.conf`` file, you would perform
+the following:
+
+On ``myserver01``::
+
+ sudo mkdir srv/osd.0
+ sudo mkdir srv/mon.a
+
+On ``myserver02``::
+
+ sudo mkdir srv/osd.1
+ sudo mkdir srv/mon.b
+
+On ``myserver03``::
+
+ sudo mkdir srv/osd.2
+ sudo mkdir srv/mon.c
+ sudo mkdir srv/mds.a
+
+Run ``mkcephfs``
+~~~~~~~~~~~~~~~~
+Once you have copied your Ceph Configuration to the OSD Cluster hosts
+and created the default directories, you may deploy Ceph with the
+``mkcephfs`` script.
+
+.. note:: ``mkcephfs`` is a quick bootstrapping tool. It does not handle more
+ complex operations, such as upgrades.
+
+For production environments, deploy Ceph using Chef cookbooks. To run
+``mkcephfs``, execute the following::
+
+ cd /etc/ceph
+ sudo mkcephfs -a -c /etc/ceph/ceph.conf -k ceph.keyring
+
+The script adds an admin key to the ``ceph.keyring``, which is analogous to a
+root password. See `Authentication`_ when running with ``cephx`` enabled.
+
+
+.. _Authentication: authentication \ No newline at end of file
diff --git a/doc/start/quick-start.rst b/doc/start/quick-start.rst
index 8ce6a7a2082..88c90988c27 100644
--- a/doc/start/quick-start.rst
+++ b/doc/start/quick-start.rst
@@ -7,16 +7,13 @@ single host. Quick start is intended for Debian/Ubuntu Linux distributions.
#. `Install Ceph packages`_
#. Create a ``ceph.conf`` file.
See `Ceph Configuration Files`_ for details.
-#. Deploy the Ceph configuration.
- See `Deploying the Ceph Configuration`_ for details.
-#. Configure a Ceph cluster
- See `Deploying Ceph with mkcephfs`_ for details.
+#. Deploy the Ceph configuration.
+ See `Deploy with mkcephfs`_ for details.
#. Start a Ceph cluster.
See `Starting a Cluster`_ for details.
.. _Install Ceph packages: ../../install/debian
.. _Ceph Configuration Files: ../../config-cluster/ceph-conf
-.. _Deploying the Ceph Configuration: ../../config-cluster/deploying-ceph-conf
-.. _Deploying Ceph with mkcephfs: ../../config-cluster/deploying-ceph-with-mkcephfs
+.. _Deploy with mkcephfs: ../../config-cluster/mkcephfs
.. _Starting a Cluster: ../../init/start-cluster/