vmware-tanzu / velero

Backup and migrate Kubernetes applications and their persistent volumes
https://velero.io
Apache License 2.0
8.57k stars 1.39k forks source link

add the limitation of velero in documentation #5042

Open euclidsun opened 2 years ago

euclidsun commented 2 years ago

Describe the problem/challenge you have [A description of the current limitation/problem/challenge that you are experiencing.] it is common asked questions that if velero has any limitations, including use cases, resources type, workload type, etc.

Describe the solution you'd like [A clear and concise description of what you want to happen.] Add one section in the velero documentation to list these limitations. for example:

Anything else you would like to add: [Miscellaneous information that will assist in solving the issue.]

Environment:

Vote on this issue!

This is an invitation to the Velero community to vote on issues, you can see the project's top voted issues listed here.
Use the "reaction smiley face" up to the right of this comment to vote.

euclidsun commented 2 years ago

Many users are using Velero as the generic BR solution for k8s, and expecting it could just work as charming. However, the reality is, k8s could be very complicated in many ways, there are some B/R use cases could not be supported well by velero today.

current we have some doc describe the limitations, for example: https://velero.io/docs/v1.9/restic/#limitations

but it is only for restic, there are some common cases which are identified velero BR procedure could not support, thus we'd better to have documentation to list those scenarios.

Proposal: Add one "Limitation" document under the "Troubleshoot" section.

We could category the known limitation as below:

For each item, we could add something like:

for example, for this one https://github.com/vmware-tanzu/velero/issues/1929, we could add below: