Statistics
| Branch: | Tag: | Revision:

root / doc / index.rst @ 9110fb4a

History | View | Annotate | Download (4.3 kB)

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 link to all the sections of the documentation, grouped by topic.
9

    
10
The list of changes between Ganeti versions is provided in the :doc:`news` file.
11

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

    
15
Also see the :ref:`search`.
16

    
17
Installing Ganeti
18
+++++++++++++++++
19

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

    
23
If you are an experienced user, the content of the :doc:`install-quick` should
24
be enough.
25

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

    
29
Using Ganeti
30
++++++++++++
31

    
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`.
35

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

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

    
41
A description of the security model underlying a Ganeti cluster can be found in
42
the :doc:`security` document.
43

    
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.
47

    
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`.
51

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

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

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

    
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`.
64

    
65
Developing Ganeti
66
+++++++++++++++++
67

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

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

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

    
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).
80

    
81
Implemented designs
82
-------------------
83
.. toctree::
84
   :maxdepth: 1
85

    
86
   design-2.0.rst
87
   design-2.1.rst
88
   design-2.2.rst
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
   design-2.9.rst
97
   design-2.10.rst
98

    
99
Draft designs
100
-------------
101
.. toctree::
102
   :maxdepth: 2
103

    
104
   design-draft.rst
105

    
106
.. toctree::
107
   :hidden:
108

    
109
   admin.rst
110
   cluster-merge.rst
111
   design-autorepair.rst
112
   design-bulk-create.rst
113
   design-chained-jobs.rst
114
   design-cmdlib-unittests.rst
115
   design-cpu-pinning.rst
116
   design-device-uuid-name.rst
117
   design-hroller.rst
118
   design-hotplug.rst
119
   design-linuxha.rst
120
   design-lu-generated-jobs.rst
121
   design-monitoring-agent.rst
122
   design-multi-reloc.rst
123
   design-multi-version-tests.rst
124
   design-network.rst
125
   design-node-add.rst
126
   design-node-security.rst
127
   design-oob.rst
128
   design-openvswitch.rst
129
   design-opportunistic-locking.rst
130
   design-ovf-support.rst
131
   design-partitioned
132
   design-query2.rst
133
   design-reason-trail.rst
134
   design-restricted-commands.rst
135
   design-shared-storage.rst
136
   design-storagetypes.rst
137
   design-upgrade.rst
138
   design-virtual-clusters.rst
139
   devnotes.rst
140
   dev-codestyle.rst
141
   glossary.rst
142
   hooks.rst
143
   iallocator.rst
144
   install.rst
145
   install-quick.rst
146
   locking.rst
147
   manpages.rst
148
   monitoring-query-format.rst
149
   move-instance.rst
150
   news.rst
151
   ovfconverter.rst
152
   rapi.rst
153
   security.rst
154
   upgrade.rst
155
   virtual-cluster.rst
156
   walkthrough
157

    
158
.. vim: set textwidth=72 :