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 (ранее Heptio Ark) — инструмент с открытым исходным кодом для резервного копирования и восстановления приложений в Kubernetes: он защищает ресурсы кластера и постоянные тома (persistent volumes), чтобы вы могли восстановиться после потери данных.
Это утилита, которую я запускаю локально, или то, что живёт в моём кластере?И то и другое — это клиент-серверный инструмент. Сервер работает внутри вашего Kubernetes-кластера, а консольный клиент — локально на вашем компьютере.
Как его запустить?Установите CLI локально и разверните серверную часть в своём кластере. На сайте документации есть руководство по началу работы — воспользуйтесь селектором версий, чтобы документация соответствовала вашей версии Velero.
Что должно быть под рукой, прежде чем им пользоваться?Уже существующий Kubernetes-кластер, который вы хотите защитить, плюс Velero CLI на вашем компьютере. Он работает с кластерами как в публичных облаках, так и на собственных серверах (on-premises).
Есть ли подводные камни, прежде чем доверить ему свой кластер?Разработчики не могут протестировать все сочетания Velero и Kubernetes, поэтому в README рекомендуется самостоятельно проверить свою конкретную связку перед установкой или обновлением.
Velero — это зрелый проект или что-то экспериментальное?Проект зрелый: существует с 2017 года (ранее Heptio Ark), у него около 10 300 звёзд на GitHub, и это sandbox-проект Cloud Native Computing Foundation с собраниями сообщества раз в две недели, которые чередуются между временем, удобным для Пекина, и временем, удобным для США и Европы.
Он бэкапит только манифесты или мои данные тоже?И то и другое — он охватывает ресурсы кластера и постоянные тома, поэтому защищены stateful-нагрузки с данными на диске, а не только определения объектов Kubernetes.
Безопасно ли обновлять Velero между версиями?Сценарии обновления тестируются явно: для каждого релиза разработчики проверяют, что бэкапы, созданные двумя предыдущими минорными релизами (n-2), можно восстановить новой версией.
Creator
velero-io
Size
63.1 MB
Stars
10.3K
Age
9y
Commits · 90 Days