Documentation

Basic Install

Use this doc to get a basic installation of Velero. Refer this document to customize your installation.

Prerequisites

  • Access to a Kubernetes cluster, v1.10 or later, with DNS and container networking enabled.
  • kubectl installed locally

Velero uses object storage to store backups and associated artifacts. It also optionally integrates with supported block storage systems to snapshot your persistent volumes. Before beginning the installation process, you should identify the object storage provider and optional block storage provider(s) you'll be using from the list of compatible providers.

There are supported storage providers for both cloud-provider environments and on-premises environments. For more details on on-premises scenarios, see the on-premises documentation.

Install the CLI

Option 1: macOS - Homebrew

On macOS, you can use Homebrew to install the velero client:

brew install velero

Option 2: GitHub release

  1. Download the latest release's tarball for your client platform.
  2. Extract the tarball:
   tar -xvf <RELEASE-TARBALL-NAME>.tar.gz
  1. Move the extracted velero binary to somewhere in your $PATH (e.g. /usr/local/bin for most users).

Install and configure the server components

There are two supported methods for installing the Velero server components:

Velero uses storage provider plugins to integrate with a variety of storage systems to support backup and snapshot operations. The steps to install and configure the Velero server components along with the appropriate plugins are specific to your chosen storage provider. To find installation instructions for your chosen storage provider, follow the documentation link for your provider at our supported storage providers page

Note: if your object storage provider is different than your volume snapshot provider, follow the installation instructions for your object storage provider first, then return here and follow the instructions to add your volume snapshot provider.

Command line Autocompletion

Please refer to this part of the documentation.

Getting Started

To help you get started, see the documentation.