code.grnet.gr Git - ganeti-local/blob - doc/index.rst

   1 .. Ganeti documentation master file,
   2    created by sphinx-quickstart
   3
   4 Welcome to Ganeti's documentation!
   5 ==================================
   6
   7 This page is the starting point for browsing the ganeti documentation. It
   8 contains link to all the sections of the documentation, grouped by topic.
   9
  10 The list of changes between Ganeti versions is provided in the :doc:`news` file.
  11
  12 In order to help understanding the Ganeti terminology, a :doc:`glossary` is
  13 provided.
  14
  15 Also see the :ref:`search`.
  16
  17 Installing Ganeti
  18 +++++++++++++++++
  19
  20 In order to install Ganeti, follow the instructions contained in the
  21 :doc:`install`.
  22
  23 If you are an experienced user, the content of the :doc:`install-quick` should
  24 be enough.
  25
  26 Instructions for upgrading an existing installation to the latest version of
  27 Ganeti are contained in the :doc:`upgrade`.
  28
  29 Using Ganeti
  30 ++++++++++++
  31
  32 Information about how to manage a Ganeti cluster after it has been installed
  33 (including management of nodes, instances, info about the tools and the
  34 monitoring agent) can be found in :doc:`admin`.
  35
  36 A more example-oriended guide is available in :doc:`walkthrough`.
  37
  38 The various tool that are part of Ganeti are described one by one in the
  39 :doc:`manpages`.
  40
  41 A description of the security model underlying a Ganeti cluster can be found in
  42 the :doc:`security` document.
  43
  44 Ganeti functionalities can be extended by hooking scripts automatically
  45 activated when certain events happen. Information on this mechanism is provided
  46 in the :doc:`hooks` document.
  47
  48 While using Ganeti, the allocation of instances can happen manually or
  49 automatically, through some external tools making decisions about this. The API
  50 for such tools is described in :doc:`iallocator`.
  51
  52 Most of the functionalities of Ganeti can be programmatically accessed through
  53 an API, the :doc:`rapi`.
  54
  55 Compatibility with the standard OVF virtual machine interchange format is
  56 provided by the :doc:`ovfconverter`.
  57
  58 Mainly for testing reasons, Ganeti also has :doc:`virtual-cluster`.
  59
  60 A few functionalities are explicitly targeted for big installations, where
  61 multiple clusters are present. A tool for merging two existing clusters
  62 is provided, and is described in :doc:`cluster-merge`. There is also a document
  63 describing the procedure for :doc:`move-instance`.
  64
  65 Developing Ganeti
  66 +++++++++++++++++
  67
  68 A few documents useful for who wants to modify Ganeti are available and listed
  69 in this section.
  70
  71 A description of the locking strategy and, in particular, lock order
  72 dependencies is presented in :doc:`locking`.
  73
  74 Build dependencies and other useful development-related information are provided
  75 in the :doc:`devnotes`.
  76
  77 All the features implemented in Ganeti are described in a design document before
  78 being actually implemented. Designs can be implemented in a released version, or
  79 be still draft (and therefore either incomplete or not implemented).
  80
  81 Implemented designs
  82 -------------------
  83 .. toctree::
  84    :maxdepth: 1
  85
  86    design-2.0.rst
  87    design-2.1.rst
  88    design-2.2.rst
  89    design-2.3.rst
  90    design-htools-2.3.rst
  91    design-2.4.rst
  92    design-2.5.rst
  93    design-2.6.rst
  94    design-2.7.rst
  95    design-2.8.rst
  96
  97 Draft designs
  98 -------------
  99 .. toctree::
 100    :maxdepth: 2
 101
 102    design-draft.rst
 103
 104 .. toctree::
 105    :hidden:
 106
 107    admin.rst
 108    cluster-merge.rst
 109    design-autorepair.rst
 110    design-bulk-create.rst
 111    design-chained-jobs.rst
 112    design-cpu-pinning.rst
 113    design-linuxha.rst
 114    design-lu-generated-jobs.rst
 115    design-multi-reloc.rst
 116    design-network.rst
 117    design-node-add.rst
 118    design-oob.rst
 119    design-opportunistic-locking.rst
 120    design-ovf-support.rst
 121    design-query2.rst
 122    design-reason-trail.rst
 123    design-restricted-commands.rst
 124    design-shared-storage.rst
 125    design-virtual-clusters.rst
 126    devnotes.rst
 127    glossary.rst
 128    hooks.rst
 129    iallocator.rst
 130    install.rst
 131    install-quick.rst
 132    locking.rst
 133    manpages.rst
 134    monitoring-query-format.rst
 135    move-instance.rst
 136    news.rst
 137    ovfconverter.rst
 138    rapi.rst
 139    security.rst
 140    upgrade.rst
 141    virtual-cluster.rst
 142    walkthrough
 143
 144 .. vim: set textwidth=72 :