feat: add support for custom Velero plugins via EC config #3177

banjoh · 2025-11-07T18:20:24Z

What this PR does / why we need it:

Add ability to configure custom Velero plugins through the Embedded Cluster
config specification. Plugins are injected as initContainers into the Velero
deployment.

Changes:

Add VeleroPlugin type to ConfigSpec.Extensions.Velero with required Name
and Image fields, and optional ImagePullPolicy
Implement plugin injection in Velero addon's GenerateHelmValues to read
plugins from EmbeddedConfigSpec and append as initContainers
Add validation for Velero plugins (duplicate names/images, image format)
Fix validateImageFormat to correctly distinguish registry ports from image
tags (e.g., registry.io:5000/repo/image:tag)
Add EmbeddedConfigSpec field to Velero struct to pass config during
installation/upgrade/restore
Add comprehensive unit tests for plugin injection scenarios
Update CRD schemas and generated deepcopy methods

The implementation only uses plugins from EmbeddedConfigSpec, following the
existing pattern where EndUserConfigSpec is only used for overrides via
addOnOverrides mechanism.

Example configuration:

  extensions:
    velero:
      plugins:
        - name: velero-plugin-postgresql
          image: myvendor/velero-postgresql:v1.0.0
          imagePullPolicy: Always

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

Which issue(s) this PR fixes:

sc-131045

Does this PR require a test?

Does this PR require a release note?

Does this PR require documentation?

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

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

Ref: sc-131045 Add ability to configure custom Velero plugins through the Embedded Cluster config specification. Plugins are injected as initContainers into the Velero deployment. Changes: - Add VeleroPlugin type to ConfigSpec.Extensions.Velero with required Name and Image fields, and optional ImagePullPolicy - Implement plugin injection in Velero addon's GenerateHelmValues to read plugins from EmbeddedConfigSpec and append as initContainers - Add validation for Velero plugins (duplicate names/images, image format) - Fix validateImageFormat to correctly distinguish registry ports from image tags (e.g., registry.io:5000/repo/image:tag) - Add EmbeddedConfigSpec field to Velero struct to pass config during installation/upgrade/restore - Add comprehensive unit tests for plugin injection scenarios - Update CRD schemas and generated deepcopy methods The implementation only uses plugins from EmbeddedConfigSpec, following the existing pattern where EndUserConfigSpec is only used for overrides via addOnOverrides mechanism. Example configuration: extensions: velero: plugins: - name: velero-plugin-postgresql image: myvendor/velero-postgresql:v1.0.0 imagePullPolicy: Always Signed-off-by: Evans Mungai <[email protected]>

github-actions · 2025-11-07T18:35:55Z

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-af3f231" -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-af3f231?airgap=true" -H "Authorization: $EC_SMOKE_TEST_LICENSE_ID" -o embedded-cluster-smoke-test-staging-app-ci.tgz

Happy debugging!

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

sgalsaleh · 2025-11-11T16:16:37Z

pkg/addons/velero/values.go

 	}

+	// Inject custom Velero plugins from ConfigSpec before any further processing
+	if err := v.injectPluginInitContainers(hv, domains); err != nil {


why not call this inside helmValues() function above?

sgalsaleh · 2025-11-11T16:22:57Z

pkg/lint/validator.go

 }
+
+// validateVeleroPlugins validates Velero plugin configurations
+func (v *Validator) validateVeleroPlugins(veleroExt ecv1beta1.VeleroExtensions) []error {


hmm, this seems like something that should exist in the new EC lint code rather than / in addition to here.

sgalsaleh · 2025-11-11T16:28:07Z

pkg/lint/validator.go

+		return fmt.Errorf("image cannot be empty")
+	}
+
+	// Basic validation: image should not contain invalid characters


why not just use the ReferenceRegexp regex from https://pkg.go.dev/github.com/distribution/reference?

sgalsaleh

Can you please add 3 dryrun tests for:

V2 installs
V3 headless installs
V3 non-headless installs?

For V2 dryrun install tests, the code is at: https://github.com/replicatedhq/embedded-cluster/blob/main/tests/dryrun/install_test.go

For V3 dryrun install tests, the code is at: https://github.com/replicatedhq/embedded-cluster/blob/main/tests/dryrun/v3_install_test.go

You can follow the existing pattern. You'll need to create a custom EC config for these tests that include custom velero plugins in the EC config and only use it for these 3 tests, and verify that the velero helm values are generated correctly.

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

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

Ref: sc-131045 Add ability to configure custom Velero plugins through the Embedded Cluster config specification. Plugins are injected as initContainers into the Velero deployment. Changes: - Add VeleroPlugin type to ConfigSpec.Extensions.Velero with required Name and Image fields, and optional ImagePullPolicy - Implement plugin injection in Velero addon's GenerateHelmValues to read plugins from EmbeddedConfigSpec and append as initContainers - Add validation for Velero plugins (duplicate names/images, image format) - Fix validateImageFormat to correctly distinguish registry ports from image tags (e.g., registry.io:5000/repo/image:tag) - Add EmbeddedConfigSpec field to Velero struct to pass config during installation/upgrade/restore - Add comprehensive unit tests for plugin injection scenarios - Update CRD schemas and generated deepcopy methods The implementation only uses plugins from EmbeddedConfigSpec, following the existing pattern where EndUserConfigSpec is only used for overrides via addOnOverrides mechanism. Example configuration: extensions: velero: plugins: - name: velero-plugin-postgresql image: myvendor/velero-postgresql:v1.0.0 imagePullPolicy: Always Signed-off-by: Evans Mungai <[email protected]>

…values' of github.com:replicatedhq/embedded-cluster into evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values

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

Ref: sc-131045 Add ability to configure custom Velero plugins through the Embedded Cluster config specification. Plugins are injected as initContainers into the Velero deployment. Changes: - Add VeleroPlugin type to ConfigSpec.Extensions.Velero with required Name and Image fields, and optional ImagePullPolicy - Implement plugin injection in Velero addon's GenerateHelmValues to read plugins from EmbeddedConfigSpec and append as initContainers - Add validation for Velero plugins (duplicate names/images, image format) - Fix validateImageFormat to correctly distinguish registry ports from image tags (e.g., registry.io:5000/repo/image:tag) - Add EmbeddedConfigSpec field to Velero struct to pass config during installation/upgrade/restore - Add comprehensive unit tests for plugin injection scenarios - Update CRD schemas and generated deepcopy methods The implementation only uses plugins from EmbeddedConfigSpec, following the existing pattern where EndUserConfigSpec is only used for overrides via addOnOverrides mechanism. Example configuration: extensions: velero: plugins: - name: velero-plugin-postgresql image: myvendor/velero-postgresql:v1.0.0 imagePullPolicy: Always Signed-off-by: Evans Mungai <[email protected]>

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

…values' of github.com:replicatedhq/embedded-cluster into evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values

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

…ns' into evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values

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

…/add-inject-velero-plugin-to-helm-values

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

…-nodomains.yaml Signed-off-by: Evans Mungai <[email protected]>

banjoh · 2025-11-13T15:19:28Z

Can you please add 3 dryrun tests for:

V2 installs

V3 headless installs

V3 non-headless installs?

For V2 dryrun install tests, the code is at: https://github.com/replicatedhq/embedded-cluster/blob/main/tests/dryrun/install_test.go

For V3 dryrun install tests, the code is at: https://github.com/replicatedhq/embedded-cluster/blob/main/tests/dryrun/v3_install_test.go

You can follow the existing pattern. You'll need to create a custom EC config for these tests that include custom velero plugins in the EC config and only use it for these 3 tests, and verify that the velero helm values are generated correctly.

Done

sgalsaleh · 2025-11-13T15:24:39Z

pkg/addons/velero/values_test.go

+	require.NotEmpty(t, values["initContainers"])
+	initContainers := values["initContainers"].([]any)
+
+	// Find our plugin container


how about asserting the number of plugins is at most 2 same as the test above? same for the tests below

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

pkg/addons/velero/values_test.go

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

banjoh added 4 commits November 7, 2025 15:40

Additional unit tests for image format validation

43ac598

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

Add container name to Velero plugin configuration

18cdd40

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

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

banjoh marked this pull request as draft November 7, 2025 18:20

banjoh mentioned this pull request Nov 7, 2025

feat: add velero plugin configuration schema and validation #3169

Merged

Use oras-go to validate image format

4f59d2a

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

banjoh force-pushed the evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values branch from be277fe to e40e253 Compare November 10, 2025 15:21

banjoh added 3 commits November 10, 2025 15:24

Better test name

697e1e0

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

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

sgalsaleh reviewed Nov 11, 2025

View reviewed changes

banjoh added 13 commits November 12, 2025 11:32

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

Merge branch 'evansmungai/sc-131045/add-inject-velero-plugin-to-helm-…

4988b54

…values' of github.com:replicatedhq/embedded-cluster into evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values

Show velero chart values in EC metadata subcommand output

6eecff1

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

Do not process image names

e995653

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

Add velero plugins to allEC config

cfa0ea1

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

Use ReferenceRegexp to validate image format

6f62453

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

Show velero chart values in EC metadata subcommand output

a22af11

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

Do not process image names

6380e99

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

Add velero plugins to allEC config

83e3729

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

banjoh added 14 commits November 12, 2025 16:21

Merge branch 'evansmungai/sc-131045/add-inject-velero-plugin-to-helm-…

dc6ed98

…values' of github.com:replicatedhq/embedded-cluster into evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values

Fix failing unit test

d079c0f

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

Fix lint errors

b385ae3

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

Merge branch 'evansmungai/sc-131045/add-ec-config-to-add-velero-plugi…

47a2a75

…ns' into evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values

Add dry run tests for velero plugin feature

9777103

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

Use separate cluster config for velero plugin test

c375455

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

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

cc589e2

…/add-inject-velero-plugin-to-helm-values

Fix test and rename plugin

dd4a0dd

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

Remove Velero plugin configuration from test configs

2c3b53f

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

Reinstate change accidentally removed in previous commit

86d7e7d

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

Remove unnecessary changes

d42d0e9

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

Some more cleanup

0985f8a

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

Remove unecessarry change

3d51c8e

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

Remove unnecessary change and add builtInExtensions to cluster-config…

3db5fd6

…-nodomains.yaml Signed-off-by: Evans Mungai <[email protected]>

banjoh marked this pull request as ready for review November 13, 2025 15:17

sgalsaleh reviewed Nov 13, 2025

View reviewed changes

sgalsaleh previously approved these changes Nov 13, 2025

View reviewed changes

Refactor dry run tests

7a2c52f

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

banjoh dismissed sgalsaleh’s stale review via 7a2c52f November 13, 2025 15:48

sgalsaleh previously approved these changes Nov 13, 2025

View reviewed changes

cursor bot reviewed Nov 13, 2025

View reviewed changes

pkg/addons/velero/values_test.go Outdated Show resolved Hide resolved

pkg/addons/velero/values_test.go Outdated Show resolved Hide resolved

pkg/addons/velero/values_test.go Outdated Show resolved Hide resolved

Fix failing tests

af3f231

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

banjoh dismissed sgalsaleh’s stale review via af3f231 November 13, 2025 17:11

sgalsaleh approved these changes Nov 13, 2025

View reviewed changes

banjoh merged commit 6bcf33a into main Nov 14, 2025
142 of 146 checks passed

banjoh deleted the evansmungai/sc-131045/add-inject-velero-plugin-to-helm-values branch November 14, 2025 06:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add support for custom Velero plugins via EC config #3177

feat: add support for custom Velero plugins via EC config #3177

Uh oh!

banjoh commented Nov 7, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Nov 7, 2025 •

edited

Loading

Uh oh!

sgalsaleh Nov 11, 2025

Uh oh!

sgalsaleh Nov 11, 2025

Uh oh!

sgalsaleh Nov 11, 2025

Uh oh!

sgalsaleh left a comment

Uh oh!

banjoh commented Nov 13, 2025

Uh oh!

sgalsaleh Nov 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add support for custom Velero plugins via EC config #3177

feat: add support for custom Velero plugins via EC config #3177

Uh oh!

Conversation

banjoh commented Nov 7, 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 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sgalsaleh Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

sgalsaleh Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

sgalsaleh Nov 11, 2025

Choose a reason for hiding this comment

Uh oh!

sgalsaleh left a comment

Choose a reason for hiding this comment

Uh oh!

banjoh commented Nov 13, 2025

Uh oh!

sgalsaleh Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

banjoh commented Nov 7, 2025 •

edited

Loading

github-actions bot commented Nov 7, 2025 •

edited

Loading