mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-04-21 00:00:33 +00:00
f388a5ce51
Some checks failed
Run the E2E test on kind / get-go-version (push) Failing after 1m7s
Run the E2E test on kind / build (push) Has been skipped
Run the E2E test on kind / setup-test-matrix (push) Successful in 4s
Run the E2E test on kind / run-e2e-test (push) Has been skipped
Main CI / get-go-version (push) Successful in 13s
Main CI / Build (push) Failing after 1m1s
Close stale issues and PRs / stale (push) Successful in 13s
Trivy Nightly Scan / Trivy nightly scan (velero, main) (push) Failing after 1m31s
Trivy Nightly Scan / Trivy nightly scan (velero-plugin-for-aws, main) (push) Failing after 1m20s
Trivy Nightly Scan / Trivy nightly scan (velero-plugin-for-gcp, main) (push) Failing after 1m17s
Trivy Nightly Scan / Trivy nightly scan (velero-plugin-for-microsoft-azure, main) (push) Failing after 1m5s
Signed-off-by: Lyndon-Li <lyonghui@vmware.com>
74 lines
3.5 KiB
Markdown
74 lines
3.5 KiB
Markdown
---
|
|
title: "Basic Install"
|
|
layout: docs
|
|
---
|
|
|
|
Use this doc to get a basic installation of Velero.
|
|
Refer [this document](customize-installation.md) to customize your installation, including setting priority classes for Velero components.
|
|
|
|
## Prerequisites
|
|
|
|
- Access to a Kubernetes cluster, v1.16 or later, with DNS and container networking enabled. For more information on supported Kubernetes versions, see the Velero [compatibility matrix](https://github.com/vmware-tanzu/velero#velero-compatibility-matrix).
|
|
- `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][0].
|
|
|
|
Velero supports storage providers for both cloud-provider environments and on-premises environments. For more details on on-premises scenarios, see the [on-premises documentation][2].
|
|
|
|
### Velero on Windows
|
|
|
|
Velero supports to backup and restore Windows workloads, either stateless or stateful.
|
|
Velero node-agent and data mover pods could run in Windows nodes. To keep compatibility to the existing Velero plugins, Velero server runs in linux nodes only, so Velero requires at least one linux node in the cluster. Velero provides Windows images for specific Windows versions. For more information see [Backup Restore Windows Workloads][6].
|
|
|
|
## Install the CLI
|
|
|
|
### Option 1: MacOS - Homebrew
|
|
|
|
On macOS, you can use [Homebrew](https://brew.sh) to install the `velero` client:
|
|
|
|
```bash
|
|
brew install velero
|
|
```
|
|
|
|
### Option 2: GitHub release
|
|
|
|
1. Download the [latest release][1]'s tarball for your client platform.
|
|
1. Extract the tarball:
|
|
|
|
```bash
|
|
tar -xvf <RELEASE-TARBALL-NAME>.tar.gz
|
|
```
|
|
|
|
1. Move the extracted `velero` binary to somewhere in your `$PATH` (`/usr/local/bin` for most users).
|
|
|
|
### Option 3: Windows - Chocolatey
|
|
|
|
On Windows, you can use [Chocolatey](https://chocolatey.org/install) to install the [velero](https://chocolatey.org/packages/velero) client:
|
|
|
|
```powershell
|
|
choco install velero
|
|
```
|
|
|
|
## Install and configure the server components
|
|
|
|
There are two supported methods for installing the Velero server components:
|
|
|
|
- the `velero install` CLI command
|
|
- the [Helm chart](https://vmware-tanzu.github.io/helm-charts/)
|
|
|
|
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][0] 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][4]._
|
|
|
|
## Command line Autocompletion
|
|
|
|
Please refer to [this part of the documentation][5].
|
|
|
|
[0]: supported-providers.md
|
|
[1]: https://github.com/vmware-tanzu/velero/releases/latest
|
|
[2]: on-premises.md
|
|
[3]: overview-plugins.md
|
|
[4]: customize-installation.md#install-an-additional-volume-snapshot-provider
|
|
[5]: customize-installation.md#optional-velero-cli-configurations
|
|
[6]: backup-restore-windows.md
|