mirror of
https://github.com/vmware-tanzu/velero.git
synced 2026-02-12 06:41:37 +00:00
35d2cc0890
- Add --server-priority-class-name and --node-agent-priority-class-name flags to velero install command - Configure data mover pods (PVB/PVR/DataUpload/DataDownload) to use priority class from node-agent-configmap - Configure maintenance jobs to use priority class from repo-maintenance-job-configmap (global config only) - Add priority class validation with ValidatePriorityClass and GetDataMoverPriorityClassName utilities - Update e2e tests to include PriorityClass testing utilities - Move priority class design document to Implemented folder - Add comprehensive unit tests for all priority class implementations - Update documentation for priority class configuration - Add changelog entry for #8883 Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> remove unused test utils Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> feat: add unit test for getting priority class name in maintenance jobs Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> doc update Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> feat: add priority class validation for repository maintenance jobs - Add ValidatePriorityClassWithClient function to validate priority class existence - Integrate validation in maintenance.go when creating maintenance jobs - Update tests to cover the new validation functionality - Return boolean from ValidatePriorityClass to allow fallback behavior This ensures maintenance jobs don't fail due to non-existent priority classes, following the same pattern used for data mover pods. Addresses feedback from: https://github.com/vmware-tanzu/velero/pull/8883#discussion_r2238681442 Refs #8869 Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> refactor: clean up priority class handling for data mover pods - Fix comment in node_agent.go to clarify PriorityClassName is only for data mover pods - Simplify server.go to use dataPathConfigs.PriorityClassName directly - Remove redundant priority class logging from controllers as it's already logged during server startup - Keep logging centralized in the node-agent server initialization This reduces code duplication and clarifies the scope of priority class configuration. 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> refactor: remove GetDataMoverPriorityClassName from kube utilities Remove GetDataMoverPriorityClassName function and its tests as priority class is now read directly from dataPathConfigs instead of parsing from ConfigMap. This simplifies the codebase by eliminating the need for indirect ConfigMap parsing. Refs #8869 🤖 Generated with [Claude Code](https://claude.ai/code) Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> refactor: remove priority class validation from install command Remove priority class validation during install as it's redundant since validation already occurs during server startup. Users cannot see console logs during install, making the validation warnings ineffective at this stage. The validation remains in place during server and node-agent startup where it's more appropriate and visible to users. Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com> Co-Authored-By: Claude <noreply@anthropic.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 does not officially support Windows. In testing, the Velero team was able to backup stateless Windows applications only. The File System Backup and backups of stateful applications or PersistentVolumes were not supported.
|
|
|
|
If you want to perform your own testing of Velero on Windows, you must deploy Velero as a Windows container. Velero does not provide official Windows images, but its possible for you to build your own Velero Windows container image to use. Note that you must build this image on a Windows node.
|
|
|
|
## 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
|