Statistics
| Branch: | Tag: | Revision:

root / doc / index.rst @ 56c934da

History | View | Annotate | Download (4.3 kB)

1 d17e74b4 Iustin Pop
.. Ganeti documentation master file,
2 d17e74b4 Iustin Pop
   created by sphinx-quickstart
3 d17e74b4 Iustin Pop
4 d17e74b4 Iustin Pop
Welcome to Ganeti's documentation!
5 d17e74b4 Iustin Pop
==================================
6 d17e74b4 Iustin Pop
7 96357135 Michele Tartara
This page is the starting point for browsing the ganeti documentation. It
8 96357135 Michele Tartara
contains link to all the sections of the documentation, grouped by topic.
9 d17e74b4 Iustin Pop
10 96357135 Michele Tartara
The list of changes between Ganeti versions is provided in the :doc:`news` file.
11 96357135 Michele Tartara
12 96357135 Michele Tartara
In order to help understanding the Ganeti terminology, a :doc:`glossary` is
13 96357135 Michele Tartara
provided.
14 96357135 Michele Tartara
15 96357135 Michele Tartara
Also see the :ref:`search`.
16 96357135 Michele Tartara
17 96357135 Michele Tartara
Installing Ganeti
18 96357135 Michele Tartara
+++++++++++++++++
19 96357135 Michele Tartara
20 96357135 Michele Tartara
In order to install Ganeti, follow the instructions contained in the
21 96357135 Michele Tartara
:doc:`install`.
22 96357135 Michele Tartara
23 12443fb8 Michele Tartara
If you are an experienced user, the content of the :doc:`install-quick` should
24 96357135 Michele Tartara
be enough.
25 96357135 Michele Tartara
26 96357135 Michele Tartara
Instructions for upgrading an existing installation to the latest version of
27 96357135 Michele Tartara
Ganeti are contained in the :doc:`upgrade`.
28 96357135 Michele Tartara
29 96357135 Michele Tartara
Using Ganeti
30 96357135 Michele Tartara
++++++++++++
31 96357135 Michele Tartara
32 96357135 Michele Tartara
Information about how to manage a Ganeti cluster after it has been installed
33 96357135 Michele Tartara
(including management of nodes, instances, info about the tools and the
34 96357135 Michele Tartara
monitoring agent) can be found in :doc:`admin`.
35 96357135 Michele Tartara
36 96357135 Michele Tartara
A more example-oriended guide is available in :doc:`walkthrough`.
37 96357135 Michele Tartara
38 96357135 Michele Tartara
The various tool that are part of Ganeti are described one by one in the
39 96357135 Michele Tartara
:doc:`manpages`.
40 96357135 Michele Tartara
41 864b57d7 Weiwei Jia
A description of the security model underlying a Ganeti cluster can be found in
42 96357135 Michele Tartara
the :doc:`security` document.
43 96357135 Michele Tartara
44 864b57d7 Weiwei Jia
Ganeti functionalities can be extended by hooking scripts automatically
45 96357135 Michele Tartara
activated when certain events happen. Information on this mechanism is provided
46 96357135 Michele Tartara
in the :doc:`hooks` document.
47 96357135 Michele Tartara
48 96357135 Michele Tartara
While using Ganeti, the allocation of instances can happen manually or
49 864b57d7 Weiwei Jia
automatically, through some external tools making decisions about this. The API
50 96357135 Michele Tartara
for such tools is described in :doc:`iallocator`.
51 96357135 Michele Tartara
52 96357135 Michele Tartara
Most of the functionalities of Ganeti can be programmatically accessed through
53 96357135 Michele Tartara
an API, the :doc:`rapi`.
54 96357135 Michele Tartara
55 96357135 Michele Tartara
Compatibility with the standard OVF virtual machine interchange format is
56 96357135 Michele Tartara
provided by the :doc:`ovfconverter`.
57 96357135 Michele Tartara
58 96357135 Michele Tartara
Mainly for testing reasons, Ganeti also has :doc:`virtual-cluster`.
59 96357135 Michele Tartara
60 96357135 Michele Tartara
A few functionalities are explicitly targeted for big installations, where
61 96357135 Michele Tartara
multiple clusters are present. A tool for merging two existing clusters
62 96357135 Michele Tartara
is provided, and is described in :doc:`cluster-merge`. There is also a document
63 96357135 Michele Tartara
describing the procedure for :doc:`move-instance`.
64 96357135 Michele Tartara
65 96357135 Michele Tartara
Developing Ganeti
66 96357135 Michele Tartara
+++++++++++++++++
67 96357135 Michele Tartara
68 96357135 Michele Tartara
A few documents useful for who wants to modify Ganeti are available and listed
69 96357135 Michele Tartara
in this section.
70 96357135 Michele Tartara
71 96357135 Michele Tartara
A description of the locking strategy and, in particular, lock order
72 96357135 Michele Tartara
dependencies is presented in :doc:`locking`.
73 96357135 Michele Tartara
74 96357135 Michele Tartara
Build dependencies and other useful development-related information are provided
75 96357135 Michele Tartara
in the :doc:`devnotes`.
76 96357135 Michele Tartara
77 96357135 Michele Tartara
All the features implemented in Ganeti are described in a design document before
78 96357135 Michele Tartara
being actually implemented. Designs can be implemented in a released version, or
79 96357135 Michele Tartara
be still draft (and therefore either incomplete or not implemented).
80 96357135 Michele Tartara
81 96357135 Michele Tartara
Implemented designs
82 96357135 Michele Tartara
-------------------
83 d17e74b4 Iustin Pop
.. toctree::
84 96357135 Michele Tartara
   :maxdepth: 1
85 d17e74b4 Iustin Pop
86 d17e74b4 Iustin Pop
   design-2.0.rst
87 e2078d28 Iustin Pop
   design-2.1.rst
88 e56bb0e8 Guido Trotter
   design-2.2.rst
89 1eb85930 Guido Trotter
   design-2.3.rst
90 92902e91 Iustin Pop
   design-htools-2.3.rst
91 78b40c5e Michael Hanselmann
   design-2.4.rst
92 d774ce92 Michael Hanselmann
   design-2.5.rst
93 40309ed7 Michael Hanselmann
   design-2.6.rst
94 97aac894 Michael Hanselmann
   design-2.7.rst
95 fab0cf66 Michele Tartara
   design-2.8.rst
96 9d20b835 Klaus Aehlig
   design-2.9.rst
97 adb36960 Thomas Thrainer
   design-2.10.rst
98 96357135 Michele Tartara
99 96357135 Michele Tartara
Draft designs
100 96357135 Michele Tartara
-------------
101 96357135 Michele Tartara
.. toctree::
102 96357135 Michele Tartara
   :maxdepth: 2
103 96357135 Michele Tartara
104 c95c0f71 Michael Hanselmann
   design-draft.rst
105 d17e74b4 Iustin Pop
106 78b40c5e Michael Hanselmann
.. toctree::
107 78b40c5e Michael Hanselmann
   :hidden:
108 78b40c5e Michael Hanselmann
109 96357135 Michele Tartara
   admin.rst
110 96357135 Michele Tartara
   cluster-merge.rst
111 fab0cf66 Michele Tartara
   design-autorepair.rst
112 97aac894 Michael Hanselmann
   design-bulk-create.rst
113 d774ce92 Michael Hanselmann
   design-chained-jobs.rst
114 fc4c21fa Thomas Thrainer
   design-cmdlib-unittests.rst
115 40309ed7 Michael Hanselmann
   design-cpu-pinning.rst
116 9d20b835 Klaus Aehlig
   design-device-uuid-name.rst
117 9d20b835 Klaus Aehlig
   design-hroller.rst
118 fc4c21fa Thomas Thrainer
   design-hotplug.rst
119 96357135 Michele Tartara
   design-linuxha.rst
120 97aac894 Michael Hanselmann
   design-lu-generated-jobs.rst
121 9d20b835 Klaus Aehlig
   design-monitoring-agent.rst
122 97aac894 Michael Hanselmann
   design-multi-reloc.rst
123 a8b1e9f8 Hrvoje Ribicic
   design-multi-version-tests.rst
124 96357135 Michele Tartara
   design-network.rst
125 98a83f17 Michael Hanselmann
   design-node-add.rst
126 c2a3c07d Helga Velroyen
   design-node-security.rst
127 97aac894 Michael Hanselmann
   design-oob.rst
128 fc4c21fa Thomas Thrainer
   design-openvswitch.rst
129 98a83f17 Michael Hanselmann
   design-opportunistic-locking.rst
130 40309ed7 Michael Hanselmann
   design-ovf-support.rst
131 9d20b835 Klaus Aehlig
   design-partitioned
132 97aac894 Michael Hanselmann
   design-query2.rst
133 fab0cf66 Michele Tartara
   design-reason-trail.rst
134 45bc4635 Iustin Pop
   design-restricted-commands.rst
135 97aac894 Michael Hanselmann
   design-shared-storage.rst
136 fc4c21fa Thomas Thrainer
   design-storagetypes.rst
137 fc4c21fa Thomas Thrainer
   design-upgrade.rst
138 98a83f17 Michael Hanselmann
   design-virtual-clusters.rst
139 96357135 Michele Tartara
   devnotes.rst
140 96357135 Michele Tartara
   glossary.rst
141 96357135 Michele Tartara
   hooks.rst
142 96357135 Michele Tartara
   iallocator.rst
143 96357135 Michele Tartara
   install.rst
144 96357135 Michele Tartara
   install-quick.rst
145 96357135 Michele Tartara
   locking.rst
146 96357135 Michele Tartara
   manpages.rst
147 431ff2c1 Michele Tartara
   monitoring-query-format.rst
148 96357135 Michele Tartara
   move-instance.rst
149 96357135 Michele Tartara
   news.rst
150 96357135 Michele Tartara
   ovfconverter.rst
151 96357135 Michele Tartara
   rapi.rst
152 96357135 Michele Tartara
   security.rst
153 96357135 Michele Tartara
   upgrade.rst
154 96357135 Michele Tartara
   virtual-cluster.rst
155 96357135 Michele Tartara
   walkthrough
156 558fd122 Michael Hanselmann
157 558fd122 Michael Hanselmann
.. vim: set textwidth=72 :