index.rst 3.93 KB
Newer Older
1
2
3
4
5
6
.. Ganeti documentation master file,
   created by sphinx-quickstart

Welcome to Ganeti's documentation!
==================================

7
8
This page is the starting point for browsing the ganeti documentation. It
contains link to all the sections of the documentation, grouped by topic.
9

10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
The list of changes between Ganeti versions is provided in the :doc:`news` file.

In order to help understanding the Ganeti terminology, a :doc:`glossary` is
provided.

Also see the :ref:`search`.

Installing Ganeti
+++++++++++++++++

In order to install Ganeti, follow the instructions contained in the
:doc:`install`.

If you are an experience user, the content of the :doc:`install-quick` should
be enough.

Instructions for upgrading an existing installation to the latest version of
Ganeti are contained in the :doc:`upgrade`.

Using Ganeti
++++++++++++

Information about how to manage a Ganeti cluster after it has been installed
(including management of nodes, instances, info about the tools and the
monitoring agent) can be found in :doc:`admin`.

A more example-oriended guide is available in :doc:`walkthrough`.

The various tool that are part of Ganeti are described one by one in the
:doc:`manpages`.

A description of the security model underlying a Ganeti cluster can be find in
the :doc:`security` document.

Ganeti functionalities can be extended be hooking scripts automatically
activated when certain events happen. Information on this mechanism is provided
in the :doc:`hooks` document.

While using Ganeti, the allocation of instances can happen manually or
automatically, through some external tool making decisions about this. The API
for such tools is described in :doc:`iallocator`.

Most of the functionalities of Ganeti can be programmatically accessed through
an API, the :doc:`rapi`.

Compatibility with the standard OVF virtual machine interchange format is
provided by the :doc:`ovfconverter`.

Mainly for testing reasons, Ganeti also has :doc:`virtual-cluster`.

A few functionalities are explicitly targeted for big installations, where
multiple clusters are present. A tool for merging two existing clusters
is provided, and is described in :doc:`cluster-merge`. There is also a document
describing the procedure for :doc:`move-instance`.

Developing Ganeti
+++++++++++++++++

A few documents useful for who wants to modify Ganeti are available and listed
in this section.

A description of the locking strategy and, in particular, lock order
dependencies is presented in :doc:`locking`.

Build dependencies and other useful development-related information are provided
in the :doc:`devnotes`.

All the features implemented in Ganeti are described in a design document before
being actually implemented. Designs can be implemented in a released version, or
be still draft (and therefore either incomplete or not implemented).

Implemented designs
-------------------
83
.. toctree::
84
   :maxdepth: 1
85
86

   design-2.0.rst
87
   design-2.1.rst
88
   design-2.2.rst
Guido Trotter's avatar
Guido Trotter committed
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
98
99
100
101

Draft designs
-------------
.. toctree::
   :maxdepth: 2

102
   design-draft.rst
103

104
105
106
.. toctree::
   :hidden:

107
108
   admin.rst
   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
115
   design-lu-generated-jobs.rst
   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
127
128
129
130
131
132
133
   devnotes.rst
   glossary.rst
   hooks.rst
   iallocator.rst
   install.rst
   install-quick.rst
   locking.rst
   manpages.rst
134
   monitoring-query-format.rst
135
136
137
138
139
140
141
142
   move-instance.rst
   news.rst
   ovfconverter.rst
   rapi.rst
   security.rst
   upgrade.rst
   virtual-cluster.rst
   walkthrough
143
144

.. vim: set textwidth=72 :