Skip to content

Commit

Permalink
doc: Write about deb installation.
Browse files Browse the repository at this point in the history
Signed-off-by: Tommi Virtanen <[email protected]>
  • Loading branch information
Tommi Virtanen committed Sep 2, 2011
1 parent 6506d43 commit 39b0354
Show file tree
Hide file tree
Showing 8 changed files with 394 additions and 17 deletions.
11 changes: 11 additions & 0 deletions doc/dev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@
.. note:: If you're looking for how to use Ceph as a library from your
own software, please see :doc:`/api/index`.

You can start a development mode Ceph cluster, after compiling the source, with::

cd src
install -d -m0755 out dev/osd0
./vstart.sh -n -x -l
# check that it's there
./ceph health

.. todo:: vstart is woefully undocumented and full of sharp sticks to poke yourself with.


.. toctree::
:glob:

Expand Down
64 changes: 64 additions & 0 deletions doc/ops/autobuilt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
=============================
Autobuilt unstable packages
=============================

We automatically build Debian and Ubuntu packages for any branches or
tags that appear in the |ceph.git|_. We build packages for the `amd64`
and `i386` architectures (`arch list`_), for the following
distributions (`distro list`_):

- ``natty`` (Ubuntu 11.04)
- ``squeeze`` (Debian 6.0)

.. |ceph.git| replace::
``ceph.git`` repository
.. _`ceph.git`: https://github.com/NewDreamNetwork/ceph

.. _`arch list`: http://ceph.newdream.net/debian-snapshot-amd64/master/dists/natty/main/
.. _`distro list`: http://ceph.newdream.net/debian-snapshot-amd64/master/dists/

The current status of autobuilt packages can be found at
http://ceph.newdream.net/gitbuilder-deb-amd64/ .

If you wish to use these packages, you need to modify the
:ref:`earlier instructions <install-debs>` as follows:

.. warning:: The following commands make your computer trust any code
that makes it into ``ceph.git``, including work in progress
branches and versions of code with possible security issues (that
were fixed afterwards). Use at your own risk!

Whenever we say *DISTRO* below, replace it with the codename of your
operating system.

Whenever we say *BRANCH* below, replace it with the version of the
code you want to run, e.g. ``master``, ``stable`` or ``v0.34`` (`branch list`_ [#broken-links]_).

.. _`branch list`: http://ceph.newdream.net/debian-snapshot-amd64/

Run these commands on all nodes::

wget -q -O- https://raw.github.com/NewDreamNetwork/ceph/master/keys/autobuild.asc \
| sudo apt-key add -

sudo tee /etc/apt/sources.list.d/ceph.list <<EOF
deb http://ceph.newdream.net/debian-snapshot-amd64/BRANCH/ DISTRO main
deb-src http://ceph.newdream.net/debian-snapshot-amd64/BRANCH/ DISTRO main
EOF

sudo apt-get update
sudo apt-get install ceph

From here on, you can follow the usual set up instructions in
:doc:`/ops/install`.



.. rubric:: Footnotes

.. [#broken-links] Technical issues with how that part of the URL
space is HTTP reverse proxied means that the links in the generated
directory listings are broken. Please don't click on the links,
instead edit the URL bar manually, for now.
.. todo:: Fix the gitbuilder reverse proxy to not break relative URLs.
17 changes: 17 additions & 0 deletions doc/ops/filesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,20 @@
=======================================

.. todo:: Benefits of each, limits on non-btrfs ones, performance data when we have them, etc


Btrfs
-----

.. todo:: what does btrfs give you (the journaling thing)


ext4/ext3
---------

.. _xattr:

Enabling extended attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. todo:: how to enable xattr on ext4/3
2 changes: 2 additions & 0 deletions doc/ops/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@
monitor
grow/index
data-placement
autobuilt
misc
122 changes: 105 additions & 17 deletions doc/ops/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,120 @@
Installing a Ceph cluster
===========================

For development and really early stage testing, see :doc:`/dev/index`.

For installing the latest development builds, see
:doc:`/ops/autobuilt`.

Installing any complex distributed software can be a lot of work. We
support two automated ways of installing Ceph: using Chef_, or with
the ``mkcephfs`` shell script.

.. _Chef: http://wiki.opscode.com/display/chef

.. topic:: Status as of 2011-09

This section hides a lot of the tedious underlying details. If you
need to, or wish to, roll your own deployment automation, or are
doing it manually, you'll have to dig into a lot more intricate
details. We are working on simplifying the installation, as that
also simplifies our Chef cookbooks.


Installing Ceph using Chef
==========================

(Try saying that fast 10 times.)

.. topic:: Status as of 2011-09

While we have Chef cookbooks in use internally, they are not yet
ready to handle unsupervised installation of a full cluster. Stay
tuned for updates.

.. todo:: write me

Authentication is optional but very much recommended.

Basically, everything somebody needs to go through to build a new
cluster when not cheating via vstart or teuthology, but without
mentioning all the design tradeoffs and options like journaling
locations or filesystems
Installing Ceph using ``mkcephfs``
==================================

At this point, either use 1 or 3 mons, point to :doc:`grow/mon`
Installing the packages
-----------------------

.. topic:: Status as of 2011-09

The following commands don't work yet. Patience, my young padawan.


.. _install-debs:

Debian/Ubuntu
~~~~~~~~~~~~~

We regularly build Debian and Ubuntu packages for the `amd64` and
`i386` architectures, for the following distributions:

- ``sid`` (Debian unstable)
- ``squeeze`` (Debian 6.0)
- ``lenny`` (Debian 5.0)
- ``oneiric`` (Ubuntu 11.11)
- ``natty`` (Ubuntu 11.04)
- ``maverick`` (Ubuntu 10.10)

OSD installation
================
.. todo:: http://ceph.newdream.net/debian/dists/ also has ``lucid``
(Ubuntu 10.04), should that be removed?

btrfs
-----
Whenever we say *DISTRO* below, replace that with the codename of your
operating system.

what does btrfs give you (the journaling thing)
Run these commands on all nodes::

wget -q -O- https://raw.github.com/NewDreamNetwork/ceph/master/keys/release.asc \
| sudo apt-key add -

ext4/ext3
---------
sudo tee /etc/apt/sources.list.d/ceph.list <<EOF
deb http://ceph.newdream.net/debian/ DISTRO main
deb-src http://ceph.newdream.net/debian/ DISTRO main
EOF

.. _xattr:
sudo apt-get update
sudo apt-get install ceph

Enabling extended attributes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

how to enable xattr on ext4/3







.. todo:: For older distributions, you may need to make sure your apt-get may read .bz2 compressed files. This works for Debian Lenny 5.0.3:

$ apt-get install bzip2

.. todo:: ponder packages

Package: ceph
Recommends: ceph-client-tools, ceph-fuse, libceph1, librados2, librbd1, btrfs-tools, gceph

Package: ceph-client-tools
Package: ceph-fuse
Package: libceph-dev
Package: librados-dev
Package: librbd-dev
Package: obsync
Package: python-ceph
Package: radosgw


.. todo:: Other operating system support.


.. todo:: write me

Basically, everything somebody needs to go through to build a new
cluster when not cheating via vstart or teuthology, but without
mentioning all the design tradeoffs and options like journaling
locations or filesystems

At this point, either use 1 or 3 mons, point to :doc:`grow/mon`
14 changes: 14 additions & 0 deletions doc/ops/misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
===============
Miscellaneous
===============

.. todo:: This section should not exist. Try to reorganize, when
document is otherwise more ready.


Disabling encryption
====================

Authentication is optional but very much recommended.

.. todo:: write me
41 changes: 41 additions & 0 deletions keys/autobuild.asc
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v1.4.9 (GNU/Linux)

mQGiBE1Rr28RBADCxdpLV3ea9ocpS/1+UCvHqD5xjmlw/9dmji4qrUX0+IhPMNuA
GBBt2CRaR7ygMF5S0NFXooegph0/+NT0KisLIuhUI3gde4SWb5jsb8hpGUse9MC5
DN39P46zZSpepIMlQuQUkge8W/H2qBu10RcwQhs7o2fZ1zK9F3MmRCkBqwCggpap
GsOgE2IlWjcztmE6xcPO0wED/R4BxTaQM+jxIjylnHgn9PYy6795yIc/ZoYjNnIh
QyjqbLWnyzeTmjPBwcXNljKqzEoA/Cjb2gClxHXrYAw7bGu7wKbnqhzdghSx7ab+
HwIoy/v6IQqv+EXZgYHonqQwqtgfAHp5ON2gWu03cHoGkXfmA4qZIoowqMolZhGo
cF30A/9GotDdnMlqh8bFBOCMuxfRow7H8RpfL0fX7VHA0knAZEDk2rNFeebL5QKH
GNJm9Wa6JSVj1NUIaz4LHyravqXi4MXzlUqauhLHw1iG+qwZlPM04z+1Dj6A+2Hr
b5UxI/I+EzmO5OYa38YWOqybNVBH0wO+sMCpdBq0LABa8X29LbRPQ2VwaCBhdXRv
bWF0ZWQgcGFja2FnZSBidWlsZCAoQ2VwaCBhdXRvbWF0ZWQgcGFja2FnZSBidWls
ZCkgPHNhZ2VAbmV3ZHJlYW0ubmV0PohmBBMRAgAmBQJNUa9vAhsDBQkDwmcABgsJ
CAcDAgQVAggDBBYCAwECHgECF4AACgkQbq6uIgPDlRpR0QCfZnYE8vEDX4JL3sZj
5LvMsXruULIAnjHBAYvdlu5iMowoEMQDJlNNdscxuQQNBE1Rr28QEACKG04kxGY1
cwGoInHVP6z1+8oqGiaiYWFflYRtSiwoUVtl30T1sMOSzoEvmauc+rmBBfsyaBb8
DLDUIgGKv1FCOY/tfqnOyQXotPjgaLeCtK5A5Z5D212wbskf5fRHAxiychwKURiE
eesRa7EWrF6ohFxOTy9NOlFi7ctusShw6Q2kUtN7bQCX9hJdYs7PYQXvCXvW8DNt
7IitF7MpgMHNcj0wik6p38I4s7pqK6mqP4AXVVSWbJKr/LSz8bI8KhWRAT7erVAZ
f6FElR2xZVr3c4zsE2HFpnZTsM5y/nj8fUkgKGl8OfBuUoh+MCVfnPmE6sgWfDTK
kwWtUcmL6V9UQ1INUJ3sk+XBY9SMNbOn04su9FjQyNEMI/3VK7yuyKBRAN7IIVgP
2ch499m6+YFV9ZkG3JSTovNiqSpQouW7YPkS+8mxlPo03LQcU5bHeacBl0T8Xjlv
qu6q279EliHul4huKL0+myPN4DtmOTh/kwgSy3BGCBdS+wfAJSZcuKI7pk7pHGCd
UjNMHQZmPFbwzp33bVLd16gnAx0OW5DOn6l0VfgIQNSJ2rn7WZ5jdyg/Flp2VlWV
tAHFLzkCa+LvQ5twSuzrV/VipSr3xz3pTDLY+ZxDztvrgA6AST8+sdq6uQTYjwUQ
V0wzanvp9hkC5eqRY6YlzcgMkWFv8DCIEwADBQ//ZQaeVmG6T5vyfXf2JrCipmI4
MAdO+ezEtWE82wgixlCvvm26UmUejCYgtD6DmwY/7/bIjvJDhUwP0+hAHHOpR62g
ncoMtbMryHpm3FvYH58JNk5gx8ZA322WEc2GCRCQzrMQoMKBcpZY/703GpQ4l3RZ
7/25gq7ANohV5zeddFQftc05PMBBJLU3U+lrnahJS1WaOXNQzS6oVj9jNda1jkgc
Qni6QssSIMT6rAPsVbGJhe9mxr2VWdQ90QlubpszIeSJuqqJxLwqH8XHXZmQOYxm
yVP9a3pFqWDmsNxDA8ttYnMIc+nUAgCDJ84ScwQ1GvoCUD1b1cFNzvvhEHsNb4D/
XbdrFcFGwEkeyivUsojdq2YnGjYSgauqyNWbeEgBrWzUe5USYysmziL/KAubcUjI
beRGxyPS6iQ2kbvfEJJPgocWTfLs5j61FObO+MVlj+PEmxWbcsIRv/pnG2V2FPJ8
evhzgvp7cG9imZPM6dWHzc/ZFdi3Bcs51RtStsvPqXv4icKIi+01h1MLHNBqwuUk
IiiK7ooMlvnp+DiEsVSuYYKBdGTi+4+nduuYL2g8CTNJKZuC46dY7EcE3lRYZlxl
7dwN3jfLPRlnNscs34dwhZa+b70Flia0U1DNF4jrIFFBSHD3TqMg0Z6kxp1Tfxpe
GOLOqnBWrr0GKehu9CGITwQYEQIADwUCTVGvbwIbDAUJA8JnAAAKCRBurq4iA8OV
GqKjAJ9QA7mNQs0Rko5VGYA+xjPokf0yVACfQMEFVHxT/k9+awAbBFLR3D0jjJ4=
=PYuQ
-----END PGP PUBLIC KEY BLOCK-----
Loading

0 comments on commit 39b0354

Please sign in to comment.