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.
On macOS, you can use Homebrew to install the
brew install velero
tar -xvf <RELEASE-TARBALL-NAME>.tar.gz
velerobinary to somewhere in your
/usr/local/binfor most users).
There are two supported methods for installing the Velero server components:
velero installCLI command
To install and configure the Velero server components, follow the provider-specific instructions documented by your storage provider.
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.
During install, Velero requires that at least one plugin is added (with the
--plugins flag). Please see the documentation under Plugins
Velero is installed in the
velero namespace by default. However, you can install Velero in any namespace. See run in custom namespace for details.
velero install expects a credentials file for your
velero IAM account to be provided via the
If you are using an alternate identity mechanism, such as kube2iam/kiam on AWS, Workload Identity on GKE, etc., that does not require a credentials file, you can specify the
--no-secret flag instead of
velero install does not install Velero's restic integration. To enable it, specify the
If you've already run
velero install without the
--use-restic flag, you can run the same command again, including the
--use-restic flag, to add the restic integration to your existing install.
By default, the Velero deployment requests 500m CPU, 128Mi memory and sets a limit of 1000m CPU, 256Mi. Default requests and limits are not set for the restic pods as CPU/Memory usage can depend heavily on the size of volumes being backed up.
If you need to customize these resource requests and limits, you can set the following flags in your
velero install command:
velero install \ --provider <YOUR_PROVIDER> \ --bucket <YOUR_BUCKET> \ --secret-file <PATH_TO_FILE> \ --velero-pod-cpu-request <CPU_REQUEST> \ --velero-pod-mem-request <MEMORY_REQUEST> \ --velero-pod-cpu-limit <CPU_LIMIT> \ --velero-pod-mem-limit <MEMORY_LIMIT> \ [--use-restic] \ [--restic-pod-cpu-request <CPU_REQUEST>] \ [--restic-pod-mem-request <MEMORY_REQUEST>] \ [--restic-pod-cpu-limit <CPU_LIMIT>] \ [--restic-pod-mem-limit <MEMORY_LIMIT>]
Values for these flags follow the same format as Kubernetes resource requirements.
Velero supports any number of backup storage locations and volume snapshot locations. For more details, see about locations.
velero install only supports configuring at most one backup storage location and one volume snapshot location.
To configure additional locations after running
velero install, use the
velero backup-location create and/or
velero snapshot-location create commands along with provider-specific configuration. Use the
--help flag on each of these commands for more details.
If you need to install Velero without a default backup storage location (without specifying
--no-default-backup-location flag is required for confirmation.
Velero supports using different providers for volume snapshots than for object storage -- for example, you can use AWS S3 for object storage, and Portworx for block volume snapshots.
velero install only supports configuring a single matching provider for both object storage and volume snapshots.
To use a different volume snapshot provider:
Install the Velero server components by following the instructions for your object storage provider
Add your volume snapshot provider's plugin to Velero (look in your provider's documentation for the image name):
velero plugin add <registry/image:version>
Add a volume snapshot location for your provider, following your provider's documentation for configuration:
velero snapshot-location create <NAME> \ --provider <PROVIDER-NAME> \ [--config <PROVIDER-CONFIG>]
velero install generates and applies a customized set of Kubernetes configuration (YAML) to your cluster.
To generate the YAML without applying it to your cluster, use the
--dry-run -o yaml flags.
This is useful for applying bespoke customizations, integrating with a GitOps workflow, etc.
velero install --help or see the Helm chart documentation for the full set of installation options.