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