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