2019-02-28 20:33:15 +00:00
![100]
2017-08-02 17:27:17 +00:00
2020-08-31 21:33:03 +00:00
[![Build Status][1]][2] [](https://bestpractices.coreinfrastructure.org/projects/3811)
2017-08-02 17:27:17 +00:00
## Overview
2020-05-26 19:56:05 +00:00
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:
2017-08-02 17:27:17 +00:00
2018-02-14 18:02:35 +00:00
* Take backups of your cluster and restore in case of loss.
2019-07-23 17:13:05 +00:00
* Migrate cluster resources to other clusters.
* Replicate your production cluster to development and testing clusters.
2017-08-02 17:27:17 +00:00
2019-01-25 03:33:07 +00:00
Velero consists of:
2017-08-02 17:27:17 +00:00
2018-02-14 18:02:35 +00:00
* A server that runs on your cluster
* A command-line client that runs locally
2017-08-02 17:27:17 +00:00
2019-10-02 20:24:42 +00:00
## Documentation
2018-02-21 18:18:34 +00:00
2019-11-14 15:58:47 +00:00
[The documentation][29] provides a getting started guide and information about building from source, architecture, extending Velero, and more.
2019-02-22 19:18:17 +00:00
Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of Velero.
2017-08-02 17:27:17 +00:00
## Troubleshooting
2019-02-05 15:48:16 +00:00
If you encounter issues, review the [troubleshooting docs][30], [file an issue][4], or talk to us on the [#velero channel][25] on the Kubernetes Slack server.
2017-08-02 17:27:17 +00:00
## Contributing
2020-02-13 17:46:58 +00:00
If you are ready to jump in and test, add code, or help with documentation, follow the instructions on our [Start contributing][31] documentation for guidance on how to setup Velero for development.
2017-08-02 17:27:17 +00:00
## Changelog
See [the list of releases][6] to find out about feature changes.
2022-01-06 19:21:32 +00:00
### Velero compatibility matrix
The following is a list of the supported Kubernetes versions for each Velero version.
| Velero version | Kubernetes versions|
|----------------|--------------------|
| 1.8 | 1.16-latest |
| 1.6.3-1.7.1 | 1.12-latest |
| 1.60-1.6.2 | 1.12-1.21 |
| 1.5 | 1.12-1.21 |
| 1.4 | 1.10-1.21 |
2020-08-03 18:53:49 +00:00
[1]: https://github.com/vmware-tanzu/velero/workflows/Main%20CI/badge.svg
[2]: https://github.com/vmware-tanzu/velero/actions?query=workflow%3A"Main+CI"
2019-09-30 21:26:56 +00:00
[4]: https://github.com/vmware-tanzu/velero/issues
[6]: https://github.com/vmware-tanzu/velero/releases
2017-08-02 17:27:17 +00:00
[9]: https://kubernetes.io/docs/setup/
[10]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-with-homebrew-on-macos
[11]: https://kubernetes.io/docs/tasks/tools/install-kubectl/#tabset-1
[12]: https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md
[14]: https://github.com/kubernetes/kubernetes
2019-01-25 03:33:07 +00:00
[24]: https://groups.google.com/forum/#!forum/projectvelero
[25]: https://kubernetes.slack.com/messages/velero
2019-06-19 16:20:56 +00:00
[29]: https://velero.io/docs/
[30]: https://velero.io/docs/troubleshooting
2020-02-13 17:46:58 +00:00
[31]: https://velero.io/docs/start-contributing
2020-08-18 18:06:16 +00:00
[100]: https://velero.io/docs/main/img/velero.png
