Revision 11a0e343 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 links to all the sections of Ganeti documentation, grouped by topic. |
|
| 7 |
This page is the starting point for browsing the Ganeti |
|
| 8 |
documentation. Below, the corpus of Ganeti documentation is grouped by |
|
| 9 |
topic. |
|
| 9 | 10 |
|
| 10 | 11 |
A few quick references: |
| 11 | 12 |
|
| ... | ... | |
| 16 | 17 |
Installing Ganeti |
| 17 | 18 |
+++++++++++++++++ |
| 18 | 19 |
|
| 19 |
There are a few resources you can use to install and/or upgrade Ganeti:
|
|
| 20 |
Use the following resources to install and/or upgrade Ganeti:
|
|
| 20 | 21 |
|
| 21 | 22 |
- :doc:`install`: Comprehensive instructions for installing Ganeti. |
| 22 | 23 |
- :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.
|
|
| 24 |
- :doc:`upgrade`: Instructions for upgrading an existing Ganeti installation to the latest version.
|
|
| 24 | 25 |
|
| 25 | 26 |
Using Ganeti |
| 26 | 27 |
++++++++++++ |
| 27 | 28 |
|
| 28 | 29 |
The following resources provide guidance on how to use Ganeti: |
| 29 | 30 |
|
| 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.
|
|
| 31 |
- :doc:`admin`: Information about how to manage a Ganeti cluster after it is installed (including management of nodes and instances, and information about Ganeti's tools and monitoring agent).
|
|
| 32 |
- :doc:`walkthrough`: An example-oriented guide to Ganeti.
|
|
| 32 | 33 |
- :doc:`manpages`: Descriptions of the various tools that are part of Ganeti. |
| 33 | 34 |
- :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.
|
|
| 35 |
- :doc:`hooks`: Information on hooking scripts, which extend Ganeti functionalities by automatically activating when certain events occur.
|
|
| 36 |
- :doc:`iallocator`: Description of the API for external tools, which can allocate instances either manually or automatically.
|
|
| 37 |
- :doc:`rapi`: Description of the Ganeti remote API, which allows programmatic access to most of the functionalities of Ganeti.
|
|
| 38 |
- :doc:`ovfconverter`: Description of a tool that provides compatibility with the standard OVF virtual machine interchange format.
|
|
| 39 |
- :doc:`virtual-cluster`: Explanation of how to use virtual cluster support, which is utilized mainly for testing reasons.
|
|
| 39 | 40 |
|
| 40 |
A few functionalities are explicitly targeted for big installations, in which
|
|
| 41 |
multiple clusters are present.
|
|
| 41 |
Some features are explicitly targeted for large Ganeti installations,
|
|
| 42 |
in which multiple clusters are present:
|
|
| 42 | 43 |
|
| 43 | 44 |
- :doc:`cluster-merge`: Describes a tool for merging two existing clusters. |
| 44 | 45 |
- :doc:`move-instance`: Describes how to move instances between clusters. |
| ... | ... | |
| 46 | 47 |
Developing Ganeti |
| 47 | 48 |
+++++++++++++++++ |
| 48 | 49 |
|
| 49 |
There are a few useful documents for developers who want to modify Ganeti: |
|
| 50 |
There are a few documents particularly useful for developers who want |
|
| 51 |
to modify Ganeti: |
|
| 50 | 52 |
|
| 51 |
- :doc:`locking`: Describes Ganeti's locking strategy and, in particular, lock order dependencies.
|
|
| 53 |
- :doc:`locking`: Describes Ganeti's locking strategy and lock order dependencies. |
|
| 52 | 54 |
- :doc:`devnotes`: Details build dependencies and other useful development-related information. |
| 53 | 55 |
|
| 54 | 56 |
|
| 55 | 57 |
Implemented designs |
| 56 | 58 |
------------------- |
| 57 | 59 |
|
| 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). |
|
| 60 |
Before actual implementation, all Ganeti features are described in a |
|
| 61 |
design document. Designs fall into two categories: released versions
|
|
| 62 |
and draft versions (which are either incomplete or not implemented).
|
|
| 61 | 63 |
|
| 62 | 64 |
.. toctree:: |
| 63 | 65 |
:maxdepth: 1 |
| ... | ... | |
| 124 | 126 |
upgrade.rst |
| 125 | 127 |
virtual-cluster.rst |
| 126 | 128 |
walkthrough |
| 129 |
|
|
| 130 |
.. vim: set textwidth=72 : |
|
Also available in: Unified diff