# Welcome to Ganeti’s documentation!

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

A few quick references:

- Glossary: Provides explanations of basic Ganeti terminology.

- News file: Lists changes between Ganeti versions.

- Search Page: Allows you to search for key terms across Ganeti documentation.

## Installing Ganeti

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

- Ganeti installation tutorial: Comprehensive instructions for installing Ganeti.

- Upgrade notes: Instructions for upgrading an existing Ganeti installation to the latest version.

## Using Ganeti

The following resources provide guidance on how to use Ganeti:

- Ganeti administrator’s guide: 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).

- Man pages: Descriptions of the various tools that are part of Ganeti.

- Security in Ganeti: A description of the security model underlying a Ganeti cluster.

- Ganeti customisation using hooks: Information on hooking scripts, which extend Ganeti functionalities by automatically activating when certain events occur.

- Ganeti remote API: Description of the Ganeti remote API, which allows programmatic access to most of the functionalities of Ganeti.

- OVF converter: Description of a tool that provides compatibility with the standard OVF virtual machine interchange format.

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

- Merging clusters: Describes a tool for merging two existing clusters.

- Moving instances between clusters: Describes how to move instances between clusters.

## Developing Ganeti

There are a few documents particularly useful for developers who want to modify or extend Ganeti:

- Ganeti locking: Describes Ganeti’s locking strategy and lock order dependencies.

- Ganeti automatic instance allocation: Description of the API for external tools, which can allocate instances either manually or automatically.

- Virtual cluster support: Explanation of how to use virtual cluster support, which is utilized mainly for testing reasons.

### Implemented designs

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).

- 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
- Ganeti 2.9 design
- Ganeti 2.10 design
- Ganeti 2.11 design
- Ganeti 2.12 design
- Ganeti 2.13 design
- Ganeti 2.14 design
- Ganeti 2.15 design
- Ganeti 2.16 design
- Ganeti 3.0 design
- Ganeti 3.1 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
  - Huge Pages Support for Ganeti
  - Design for adding ifdown script to KVM
  - Instance Reservations
  - DRBD Sync Rate Throttling
  - Network Management (revised)
  - HTools support for multiple storage units per node
  - Ganeti Maintenance Daemon
  - KVM + SCSI
  - Disks