code.grnet.gr Git - snf-image/blob - docs/index.rst

   1 .. snf-image documentation master file, created by
   2    sphinx-quickstart on Fri Sep 13 16:50:13 2013.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Welcome to snf-image's documentation!
   7 =====================================
   8
   9 .. image:: /images/logo.png
  10
  11 snf-image is a `Ganeti <http://code.google.com/p/ganeti/>`_ OS definition,
  12 primary used by `Synnefo <http://www.synnefo.org/>`_. It is rewritten from
  13 scratch and allows Ganeti to launch instances from predefined or untrusted
  14 custom Images. The whole process of deploying an Image onto the block device,
  15 as provided by Ganeti, is done in complete isolation from the physical host,
  16 enhancing robustness and security.
  17
  18 snf-image supports `KVM <http://www.linux-kvm.org/page/Main_Page>`_ and
  19 `Xen <http://www.xenproject.org/>`_ based ganeti clusters.
  20
  21 There are also additional hooks that can be enabled at image deployment. They
  22 allow for:
  23
  24  * changing the password of root or arbitrary users
  25  * injecting files at arbitrary locations inside the filesystem, e.g., SSH keys
  26  * setting a custom hostname
  27  * re-creating SSH host keys to ensure the image uses unique keys
  28
  29 snf-image has been used successfully to deploy many major Linux distributions
  30 (Debian, Ubuntu/Kubuntu, CentOS, Fedora, OpenSUSE), Windows 2008 R2 & Windows
  31 Server 2012, as well as FreeBSD 9.1
  32
  33 The snf-image Ganeti OS Definition is released under
  34 `GPLv2 <http://www.gnu.org/licenses/gpl-2.0.html>`_.
  35
  36
  37
  38 Contents:
  39 ^^^^^^^^^
  40
  41 .. toctree::
  42    :maxdepth: 2
  43
  44    architecture
  45    installation
  46    usage
  47
  48 Indices and tables
  49 ==================
  50
  51 * :ref:`genindex`
  52 * :ref:`modindex`
  53 * :ref:`search`
  54