index.rst 4.84 KB
Newer Older
1 2 3 4 5 6
.. Ganeti documentation master file,
   created by sphinx-quickstart

Welcome to Ganeti's documentation!
==================================

7 8 9
This page is the starting point for browsing the Ganeti
documentation. Below, the corpus of Ganeti documentation is grouped by
topic.
10

11
A few quick references:
12

13 14 15
- :doc:`glossary`: Provides explanations of basic Ganeti terminology.
- :doc:`news` file: Lists changes between Ganeti versions.
- :ref:`search`: Allows you to search for key terms across Ganeti documentation.
16 17 18 19

Installing Ganeti
+++++++++++++++++

20
Use the following resources to install and/or upgrade Ganeti:
21

22 23
- :doc:`install`: Comprehensive instructions for installing Ganeti.
- :doc:`install-quick`: A shortened installation guide for the experienced Ganeti user.
24
- :doc:`upgrade`: Instructions for upgrading an existing Ganeti installation to the latest version.
25 26 27 28

Using Ganeti
++++++++++++

29
The following resources provide guidance on how to use Ganeti:
30

31 32
- :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).
- :doc:`walkthrough`: An example-oriented guide to Ganeti.
33 34
- :doc:`manpages`: Descriptions of the various tools that are part of Ganeti.
- :doc:`security`: A description of the security model underlying a Ganeti cluster.
35 36 37 38 39
- :doc:`hooks`: Information on hooking scripts, which extend Ganeti functionalities by automatically activating when certain events occur.
- :doc:`iallocator`: Description of the API for external tools, which can allocate instances either manually or automatically.
- :doc:`rapi`: Description of the Ganeti remote API, which allows programmatic access to most of the functionalities of Ganeti.
- :doc:`ovfconverter`: Description of a tool that provides compatibility with the standard OVF virtual machine interchange format.
- :doc:`virtual-cluster`: Explanation of how to use virtual cluster support, which is utilized mainly for testing reasons.
40

41 42
Some features are explicitly targeted for large Ganeti installations,
in which multiple clusters are present:
43

44 45
- :doc:`cluster-merge`: Describes a tool for merging two existing clusters.
- :doc:`move-instance`: Describes how to move instances between clusters.
46 47 48 49

Developing Ganeti
+++++++++++++++++

50 51
There are a few documents particularly useful for developers who want
to modify Ganeti:
52

53
- :doc:`locking`: Describes Ganeti's locking strategy and lock order dependencies.
54
- :doc:`devnotes`: Details build dependencies and other useful development-related information.
55 56 57 58


Implemented designs
-------------------
59

60 61 62
Before actual implementation, all Ganeti features are described in a
design document. Designs fall into two categories: released versions
and draft versions (which are either incomplete or not implemented).
63

64
.. toctree::
65
   :maxdepth: 1
66 67

   design-2.0.rst
68
   design-2.1.rst
69
   design-2.2.rst
70
   design-2.3.rst
71
   design-htools-2.3.rst
72
   design-2.4.rst
73
   design-2.5.rst
74
   design-2.6.rst
75
   design-2.7.rst
76
   design-2.8.rst
77
   design-2.9.rst
78
   design-2.10.rst
79
   design-2.11.rst
80
   design-2.12.rst
81
   design-2.13.rst
Klaus Aehlig's avatar
Klaus Aehlig committed
82
   design-2.14.rst
Helga Velroyen's avatar
Helga Velroyen committed
83
   design-2.15.rst
84 85 86 87 88 89

Draft designs
-------------
.. toctree::
   :maxdepth: 2

90
   design-draft.rst
91

92 93 94
.. toctree::
   :hidden:

95 96
   admin.rst
   cluster-merge.rst
97
   cluster-keys-replacement.rst
Helga Velroyen's avatar
Helga Velroyen committed
98
   design-allocation-efficiency.rst
99
   design-autorepair.rst
100
   design-bulk-create.rst
101
   design-chained-jobs.rst
102
   design-cmdlib-unittests.rst
103
   design-cpu-speed.rst
104
   design-cpu-pinning.rst
Helga Velroyen's avatar
Helga Velroyen committed
105
   design-dedicated-allocation.rst
106
   design-device-uuid-name.rst
107
   design-daemons.rst
108
   design-disk-conversion.rst
109
   design-disks.rst
110
   design-file-based-storage.rst
111
   design-file-based-disks-ownership.rst
112
   design-hroller.rst
113
   design-hsqueeze.rst
114
   design-hotplug.rst
115
   design-internal-shutdown.rst
116
   design-kvmd.rst
117
   design-linuxha.rst
118
   design-lu-generated-jobs.rst
119
   design-monitoring-agent.rst
120
   design-move-instance-improvements.rst
121
   design-multi-reloc.rst
122
   design-multi-version-tests.rst
123
   design-network.rst
124
   design-node-add.rst
125
   design-node-security.rst
126
   design-oob.rst
127
   design-openvswitch.rst
128
   design-opportunistic-locking.rst
129
   design-optables.rst
130
   design-os.rst
131
   design-ovf-support.rst
132
   design-partitioned
133
   design-performance-tests.rst
134
   design-query2.rst
135
   design-query-splitting.rst
136
   design-reason-trail.rst
137
   design-restricted-commands.rst
138
   design-shared-storage.rst
139
   design-ssh-ports.rst
140
   design-storagetypes.rst
141
   design-systemd.rst
142
   design-upgrade.rst
143
   design-virtual-clusters.rst
144
   devnotes.rst
145
   dev-codestyle.rst
146 147 148 149 150 151 152
   glossary.rst
   hooks.rst
   iallocator.rst
   install.rst
   install-quick.rst
   locking.rst
   manpages.rst
153
   monitoring-query-format.rst
154 155 156 157 158 159 160 161
   move-instance.rst
   news.rst
   ovfconverter.rst
   rapi.rst
   security.rst
   upgrade.rst
   virtual-cluster.rst
   walkthrough
162 163

.. vim: set textwidth=72 :