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
   8 documentation. Below, the corpus of Ganeti documentation is grouped by
   9 topic.
  10
  11 A few quick references:
  12
  13 - :doc:`glossary`: Provides explanations of basic Ganeti terminology.
  14 - :doc:`news` file: Lists changes between Ganeti versions.
  15 - :ref:`search`: Allows you to search for key terms across Ganeti documentation.
  16
  17 Installing Ganeti
  18 +++++++++++++++++
  19
  20 Use the following resources to install and/or upgrade Ganeti:
  21
  22 - :doc:`install`: Comprehensive instructions for installing Ganeti.
  23 - :doc:`install-quick`: A shortened installation guide for the experienced Ganeti user.
  24 - :doc:`upgrade`: Instructions for upgrading an existing Ganeti installation to the latest version.
  25
  26 Using Ganeti
  27 ++++++++++++
  28
  29 The following resources provide guidance on how to use Ganeti:
  30
  31 - :doc:`admin`: Information about how to manage a Ganeti cluster after it is installed (including management of nodes and instances, and information about Ganeti's tools and monitoring agent).
  32 - :doc:`walkthrough`: An example-oriented guide to Ganeti.
  33 - :doc:`manpages`: Descriptions of the various tools that are part of Ganeti.
  34 - :doc:`security`: A description of the security model underlying a Ganeti cluster.
  35 - :doc:`hooks`: Information on hooking scripts, which extend Ganeti functionalities by automatically activating when certain events occur.
  36 - :doc:`iallocator`: Description of the API for external tools, which can allocate instances either manually or automatically.
  37 - :doc:`rapi`: Description of the Ganeti remote API, which allows programmatic access to most of the functionalities of Ganeti.
  38 - :doc:`ovfconverter`: Description of a tool that provides compatibility with the standard OVF virtual machine interchange format.
  39 - :doc:`virtual-cluster`: Explanation of how to use virtual cluster support, which is utilized mainly for testing reasons.
  40
  41 Some features are explicitly targeted for large Ganeti installations,
  42 in which multiple clusters are present:
  43
  44 - :doc:`cluster-merge`: Describes a tool for merging two existing clusters.
  45 - :doc:`move-instance`: Describes how to move instances between clusters.
  46
  47 Developing Ganeti
  48 +++++++++++++++++
  49
  50 There are a few documents particularly useful for developers who want
  51 to modify Ganeti:
  52
  53 - :doc:`locking`: Describes Ganeti's locking strategy and lock order dependencies.
  54 - :doc:`devnotes`: Details build dependencies and other useful development-related information.
  55
  56
  57 Implemented designs
  58 -------------------
  59
  60 Before actual implementation, all Ganeti features are described in a
  61 design document. Designs fall into two categories: released versions
  62 and draft versions (which are either incomplete or not implemented).
  63
  64 .. toctree::
  65    :maxdepth: 1
  66
  67    design-2.0.rst
  68    design-2.1.rst
  69    design-2.2.rst
  70    design-2.3.rst
  71    design-htools-2.3.rst
  72    design-2.4.rst
  73    design-2.5.rst
  74    design-2.6.rst
  75    design-2.7.rst
  76    design-2.8.rst
  77    design-2.9.rst
  78
  79 Draft designs
  80 -------------
  81 .. toctree::
  82    :maxdepth: 2
  83
  84    design-draft.rst
  85
  86 .. toctree::
  87    :hidden:
  88
  89    admin.rst
  90    cluster-merge.rst
  91    design-autorepair.rst
  92    design-bulk-create.rst
  93    design-chained-jobs.rst
  94    design-cpu-pinning.rst
  95    design-device-uuid-name.rst
  96    design-hroller.rst
  97    design-linuxha.rst
  98    design-lu-generated-jobs.rst
  99    design-monitoring-agent.rst
 100    design-multi-reloc.rst
 101    design-network.rst
 102    design-node-add.rst
 103    design-oob.rst
 104    design-opportunistic-locking.rst
 105    design-ovf-support.rst
 106    design-partitioned
 107    design-query2.rst
 108    design-reason-trail.rst
 109    design-restricted-commands.rst
 110    design-shared-storage.rst
 111    design-virtual-clusters.rst
 112    devnotes.rst
 113    glossary.rst
 114    hooks.rst
 115    iallocator.rst
 116    install.rst
 117    install-quick.rst
 118    locking.rst
 119    manpages.rst
 120    monitoring-query-format.rst
 121    move-instance.rst
 122    news.rst
 123    ovfconverter.rst
 124    rapi.rst
 125    security.rst
 126    upgrade.rst
 127    virtual-cluster.rst
 128    walkthrough
 129
 130 .. vim: set textwidth=72 :