1 .. Ganeti documentation master file,
2 created by sphinx-quickstart
4 Welcome to Ganeti's documentation!
5 ==================================
7 This page is the starting point for browsing the Ganeti
8 documentation. Below, the corpus of Ganeti documentation is grouped by
11 A few quick references:
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.
20 Use the following resources to install and/or upgrade Ganeti:
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.
29 The following resources provide guidance on how to use Ganeti:
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.
41 Some features are explicitly targeted for large Ganeti installations,
42 in which multiple clusters are present:
44 - :doc:`cluster-merge`: Describes a tool for merging two existing clusters.
45 - :doc:`move-instance`: Describes how to move instances between clusters.
50 There are a few documents particularly useful for developers who want
53 - :doc:`locking`: Describes Ganeti's locking strategy and lock order dependencies.
54 - :doc:`devnotes`: Details build dependencies and other useful development-related information.
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).
92 cluster-keys-replacement.rst
94 design-bulk-create.rst
95 design-chained-jobs.rst
96 design-cmdlib-unittests.rst
97 design-cpu-pinning.rst
98 design-device-uuid-name.rst
99 design-file-based-storage.rst
103 design-lu-generated-jobs.rst
104 design-monitoring-agent.rst
105 design-multi-reloc.rst
109 design-openvswitch.rst
110 design-opportunistic-locking.rst
111 design-ovf-support.rst
114 design-reason-trail.rst
115 design-restricted-commands.rst
116 design-shared-storage.rst
117 design-storagetypes.rst
119 design-virtual-clusters.rst
129 monitoring-query-format.rst
139 .. vim: set textwidth=72 :