Substitutions of YAML / JSON values through configmap/ RestoreItemAction

[anshulahuja98]

Describe the problem/challenge you have
[A description of the current limitation/problem/challenge that you are experiencing.]

Generic way to subsitute YAML/ JSON properties of the workloads before restoring.

There are a lot of scenarios where customers wish to change certain properties in the YAMLs before restoration, for example removing any cloud specific properties (hardcoded disk encryption key references, VNET references), change the image URLs, change the StorageClass of the PVCs being restored, changing Disk drivers when migrating across clouds, changing other cloud specific properties.

As of today the solutions for each specific problem are being developed as different plugins and using different configmaps, it is very hard from user POV to handle them.

Describe the solution you'd like
[A clear and concise description of what you want to happen.]

Goal is to solve all these problems in a generic way through RestoreItemAction which can substitute all these various properties based on a configmap reference input.

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

Currently there are similar issues and solutions which are solving specific problems.

• considering the local image repositories changes when migrating from cluster A to B considering the local image repositories changes when migrating from cluster A to B #5519
• Storage Class mapping plugin

Examples: Deployment.spec.containers[0].image could be the json path.
Or replacing values which match a certain regex. Similarly for StorageClasses, we can change cloud specific SKUs.

Pending: will add more examples.

Environment:

• Velero version (use velero version):
• Kubernetes version (use kubectl version):
• Kubernetes installer & version:
• Cloud provider or hardware configuration:
• OS (e.g. from /etc/os-release):

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.

• 👍 for "The project would be better with this feature added"
• 👎 for "This feature will not enhance the project in a meaningful way"

[sseago]

This would be a useful plugin addition for allowing custom user transformations. I don't think it should replace any of the standard supported actions (i.e. storageclass change, etc.) since those are generally-useful actions that are supported directly by velero already. But this would allow for individual users to perform transformations that are useful in their own particular environments that wouldn't necessarily be useful for other velero users in other contexts.

[anshulahuja98]

The intention is not to immediately deprecate any existing standard supported actions. But in future if any "standard" actions come as a feature ask, we solve them in a generic way. Documenting usual scenarios using this generic feature will be a goal of this feature.

[reasonerjt]

I'll double check the design and this is VERY LIKELY to be included in v1.12