velero/site/docs/v1.0.0
Steve Kriss 8336d95f57 tweak use case bullets in readme for clarity (#1692)
Signed-off-by: Steve Kriss <krisss@vmware.com>
2019-07-23 10:13:05 -07:00
..
api-types add 1.0 docs 2019-05-19 13:41:47 -06:00
img add 1.0 docs 2019-05-19 13:41:47 -06:00
README.md tweak use case bullets in readme for clarity (#1692) 2019-07-23 10:13:05 -07:00
about.md add 1.0 docs 2019-05-19 13:41:47 -06:00
aws-config.md omit storageClassName in nginx example to use default StorageClass (#1669) 2019-07-16 11:15:35 -06:00
azure-config.md docs: remove custom password option from azure service principle create command 2019-07-16 15:13:27 -07:00
build-from-source.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
debugging-install.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
debugging-restores.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
disaster-case.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
extend.md add 1.0 docs 2019-05-19 13:41:47 -06:00
faq.md add 1.0 docs 2019-05-19 13:41:47 -06:00
gcp-config.md omit storageClassName in nginx example to use default StorageClass (#1669) 2019-07-16 11:15:35 -06:00
get-started.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
hooks.md fix link for hooks example 2019-07-11 12:25:16 -06:00
ibm-config.md omit storageClassName in nginx example to use default StorageClass (#1669) 2019-07-16 11:15:35 -06:00
image-tagging.md add 1.0 docs 2019-05-19 13:41:47 -06:00
install-overview.md Document Helm secrets format. (#1665) 2019-07-17 14:03:31 -07:00
locations.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
migrating-to-velero.md add 1.0 docs 2019-05-19 13:41:47 -06:00
migration-case.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
namespace.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
oracle-config.md document Oracle Cloud Storage as a backup provider (#1570) 2019-06-21 10:29:58 -06:00
output-file-format.md add 1.0 docs 2019-05-19 13:41:47 -06:00
plugins.md document the ConfigMap convention for plugins (#1670) 2019-07-16 14:21:40 -07:00
rbac.md add 1.0 docs 2019-05-19 13:41:47 -06:00
restic.md Add restic instructions for Enterprise PKS (#1579) 2019-06-14 15:35:44 -07:00
support-matrix.md document Oracle Cloud Storage as a backup provider (#1570) 2019-06-21 10:29:58 -06:00
troubleshooting.md add 1.0 docs 2019-05-19 13:41:47 -06:00
upgrade-to-1.0.md Docs updates - extra finishing touches (#1516) 2019-05-28 12:42:27 -04:00
vendoring-dependencies.md add 1.0 docs 2019-05-19 13:41:47 -06:00
zenhub.md add 1.0 docs 2019-05-19 13:41:47 -06:00

README.md

100

Build Status

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

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.