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 documentation. It
8 contains link to all the sections of the documentation, grouped by topic.
10 The list of changes between Ganeti versions is provided in the :doc:`news` file.
12 In order to help understanding the Ganeti terminology, a :doc:`glossary` is
15 Also see the :ref:`search`.
20 In order to install Ganeti, follow the instructions contained in the
23 If you are an experienced user, the content of the :doc:`install-quick` should
26 Instructions for upgrading an existing installation to the latest version of
27 Ganeti are contained in the :doc:`upgrade`.
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`.
36 A more example-oriended guide is available in :doc:`walkthrough`.
38 The various tool that are part of Ganeti are described one by one in the
41 A description of the security model underlying a Ganeti cluster can be found in
42 the :doc:`security` document.
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.
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`.
52 Most of the functionalities of Ganeti can be programmatically accessed through
53 an API, the :doc:`rapi`.
55 Compatibility with the standard OVF virtual machine interchange format is
56 provided by the :doc:`ovfconverter`.
58 Mainly for testing reasons, Ganeti also has :doc:`virtual-cluster`.
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`.
68 A few documents useful for who wants to modify Ganeti are available and listed
71 A description of the locking strategy and, in particular, lock order
72 dependencies is presented in :doc:`locking`.
74 Build dependencies and other useful development-related information are provided
75 in the :doc:`devnotes`.
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).
110 design-autorepair.rst
111 design-bulk-create.rst
112 design-chained-jobs.rst
113 design-cpu-pinning.rst
114 design-device-uuid-name.rst
117 design-lu-generated-jobs.rst
118 design-monitoring-agent.rst
119 design-multi-reloc.rst
123 design-opportunistic-locking.rst
124 design-ovf-support.rst
127 design-reason-trail.rst
128 design-restricted-commands.rst
129 design-shared-storage.rst
130 design-virtual-clusters.rst
139 monitoring-query-format.rst
149 .. vim: set textwidth=72 :