velero README

The project's README from github.com/velero-io/velero. As one markdown file: README.md.

100

Build Status CII Best Practices OpenSSF Scorecard GitHub release (latest SemVer) GitHub stars Docker Pulls

Overview

Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. You can run Velero with a public cloud platform or on-premises.

Velero lets you:

Velero consists of:

Documentation

The documentation provides a getting started guide and information about building from source, architecture, extending Velero and more.

Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of Velero.

Troubleshooting

If you encounter issues, review the troubleshooting docs, file an issue, or talk to us on the #velero-users and #velero-dev channel on the Kubernetes Slack server.

Community

Velero is an open community and we welcome your participation. The best way to get involved is to join our bi-weekly community meetings:

See the community page for the full schedule and details.

Contributing

If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our Start contributing documentation for guidance on how to setup Velero for development.

Governance

Velero's governance describes how the project is run, including the decision-making process, the roles and responsibilities of maintainers, and how to become a maintainer. Governance applies across the Velero org and is maintained at velero-io/.github.

Changelog

See the list of releases to find out about feature changes.

Velero compatibility matrix

The following is a list of the supported Kubernetes versions for each Velero version.

Velero version Expected Kubernetes version compatibility Tested on Kubernetes version
1.18 1.18-latest 1.33.7, 1.34.1, and 1.35.0
1.17 1.18-latest 1.31.7, 1.32.3, 1.33.1, and 1.34.0
1.16 1.18-latest 1.31.4, 1.32.3, and 1.33.0
1.15 1.18-latest 1.28.8, 1.29.8, 1.30.4 and 1.31.1
1.14 1.18-latest 1.27.9, 1.28.9, and 1.29.4

Velero supports IPv4, IPv6, and dual stack environments. Support for this was tested against Velero v1.8.

The Velero maintainers are continuously working to expand testing coverage, but are not able to test every combination of Velero and supported Kubernetes versions for each Velero release. The table above is meant to track the current testing coverage and the expected supported Kubernetes versions for each Velero version.

If you are interested in using a different version of Kubernetes with a given Velero version, we'd recommend that you perform testing before installing or upgrading your environment. For full information around capabilities within a release, also see the Velero release notes or Kubernetes release notes. See the Velero support page for information about supported versions of Velero.

For each release, Velero maintainers run the test to ensure the upgrade path from n-2 minor release. For example, before the release of v1.10.x, the test will verify that the backup created by v1.9.x and v1.8.x can be restored using the build to be tagged as v1.10.x.

Cloud Native Computing Foundation

Velero is a Cloud Native Computing Foundation sandbox project.

Cloud Native Computing Foundation logo

Copyright Contributors to Velero, established as Velero a Series of LF Projects, LLC. For website terms of use, trademark policy and other project policies please see https://lfprojects.org/policies/.

velero (velero-io/velero)

Searching Database…

10.3K ·GitHub
Velero
What is this?Velero (formerly Heptio Ark) is an open-source tool for backing up and restoring Kubernetes applications: it protects your cluster resources and persistent volumes so you can recover after loss.
Is this a CLI I run locally, or something that lives in my cluster?Both — it is a client-server tool. A server runs inside your Kubernetes cluster, and a command-line client runs locally on your machine.
How do I get it running?Install the CLI locally and deploy the server component into your cluster. The docs site has a getting started guide — use the version selector so the docs match your Velero version.
What do I need to have in place before using it?An existing Kubernetes cluster to protect, plus the Velero CLI on your machine. It works against clusters on public cloud platforms or on-premises.
Any pitfalls before I trust it with my cluster?The maintainers cannot test every Velero/Kubernetes combination, so the README recommends testing your specific pairing yourself before installing or upgrading.
Is Velero a mature project or something experimental?It is mature: around since 2017 (formerly Heptio Ark), roughly 10,300 GitHub stars, and it is a Cloud Native Computing Foundation sandbox project with bi-weekly community meetings alternating between Beijing-friendly and US/Europe-friendly time zones.
Does it back up only manifests, or my data too?Both — it covers cluster resources and persistent volumes, so stateful workloads with on-disk data are protected, not just the Kubernetes object definitions.
Is upgrading Velero between versions safe?Upgrade paths are explicitly tested: for each release, maintainers verify that backups created by the previous two minor releases (n-2) can be restored with the new build.
What are similar projects?litestream, thanos, containerd, rook, distribution, kubernetes, kind, cert-manager
Which topics is it in?cncf, storage, backup, containers, cloud-native, kubernetes, cloud, hacktoberfest, devops, go, tool, apache-2.0
Creator
velero-io
Size
63.1 MB
Stars
10.3K
Updated
CommitOct 16Releasev1.18.4Sep 28
Age
9y
Commits · 90 Days