From: John Wilkins Date: Tue, 3 Jul 2012 18:21:43 +0000 (-0700) Subject: doc: Updating Getting Started with 5-minute quick start. X-Git-Tag: v0.49~42 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=09dd8cad3657af49e6a4399efcc3fb819d7bf14a;p=ceph.git doc: Updating Getting Started with 5-minute quick start. Signed-off-by: John Wilkins --- diff --git a/doc/start/ceph.conf b/doc/start/ceph.conf new file mode 100644 index 0000000000000..21f9b2b99a50d --- /dev/null +++ b/doc/start/ceph.conf @@ -0,0 +1,30 @@ +[global] + auth supported = none + +[mon] + mon data = /srv/mon.$id + keyring = /etc/ceph/keyring.$name + +[mds] + keyring = /etc/ceph/keyring.$name + +[osd] + osd data = /srv/osd.$id + osd journal = /srv/osd.$id.journal + osd journal size = 1000 + ; uncomment the following line if you are mounting with ext4 + filestore xattr use omap = true + keyring = /etc/ceph/keyring.$name + +[mon.a] + host = localhost + mon addr = 127.0.0.1:6789 + +[osd.0] + host = localhost + +[osd.1] + host = localhost + +[mds.a] + host = localhost diff --git a/doc/start/index.rst b/doc/start/index.rst index 29fa0ac6e2d51..3a8c702270415 100644 --- a/doc/start/index.rst +++ b/doc/start/index.rst @@ -6,5 +6,8 @@ get started: .. toctree:: + 5-minute Quick Start + Quick Start RBD + Quick Start CephFS Get Involved - quick-start + manual-install diff --git a/doc/start/manual-install.rst b/doc/start/manual-install.rst index c97f214bf2866..4e7c30dbccaba 100644 --- a/doc/start/manual-install.rst +++ b/doc/start/manual-install.rst @@ -1,6 +1,6 @@ -============= - Quick Start -============= +========================== + Installing Ceph Manually +========================== Ceph is intended for large-scale deployments, but you may install Ceph on a single host. Quick start is intended for Debian/Ubuntu Linux distributions. diff --git a/doc/start/quick-cephfs.rst b/doc/start/quick-cephfs.rst new file mode 100644 index 0000000000000..dc191eca7323e --- /dev/null +++ b/doc/start/quick-cephfs.rst @@ -0,0 +1,24 @@ +===================== + Ceph FS Quick Start +===================== + +To mount the Ceph FS filesystem, you must have a running Ceph cluster. You may +execute this quick start on a separate host if you have the Ceph packages and +the ``/etc/ceph/ceph.conf`` file installed with the appropriate IP address +and host name settings modified in the ``/etc/ceph/ceph.conf`` file. + +Kernel Driver +------------- + +Mount Ceph FS as a kernel driver. :: + + sudo mkdir /mnt/mycephfs + sudo mount -t ceph {ip-address-of-monitor}:6789:/ /mnt/mycephfs + +Filesystem in User Space (FUSE) +------------------------------- + +Mount Ceph FS as with FUSE. Replace {username} with your username. :: + + sudo mkdir /home/{username}/cephfs + sudo ceph-fuse -m {ip-address-of-monitor}:6789 /home/{username}/cephfs diff --git a/doc/start/quick-rbd.rst b/doc/start/quick-rbd.rst new file mode 100644 index 0000000000000..9244276d8ae10 --- /dev/null +++ b/doc/start/quick-rbd.rst @@ -0,0 +1,29 @@ +================= + RBD Quick Start +================= + +To use RADOS block devices, you must have a running Ceph cluster. You may +execute this quick start on a separate host if you have the Ceph packages and +the ``/etc/ceph/ceph.conf`` file installed with the appropriate IP address +and host name settings modified in the ``/etc/ceph/ceph.conf`` file. + +Create a RADOS Block Device image. :: + + rbd create foo --size 4096 + +Load the ``rbd`` client module. :: + + sudo modprobe rbd + +Map the image to a block device. :: + + sudo rbd map foo --pool rbd --name client.admin + +Use the block device. In the following example, create a file system. :: + + sudo mkfs.ext4 -m0 /dev/rbd/rbd/foo + +Mount the file system. :: + + sudo mkdir /mnt/myrbd + sudo mount /dev/rbd/rbd/foo /mnt/myrbd diff --git a/doc/start/quick-start.rst b/doc/start/quick-start.rst new file mode 100644 index 0000000000000..7df3fb8c13601 --- /dev/null +++ b/doc/start/quick-start.rst @@ -0,0 +1,62 @@ +====================== + 5-minute Quick Start +====================== + +Thank you for trying Ceph! Petabyte-scale data clusters are quite an +undertaking. Before delving deeper into Ceph, we recommend setting up a +cluster on a a single host to explore some of the functionality. + +Ceph **5-Minute Quick Start** is intended for use on one machine with a +recent Debian/Ubuntu operating system. The intent is to help you exercise +Ceph functionality without the deployment overhead associated with a +production-ready storage cluster. + +Add Ceph Packages +----------------- + +To get the latest Ceph packages, add a release key to APT, add a source +location to your ``/etc/apt/sources.list``, update your system and +install Ceph. :: + + wget -q -O- https://raw.github.com/ceph/ceph/master/keys/release.asc | sudo apt-key add - + echo deb http://ceph.com/debian/ $(lsb_release -sc) main | sudo tee /etc/apt/sources.list.d/ceph.list + sudo apt-get update && sudo apt-get install ceph + +Add a Configuration File +------------------------ + +Copy the contents of the following configuration file and save it to +``/etc/ceph/ceph.conf``. This file will configure Ceph to operate a monitor, +two OSD daemons and one metadata server on your local machine. + +.. literalinclude:: ceph.conf + :language: ini + +Deploy the Configuration +------------------------ + +To deploy the configuration, create a directory for each +daemon using the same name used in your ``ceph.conf`` file. :: + + sudo mkdir /srv/osd.0 + sudo mkdir /srv/osd.1 + sudo mkdir /srv/mon.a + sudo mkdir /srv/mds.a + +Then deploy the configuration. :: + + cd /etc/ceph + sudo mkcephfs -a -c /etc/ceph/ceph.conf -k ceph.keyring + +Start the Ceph Cluster +---------------------- + +Once you have deployed the configuration, start the Ceph cluster. :: + + sudo service ceph start + +Check the health of your Ceph cluster to ensure it is ready. :: + + ceph health + +If your cluster echoes back ``HEALTH_OK``, you may begin using your cluster. \ No newline at end of file