README
¶
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:
- Take backups of your cluster and restore in case of loss.
- Migrate cluster resources to other clusters.
- Replicate your production cluster to development and testing clusters.
Velero consists of:
- A server that runs on your cluster
- A command-line client that runs locally
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 channel on the Kubernetes Slack server.
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.
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.9 | 1.16-latest | 1.20.5, 1.21.2, 1.22.5, 1.23, and 1.24 |
| 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 |
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 have a question about test coverage before v1.9, please reach out in the #velero-users Slack channel.
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
config
|
|
|
crd/v1/crds
Package crds embeds the controller-tools generated CRD manifests
|
Package crds embeds the controller-tools generated CRD manifests |
|
hack
|
|
|
internal
|
|
|
util/managercontroller
TODO(2.0) After converting all controllers to runtime-controller, the functions in this file will no longer be needed and should be removed.
|
TODO(2.0) After converting all controllers to runtime-controller, the functions in this file will no longer be needed and should be removed. |
|
pkg
|
|
|
apis/velero/v1
Package v1 is the v1 version of the API.
|
Package v1 is the v1 version of the API. |
|
buildinfo
Package buildinfo holds build-time information like the velero version.
|
Package buildinfo holds build-time information like the velero version. |
|
generated/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
generated/clientset/versioned/typed/velero/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
generated/clientset/versioned/typed/velero/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
install
Package install provides public functions for easily creating and installing resources necessary for Velero to operate.
|
Package install provides public functions for easily creating and installing resources necessary for Velero to operate. |
|
persistence/mocks
Code generated by mockery v1.0.0.
|
Code generated by mockery v1.0.0. |
|
plugin/clientmgmt
Package clientmgmt contains the plugin client for Velero.
|
Package clientmgmt contains the plugin client for Velero. |
|
plugin/framework
Package framework is the common package that any plugin client will need to import, for example, both plugin authors and Velero core.
|
Package framework is the common package that any plugin client will need to import, for example, both plugin authors and Velero core. |
|
plugin/generated
Package generated is a generated protocol buffer package.
|
Package generated is a generated protocol buffer package. |
|
plugin/velero
Package velero contains the interfaces necessary to implement all of the Velero plugins.
|
Package velero contains the interfaces necessary to implement all of the Velero plugins. |
|
test
|
|
|
third_party
|
|