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. It
  12 allows Ganeti to launch instances from predefined or untrusted custom Images.
  13 The whole process of deploying an Image onto the block device, as provided by
  14 Ganeti, is done in complete isolation from the physical host, enhancing
  15 robustness and security.
  16
  17 snf-image supports `KVM <http://www.linux-kvm.org/page/Main_Page>`_ and
  18 `Xen <http://www.xenproject.org/>`_ based Ganeti clusters.
  19
  20 snf-image also supports Image customization via hooks. Hooks allow for:
  21
  22  * changing the password of root or arbitrary users
  23  * injecting files at arbitrary locations inside the filesystem, e.g., SSH keys
  24  * setting a custom hostname
  25  * re-creating SSH host keys to ensure the image uses unique keys
  26
  27 snf-image is being used in large scale production environments with Ganeti to
  28 successfully deploy many major Linux distributions (Debian, Ubuntu/Kubuntu,
  29 CentOS, Fedora, OpenSUSE), Windows 2008 R2 & Windows Server 2012, as well as
  30 FreeBSD. Support for OpenBSD and NetBSD is also included with exception to
  31 extending partitions.
  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 Contents:
  38 ^^^^^^^^^
  39
  40 .. toctree::
  41    :maxdepth: 2
  42
  43    architecture
  44    interface
  45    installation
  46    usage
  47    advanced
  48
  49 Indices and tables
  50 ==================
  51
  52 * :ref:`genindex`
  53 * :ref:`modindex`
  54 * :ref:`search`