root / doc / index.rst @ 0565f862
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 | 11a0e343 | Jose A. Lopes | This page is the starting point for browsing the Ganeti |
8 | 11a0e343 | Jose A. Lopes | documentation. Below, the corpus of Ganeti documentation is grouped by |
9 | 11a0e343 | Jose A. Lopes | topic. |
10 | d17e74b4 | Iustin Pop | |
11 | 310c246f | Jose A. Lopes | A few quick references: |
12 | 96357135 | Michele Tartara | |
13 | 310c246f | Jose A. Lopes | - :doc:`glossary`: Provides explanations of basic Ganeti terminology. |
14 | 310c246f | Jose A. Lopes | - :doc:`news` file: Lists changes between Ganeti versions. |
15 | 310c246f | Jose A. Lopes | - :ref:`search`: Allows you to search for key terms across Ganeti documentation. |
16 | 96357135 | Michele Tartara | |
17 | 96357135 | Michele Tartara | Installing Ganeti |
18 | 96357135 | Michele Tartara | +++++++++++++++++ |
19 | 96357135 | Michele Tartara | |
20 | 11a0e343 | Jose A. Lopes | Use the following resources to install and/or upgrade Ganeti: |
21 | 96357135 | Michele Tartara | |
22 | 310c246f | Jose A. Lopes | - :doc:`install`: Comprehensive instructions for installing Ganeti. |
23 | 310c246f | Jose A. Lopes | - :doc:`install-quick`: A shortened installation guide for the experienced Ganeti user. |
24 | 11a0e343 | Jose A. Lopes | - :doc:`upgrade`: Instructions for upgrading an existing Ganeti installation to the latest version. |
25 | 96357135 | Michele Tartara | |
26 | 96357135 | Michele Tartara | Using Ganeti |
27 | 96357135 | Michele Tartara | ++++++++++++ |
28 | 96357135 | Michele Tartara | |
29 | 310c246f | Jose A. Lopes | The following resources provide guidance on how to use Ganeti: |
30 | 96357135 | Michele Tartara | |
31 | 11a0e343 | Jose A. Lopes | - :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 | 11a0e343 | Jose A. Lopes | - :doc:`walkthrough`: An example-oriented guide to Ganeti. |
33 | 310c246f | Jose A. Lopes | - :doc:`manpages`: Descriptions of the various tools that are part of Ganeti. |
34 | 310c246f | Jose A. Lopes | - :doc:`security`: A description of the security model underlying a Ganeti cluster. |
35 | 11a0e343 | Jose A. Lopes | - :doc:`hooks`: Information on hooking scripts, which extend Ganeti functionalities by automatically activating when certain events occur. |
36 | 11a0e343 | Jose A. Lopes | - :doc:`iallocator`: Description of the API for external tools, which can allocate instances either manually or automatically. |
37 | 11a0e343 | Jose A. Lopes | - :doc:`rapi`: Description of the Ganeti remote API, which allows programmatic access to most of the functionalities of Ganeti. |
38 | 11a0e343 | Jose A. Lopes | - :doc:`ovfconverter`: Description of a tool that provides compatibility with the standard OVF virtual machine interchange format. |
39 | 11a0e343 | Jose A. Lopes | - :doc:`virtual-cluster`: Explanation of how to use virtual cluster support, which is utilized mainly for testing reasons. |
40 | 96357135 | Michele Tartara | |
41 | 11a0e343 | Jose A. Lopes | Some features are explicitly targeted for large Ganeti installations, |
42 | 11a0e343 | Jose A. Lopes | in which multiple clusters are present: |
43 | 96357135 | Michele Tartara | |
44 | 310c246f | Jose A. Lopes | - :doc:`cluster-merge`: Describes a tool for merging two existing clusters. |
45 | 310c246f | Jose A. Lopes | - :doc:`move-instance`: Describes how to move instances between clusters. |
46 | 96357135 | Michele Tartara | |
47 | 96357135 | Michele Tartara | Developing Ganeti |
48 | 96357135 | Michele Tartara | +++++++++++++++++ |
49 | 96357135 | Michele Tartara | |
50 | 11a0e343 | Jose A. Lopes | There are a few documents particularly useful for developers who want |
51 | 11a0e343 | Jose A. Lopes | to modify Ganeti: |
52 | 96357135 | Michele Tartara | |
53 | 11a0e343 | Jose A. Lopes | - :doc:`locking`: Describes Ganeti's locking strategy and lock order dependencies. |
54 | 310c246f | Jose A. Lopes | - :doc:`devnotes`: Details build dependencies and other useful development-related information. |
55 | 96357135 | Michele Tartara | |
56 | 96357135 | Michele Tartara | |
57 | 96357135 | Michele Tartara | Implemented designs |
58 | 96357135 | Michele Tartara | ------------------- |
59 | 310c246f | Jose A. Lopes | |
60 | 11a0e343 | Jose A. Lopes | Before actual implementation, all Ganeti features are described in a |
61 | 11a0e343 | Jose A. Lopes | design document. Designs fall into two categories: released versions |
62 | 11a0e343 | Jose A. Lopes | and draft versions (which are either incomplete or not implemented). |
63 | 310c246f | Jose A. Lopes | |
64 | d17e74b4 | Iustin Pop | .. toctree:: |
65 | 96357135 | Michele Tartara | :maxdepth: 1 |
66 | d17e74b4 | Iustin Pop | |
67 | d17e74b4 | Iustin Pop | design-2.0.rst |
68 | e2078d28 | Iustin Pop | design-2.1.rst |
69 | e56bb0e8 | Guido Trotter | design-2.2.rst |
70 | 1eb85930 | Guido Trotter | design-2.3.rst |
71 | 92902e91 | Iustin Pop | design-htools-2.3.rst |
72 | 78b40c5e | Michael Hanselmann | design-2.4.rst |
73 | d774ce92 | Michael Hanselmann | design-2.5.rst |
74 | 40309ed7 | Michael Hanselmann | design-2.6.rst |
75 | 97aac894 | Michael Hanselmann | design-2.7.rst |
76 | fab0cf66 | Michele Tartara | design-2.8.rst |
77 | 9d20b835 | Klaus Aehlig | design-2.9.rst |
78 | adb36960 | Thomas Thrainer | design-2.10.rst |
79 | 711897ae | Jose A. Lopes | design-2.11.rst |
80 | 96357135 | Michele Tartara | |
81 | 96357135 | Michele Tartara | Draft designs |
82 | 96357135 | Michele Tartara | ------------- |
83 | 96357135 | Michele Tartara | .. toctree:: |
84 | 96357135 | Michele Tartara | :maxdepth: 2 |
85 | 96357135 | Michele Tartara | |
86 | c95c0f71 | Michael Hanselmann | design-draft.rst |
87 | d17e74b4 | Iustin Pop | |
88 | 78b40c5e | Michael Hanselmann | .. toctree:: |
89 | 78b40c5e | Michael Hanselmann | :hidden: |
90 | 78b40c5e | Michael Hanselmann | |
91 | 96357135 | Michele Tartara | admin.rst |
92 | 96357135 | Michele Tartara | cluster-merge.rst |
93 | bced76fd | Jose A. Lopes | cluster-keys-replacement.rst |
94 | fab0cf66 | Michele Tartara | design-autorepair.rst |
95 | 97aac894 | Michael Hanselmann | design-bulk-create.rst |
96 | d774ce92 | Michael Hanselmann | design-chained-jobs.rst |
97 | fc4c21fa | Thomas Thrainer | design-cmdlib-unittests.rst |
98 | 40309ed7 | Michael Hanselmann | design-cpu-pinning.rst |
99 | 9d20b835 | Klaus Aehlig | design-device-uuid-name.rst |
100 | bced76fd | Jose A. Lopes | design-file-based-storage.rst |
101 | 9d20b835 | Klaus Aehlig | design-hroller.rst |
102 | fc4c21fa | Thomas Thrainer | design-hotplug.rst |
103 | 333bd799 | Jose A. Lopes | design-kvmd.rst |
104 | 96357135 | Michele Tartara | design-linuxha.rst |
105 | 97aac894 | Michael Hanselmann | design-lu-generated-jobs.rst |
106 | 9d20b835 | Klaus Aehlig | design-monitoring-agent.rst |
107 | 97aac894 | Michael Hanselmann | design-multi-reloc.rst |
108 | a8b1e9f8 | Hrvoje Ribicic | design-multi-version-tests.rst |
109 | 96357135 | Michele Tartara | design-network.rst |
110 | 98a83f17 | Michael Hanselmann | design-node-add.rst |
111 | c2a3c07d | Helga Velroyen | design-node-security.rst |
112 | 97aac894 | Michael Hanselmann | design-oob.rst |
113 | fc4c21fa | Thomas Thrainer | design-openvswitch.rst |
114 | 98a83f17 | Michael Hanselmann | design-opportunistic-locking.rst |
115 | 2cb36124 | Jose A. Lopes | design-os.rst |
116 | 40309ed7 | Michael Hanselmann | design-ovf-support.rst |
117 | 9d20b835 | Klaus Aehlig | design-partitioned |
118 | 97aac894 | Michael Hanselmann | design-query2.rst |
119 | fab0cf66 | Michele Tartara | design-reason-trail.rst |
120 | 45bc4635 | Iustin Pop | design-restricted-commands.rst |
121 | 97aac894 | Michael Hanselmann | design-shared-storage.rst |
122 | fc4c21fa | Thomas Thrainer | design-storagetypes.rst |
123 | fc4c21fa | Thomas Thrainer | design-upgrade.rst |
124 | 98a83f17 | Michael Hanselmann | design-virtual-clusters.rst |
125 | 96357135 | Michele Tartara | devnotes.rst |
126 | 9110fb4a | Santi Raffa | dev-codestyle.rst |
127 | 96357135 | Michele Tartara | glossary.rst |
128 | 96357135 | Michele Tartara | hooks.rst |
129 | 96357135 | Michele Tartara | iallocator.rst |
130 | 96357135 | Michele Tartara | install.rst |
131 | 96357135 | Michele Tartara | install-quick.rst |
132 | 96357135 | Michele Tartara | locking.rst |
133 | 96357135 | Michele Tartara | manpages.rst |
134 | 431ff2c1 | Michele Tartara | monitoring-query-format.rst |
135 | 96357135 | Michele Tartara | move-instance.rst |
136 | 96357135 | Michele Tartara | news.rst |
137 | 96357135 | Michele Tartara | ovfconverter.rst |
138 | 96357135 | Michele Tartara | rapi.rst |
139 | 96357135 | Michele Tartara | security.rst |
140 | 96357135 | Michele Tartara | upgrade.rst |
141 | 96357135 | Michele Tartara | virtual-cluster.rst |
142 | 96357135 | Michele Tartara | walkthrough |
143 | 558fd122 | Michael Hanselmann | |
144 | 558fd122 | Michael Hanselmann | .. vim: set textwidth=72 : |