Revision 310c246f doc/index.rst
| b/doc/index.rst | ||
|---|---|---|
| 4 | 4 |
Welcome to Ganeti's documentation! |
| 5 | 5 |
================================== |
| 6 | 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.
|
|
| 7 |
This page is the starting point for browsing the Ganeti documentation. It
|
|
| 8 |
contains links to all the sections of Ganeti documentation, grouped by topic.
|
|
| 9 | 9 |
|
| 10 |
The list of changes between Ganeti versions is provided in the :doc:`news` file.
|
|
| 10 |
A few quick references:
|
|
| 11 | 11 |
|
| 12 |
In order to help understanding the Ganeti terminology, a :doc:`glossary` is |
|
| 13 |
provided. |
|
| 14 |
|
|
| 15 |
Also see the :ref:`search`. |
|
| 12 |
- :doc:`glossary`: Provides explanations of basic Ganeti terminology. |
|
| 13 |
- :doc:`news` file: Lists changes between Ganeti versions. |
|
| 14 |
- :ref:`search`: Allows you to search for key terms across Ganeti documentation. |
|
| 16 | 15 |
|
| 17 | 16 |
Installing Ganeti |
| 18 | 17 |
+++++++++++++++++ |
| 19 | 18 |
|
| 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. |
|
| 19 |
There are a few resources you can use to install and/or upgrade Ganeti: |
|
| 25 | 20 |
|
| 26 |
Instructions for upgrading an existing installation to the latest version of |
|
| 27 |
Ganeti are contained in the :doc:`upgrade`. |
|
| 21 |
- :doc:`install`: Comprehensive instructions for installing Ganeti. |
|
| 22 |
- :doc:`install-quick`: A shortened installation guide for the experienced Ganeti user. |
|
| 23 |
- :doc:`upgrade`: Instructions for upgrading an existing installation to the latest version of Ganeti. |
|
| 28 | 24 |
|
| 29 | 25 |
Using Ganeti |
| 30 | 26 |
++++++++++++ |
| 31 | 27 |
|
| 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. |
|
| 28 |
The following resources provide guidance on how to use Ganeti: |
|
| 47 | 29 |
|
| 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`. |
|
| 30 |
- :doc:`admin`: Information about how to manage a Ganeti cluster after it is installed (including management of nodes, instances, and information about the tools and the monitoring agent). |
|
| 31 |
- :doc:`walkthrough`: A more example-oriented guide to Ganeti. |
|
| 32 |
- :doc:`manpages`: Descriptions of the various tools that are part of Ganeti. |
|
| 33 |
- :doc:`security`: A description of the security model underlying a Ganeti cluster. |
|
| 34 |
- :doc:`hooks`: Information on hooking scripts, which extend Ganeti functionalities by automatically activating when certain events happen. |
|
| 35 |
- :doc:`iallocator`: Description of the API for external tools which can allocate instances either manually or automatically. |
|
| 36 |
- :doc:`rapi`: Details the Ganeti remote API, which allows programmatic access to most of the functionalities of Ganeti. |
|
| 37 |
- :doc:`ovfconverter`: Provides compatibility with the standard OVF virtual machine interchange format. |
|
| 38 |
- :doc:`virtual-cluster`: Describes how to use virtual cluster support, which is utilized mainly for testing reasons. |
|
| 51 | 39 |
|
| 52 |
Most of the functionalities of Ganeti can be programmatically accessed through
|
|
| 53 |
an API, the :doc:`rapi`.
|
|
| 40 |
A few functionalities are explicitly targeted for big installations, in which
|
|
| 41 |
multiple clusters are present.
|
|
| 54 | 42 |
|
| 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`. |
|
| 43 |
- :doc:`cluster-merge`: Describes a tool for merging two existing clusters. |
|
| 44 |
- :doc:`move-instance`: Describes how to move instances between clusters. |
|
| 64 | 45 |
|
| 65 | 46 |
Developing Ganeti |
| 66 | 47 |
+++++++++++++++++ |
| 67 | 48 |
|
| 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`. |
|
| 49 |
There are a few useful documents for developers who want to modify Ganeti: |
|
| 73 | 50 |
|
| 74 |
Build dependencies and other useful development-related information are provided
|
|
| 75 |
in the :doc:`devnotes`.
|
|
| 51 |
- :doc:`locking`: Describes Ganeti's locking strategy and, in particular, lock order dependencies.
|
|
| 52 |
- :doc:`devnotes`: Details build dependencies and other useful development-related information.
|
|
| 76 | 53 |
|
| 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 | 54 |
|
| 81 | 55 |
Implemented designs |
| 82 | 56 |
------------------- |
| 57 |
|
|
| 58 |
Before actual implementation, all Ganeti features are described in a design |
|
| 59 |
document. Designs fall into two categories: released versions and draft versions |
|
| 60 |
(which are either incomplete or not implemented). |
|
| 61 |
|
|
| 83 | 62 |
.. toctree:: |
| 84 | 63 |
:maxdepth: 1 |
| 85 | 64 |
|
| ... | ... | |
| 145 | 124 |
upgrade.rst |
| 146 | 125 |
virtual-cluster.rst |
| 147 | 126 |
walkthrough |
| 148 |
|
|
| 149 |
.. vim: set textwidth=72 : |
|
Also available in: Unified diff