feat: add velero plugin configuration schema and validation #3169
Conversation
banjoh
force-pushed
the
evansmungai/sc-131045/add-ec-config-to-add-velero-plugins
branch
from
ccb27c9 to
0db3432
Compare
|
This PR has been released (on staging) and is available for download with a embedded-cluster-smoke-test-staging-app license ID. Online Installer: Airgap Installer (may take a few minutes before the airgap bundle is built): Happy debugging! |
banjoh
changed the title
Add support for configuring custom Velero plugins in the Embedded Cluster
Config CRD. This is the first PR in a series to enable vendors to extend
EC's disaster recovery capabilities with specialized backup plugins.
Changes:
- Add VeleroExtensions and VeleroPlugin types to ConfigSpec.Extensions
- Regenerate CRD schema to include velero.plugins field with validation
- Implement plugin validation in lint validator:
- Validate image format (OCI reference format)
- Detect duplicate plugin images
- Check for required fields
- Add unit tests for validation logic
The new configuration structure allows vendors to specify custom Velero
plugins as OCI images that will be injected as initContainers into the
Velero deployment. Image references support both explicit registry paths
and short names that will use EC's proxy registry.
Example configuration:
extensions:
velero:
plugins:
- image: myvendor/velero-plugin:v1.0.0
This sets the foundation for PR 2 which will implement the Helm values
generation to actually inject these plugins into the Velero deployment.
Refs: SC-131045
Signed-off-by: Evans Mungai <[email protected]>
banjoh
force-pushed
the
evansmungai/sc-131045/add-ec-config-to-add-velero-plugins
branch
from
7a3670b to
d3986cc
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Signed-off-by: Evans Mungai <[email protected]>
Signed-off-by: Evans Mungai <[email protected]>
| return errors | ||
| } | ||
|
|
||
| // validateImageFormat validates that an image string follows a valid OCI image reference format |
There was a problem hiding this comment.
is there a standard regex used by tools like docker that we can just use instead of reimplementing this from scratch?
There was a problem hiding this comment.
There is. I changed this implementation to use oras library for that
There was a problem hiding this comment.
is the comment below about basic validation irrelevant / inaccurate now then?
Signed-off-by: Evans Mungai <[email protected]>
Signed-off-by: Evans Mungai <[email protected]>
| } | ||
|
|
||
| return nil | ||
| } |
There was a problem hiding this comment.
Bug: Image Validation Fails Documented Short Names
The validateImageFormat function rejects short image names like velero-plugin-postgres:v1.0.0, but the documentation in config_types.go and CRD schemas explicitly states these formats are valid and will use the proxy registry. The registry.ParseReference call requires at least a repository component (e.g., repo/image), making it incompatible with the documented support for short names. This creates a mismatch where users following the documented examples will encounter validation errors.
Signed-off-by: Evans Mungai <[email protected]>
Signed-off-by: Evans Mungai <[email protected]>
What this PR does / why we need it:
Add support for configuring custom Velero plugins in the Embedded Cluster Config CRD. This is the first PR in a series to enable vendors to extend EC's disaster recovery capabilities with specialized backup plugins.
Changes:
The new configuration structure allows vendors to specify custom Velero plugins as OCI images that will be injected as initContainers into the Velero deployment. Image references support both explicit registry paths and short names that will use EC's proxy registry.
Example configuration:
This sets the foundation for #3177 which will implement the Helm values generation to actually inject these plugins into the Velero deployment.
Which issue(s) this PR fixes:
Ref: sc-131045
Does this PR require a test?
Does this PR require a release note?
Does this PR require documentation?