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
这是什么？Velero（原名 Heptio Ark）是一款开源工具，用于备份和恢复 Kubernetes 应用：它保护你的集群资源和持久化存储卷，让你在数据丢失后能够恢复。
它是在本地运行的命令行工具，还是部署在我集群里的东西？两者都是——它是客户端加服务端的工具。服务端运行在你的 Kubernetes 集群内部，命令行客户端则在本地电脑上运行。
怎么把它跑起来？先在本地安装 CLI，再把服务端组件部署到你的集群里。文档网站上有入门指南——记得用版本选择器，让文档内容和你的 Velero 版本保持一致。
使用之前需要准备什么？需要一个现有的 Kubernetes 集群供你保护，另外电脑上要有 Velero CLI。公有云平台上的集群和本地自建集群都可以用。
把我的集群交给它之前，有什么要注意的坑吗？维护者无法测试每一种 Velero 和 Kubernetes 的版本组合，所以 README 建议你在安装或升级之前，先自己测试一下你这套具体搭配。
Velero 是成熟项目，还是实验性的东西？它很成熟：2017 年左右就有了（原名 Heptio Ark），GitHub 上大约有 10300 颗星，而且是云原生计算基金会（CNCF）的沙箱项目，社区会议每两周一次，时间安排交替照顾北京时间以及美国和欧洲时区。
它只备份配置清单，还是连我的数据也一起备份？两者都覆盖——它既保护集群资源，也保护持久化存储卷，所以带磁盘数据的有状态工作负载也在保护范围内，不只是 Kubernetes 对象定义。
在不同版本之间升级 Velero 安全吗？升级路径是经过明确测试的：每次发布时，维护者都会验证由前两个次版本（n-2）创建的备份能否用新版本成功恢复。
What are similar projects?litestream, thanos, containerd, rook, distribution, kubernetes, kind, cert-manager
Which topics is it in?cncf, storage, backup, containers, cloud-native, kubernetes, cloud, hacktoberfest, devops, go, tool, apache-2.0
Creator
velero-io
Size
63.1 MB
Stars
10.3K
Updated
CommitOct 17Releasev1.18.4Sep 28
Age
9y
Commits · 90 Days