README
¶
Overview
Velero (formerly Heptio Ark) gives you tools to back up and restore your Kubernetes cluster resources and persistent volumes. 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
You can run Velero in clusters on a cloud provider or on-premises. For detailed information, see Compatible Storage Providers.
Installation
We strongly recommend that you use an official release of Velero. The tarballs for each release contain the
velero command-line client. Follow the installation instructions to get started.
The code and sample YAML files in the master branch of the Velero repository are under active development and are not guaranteed to be stable. Use them at your own risk!
More information
The documentation provides a getting started guide, plus 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
Thanks for taking the time to join our community and start contributing!
Feedback and discussion are available on the mailing list.
Before you start
- Please familiarize yourself with the Code of Conduct before contributing.
- See CONTRIBUTING.md for instructions on the developer certificate of origin that we require.
- Read how we're using ZenHub for project and roadmap planning
Pull requests
- We welcome pull requests. Feel free to dig through the issues and jump in.
Changelog
See the list of releases to find out about feature changes.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
hack
|
|
|
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. |
|
cloudprovider/mocks
Code generated by mockery v1.0.0.
|
Code generated by mockery v1.0.0. |
|
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. |
|
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. |
|
third_party
|
|