### Navigation

- next
- Ganeti 2.8.0~rc3 documentation »

# Welcome to Ganeti’s documentation!

This page is the starting point for browsing the ganeti documentation. It contains link to all the sections of the documentation, grouped by topic.

The list of changes between Ganeti versions is provided in the News file.

In order to help understanding the Ganeti terminology, a Glossary is provided.

Also see the Search Page.

## Installing Ganeti

In order to install Ganeti, follow the instructions contained in the Ganeti installation tutorial.

If you are an experienced user, the content of the Ganeti quick installation guide should be enough.

Instructions for upgrading an existing installation to the latest version of Ganeti are contained in the Upgrade notes.

## Using Ganeti

Information about how to manage a Ganeti cluster after it has been installed (including management of nodes, instances, info about the tools and the monitoring agent) can be found in Ganeti administrator’s guide.

A more example-oriended guide is available in Ganeti walk-through.

The various tool that are part of Ganeti are described one by one in the Man pages.

A description of the security model underlying a Ganeti cluster can be found in the Security in Ganeti document.

Ganeti functionalities can be extended by hooking scripts automatically activated when certain events happen. Information on this mechanism is provided in the Ganeti customisation using hooks document.

While using Ganeti, the allocation of instances can happen manually or automatically, through some external tools making decisions about this. The API for such tools is described in Ganeti automatic instance allocation.

Most of the functionalities of Ganeti can be programmatically accessed through an API, the Ganeti remote API.

Compatibility with the standard OVF virtual machine interchange format is provided by the OVF converter.

Mainly for testing reasons, Ganeti also has Virtual cluster support.

A few functionalities are explicitly targeted for big installations, where multiple clusters are present. A tool for merging two existing clusters is provided, and is described in Merging clusters. There is also a document describing the procedure for Moving instances between clusters.

## Developing Ganeti

A few documents useful for who wants to modify Ganeti are available and listed in this section.

A description of the locking strategy and, in particular, lock order dependencies is presented in Ganeti locking.

Build dependencies and other useful development-related information are provided in the Developer notes.

All the features implemented in Ganeti are described in a design document before being actually implemented. Designs can be implemented in a released version, or be still draft (and therefore either incomplete or not implemented).

### Implemented designs

- Ganeti 2.0 design
- Ganeti 2.1 design
- Ganeti 2.2 design
- Ganeti 2.3 design
- Synchronising htools to Ganeti 2.3
- Ganeti 2.4 design
- Ganeti 2.5 design
- Ganeti 2.6 design
- Ganeti 2.7 design
- Ganeti 2.8 design

### Draft designs

- Design document drafts
  - Design for a X509 Certificate Authority
  - Design for replacing Ganeti’s HTTP server
  - Design for import/export version 2
  - Resource model changes
  - Splitting the query and job execution paths
  - Partitioned Ganeti
  - Ganeti monitoring agent
  - HRoller tool
  - Management of storage types and disk templates, incl. storage space reporting

### Navigation

- next
- Ganeti 2.8.0~rc3 documentation »