feat: add velero plugin configuration schema and validation #3169

banjoh · 2025-11-06T14:31:43Z

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:

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: ghcr.io/banjoh/velero-plugin-cnpg-restore:latest
          imagePullPolicy: Always # Optional: defaults to IfNotPresent

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?

github-actions · 2025-11-06T14:50:50Z

This PR has been released (on staging) and is available for download with a embedded-cluster-smoke-test-staging-app license ID.

Online Installer:

curl "https://staging.replicated.app/embedded/embedded-cluster-smoke-test-staging-app/ci/appver-dev-b385ae3" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Airgap Installer (may take a few minutes before the airgap bundle is built):

curl "https://staging.replicated.app/embedded/embedded-cluster-smoke-test-staging-app/ci-airgap/appver-dev-b385ae3?airgap=true" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Happy debugging!

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]>

pkg/lint/validator.go

Signed-off-by: Evans Mungai <[email protected]>

pkg/lint/validator.go

Signed-off-by: Evans Mungai <[email protected]>

sgalsaleh · 2025-11-07T18:45:19Z

pkg/lint/validator.go

+	return errors
+}
+
+// validateImageFormat validates that an image string follows a valid OCI image reference format


is there a standard regex used by tools like docker that we can just use instead of reimplementing this from scratch?

There is. I changed this implementation to use oras library for that

is the comment below about basic validation irrelevant / inaccurate now then?

It is. I removed it

Signed-off-by: Evans Mungai <[email protected]>

kinds/apis/v1beta1/config_types.go

Signed-off-by: Evans Mungai <[email protected]>

pkg/lint/validator.go

Signed-off-by: Evans Mungai <[email protected]>

…/add-ec-config-to-add-velero-plugins

Signed-off-by: Evans Mungai <[email protected]>

cursor · 2025-11-12T16:22:39Z

pkg/lint/validator_test.go

+			expectError: true,
+			errorCount:  1,
+			errorFields: []string{"extensions.velero.plugins[0].image"},
+			errorMsgs:   []string{"invalid repository"},


Bug: Image Validation Returns Unexpected Error Message

The test expects error message to contain "invalid repository" but validateImageFormat returns "invalid image reference". This causes the test assertion at line 670 to fail since the actual error message won't match the expected substring.

Signed-off-by: Evans Mungai <[email protected]>

pkg/lint/validator.go

Signed-off-by: Evans Mungai <[email protected]>

* feat: add Velero plugin configuration schema and validation 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]> * Additional unit tests for image format validation Signed-off-by: Evans Mungai <[email protected]> * Add container name to Velero plugin configuration Signed-off-by: Evans Mungai <[email protected]> * Use oras-go to validate image format Signed-off-by: Evans Mungai <[email protected]> * Better test name Signed-off-by: Evans Mungai <[email protected]> * Fix failing tests Signed-off-by: Evans Mungai <[email protected]> * Remove unsupported example from config_types.go Signed-off-by: Evans Mungai <[email protected]> * Remove unnecessary comments Signed-off-by: Evans Mungai <[email protected]> * Additional comment to explain to copilot Signed-off-by: Evans Mungai <[email protected]> * Use ReferenceRegexp to validate image format Signed-off-by: Evans Mungai <[email protected]> * Fix failing unit test Signed-off-by: Evans Mungai <[email protected]> * Fix lint errors Signed-off-by: Evans Mungai <[email protected]> --------- Signed-off-by: Evans Mungai <[email protected]>

banjoh added the type::feature label Nov 6, 2025

banjoh marked this pull request as draft November 6, 2025 14:33

banjoh force-pushed the evansmungai/sc-131045/add-ec-config-to-add-velero-plugins branch from ccb27c9 to 0db3432 Compare November 6, 2025 14:35

banjoh changed the title ~~feat: add Velero plugin configuration schema and validation~~ feat: add velero plugin configuration schema and validation Nov 7, 2025

banjoh marked this pull request as ready for review November 7, 2025 15:36

banjoh force-pushed the evansmungai/sc-131045/add-ec-config-to-add-velero-plugins branch from 7a3670b to d3986cc Compare November 7, 2025 15:43

cursor bot reviewed Nov 7, 2025

View reviewed changes

pkg/lint/validator.go Show resolved Hide resolved

Additional unit tests for image format validation

43ac598

Signed-off-by: Evans Mungai <[email protected]>

cursor bot reviewed Nov 7, 2025

View reviewed changes

pkg/lint/validator.go Show resolved Hide resolved

Add container name to Velero plugin configuration

18cdd40

Signed-off-by: Evans Mungai <[email protected]>

sgalsaleh reviewed Nov 7, 2025

View reviewed changes

Use oras-go to validate image format

4f59d2a

Signed-off-by: Evans Mungai <[email protected]>

cursor bot reviewed Nov 10, 2025

View reviewed changes

kinds/apis/v1beta1/config_types.go Outdated Show resolved Hide resolved

Better test name

697e1e0

Signed-off-by: Evans Mungai <[email protected]>

cursor bot reviewed Nov 10, 2025

View reviewed changes

pkg/lint/validator.go Show resolved Hide resolved

banjoh added 6 commits November 11, 2025 14:55

Fix failing tests

344c049

Signed-off-by: Evans Mungai <[email protected]>

Remove unsupported example from config_types.go

11ad835

Signed-off-by: Evans Mungai <[email protected]>

Merge remote-tracking branch 'origin/main' into evansmungai/sc-131045…

e7a6b8d

…/add-ec-config-to-add-velero-plugins

Remove unnecessary comments

241fc9e

Signed-off-by: Evans Mungai <[email protected]>

Additional comment to explain to copilot

7f73213

Signed-off-by: Evans Mungai <[email protected]>

Use ReferenceRegexp to validate image format

6f62453

Signed-off-by: Evans Mungai <[email protected]>

cursor bot reviewed Nov 12, 2025

View reviewed changes

Fix failing unit test

d079c0f

Signed-off-by: Evans Mungai <[email protected]>

cursor bot reviewed Nov 12, 2025

View reviewed changes

pkg/lint/validator.go Show resolved Hide resolved

Fix lint errors

b385ae3

Signed-off-by: Evans Mungai <[email protected]>

sgalsaleh approved these changes Nov 12, 2025

View reviewed changes

banjoh merged commit c02ebf9 into main Nov 12, 2025
53 checks passed

banjoh deleted the evansmungai/sc-131045/add-ec-config-to-add-velero-plugins branch November 12, 2025 22:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add velero plugin configuration schema and validation #3169

feat: add velero plugin configuration schema and validation #3169

Uh oh!

banjoh commented Nov 6, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Nov 6, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

sgalsaleh Nov 7, 2025

Uh oh!

banjoh Nov 10, 2025

Uh oh!

sgalsaleh Nov 11, 2025

Uh oh!

banjoh Nov 12, 2025

Uh oh!

Uh oh!

Uh oh!

cursor bot Nov 12, 2025

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add velero plugin configuration schema and validation #3169

feat: add velero plugin configuration schema and validation #3169

Uh oh!

Conversation

banjoh commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Which issue(s) this PR fixes:

Does this PR require a test?

Does this PR require a release note?

Does this PR require documentation?

Uh oh!

github-actions bot commented Nov 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sgalsaleh Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

banjoh Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

sgalsaleh Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

banjoh Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cursor bot Nov 12, 2025

Choose a reason for hiding this comment

Bug: Image Validation Returns Unexpected Error Message

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

banjoh commented Nov 6, 2025 •

edited

Loading

github-actions bot commented Nov 6, 2025 •

edited

Loading