Skip to content

feat: add velero plugin configuration schema and validation #3169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Nov 12, 2025
Merged

feat: add velero plugin configuration schema and validation #3169

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d3986cc
feat: add Velero plugin configuration schema and validation
banjoh Nov 7, 2025
43ac598
Additional unit tests for image format validation
banjoh Nov 7, 2025
18cdd40
Add container name to Velero plugin configuration
banjoh Nov 7, 2025
4f59d2a
Use oras-go to validate image format
banjoh Nov 10, 2025
697e1e0
Better test name
banjoh Nov 10, 2025
344c049
Fix failing tests
banjoh Nov 11, 2025
11ad835
Remove unsupported example from config_types.go
banjoh Nov 11, 2025
e7a6b8d
Merge remote-tracking branch 'origin/main' into evansmungai/sc-131045…
banjoh Nov 12, 2025
241fc9e
Remove unnecessary comments
banjoh Nov 12, 2025
7f73213
Additional comment to explain to copilot
banjoh Nov 12, 2025
6f62453
Use ReferenceRegexp to validate image format
banjoh Nov 12, 2025
d079c0f
Fix failing unit test
banjoh Nov 12, 2025
b385ae3
Fix lint errors
banjoh Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion kinds/apis/v1beta1/config_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,35 @@ type Helm struct {
}

type Extensions struct {
Helm *Helm `json:"helm,omitempty"`
Helm *Helm `json:"helm,omitempty"`
Velero VeleroExtensions `json:"velero,omitempty"`
}

// VeleroExtensions contains Velero-specific extension settings
type VeleroExtensions struct {
// Plugins is a list of custom Velero plugins to be added as initContainers
// +kubebuilder:validation:Optional
Plugins []VeleroPlugin `json:"plugins,omitempty"`
}

// VeleroPlugin defines a custom Velero plugin to be added to the Velero deployment
type VeleroPlugin struct {
// Name is the container name for the plugin initContainer
// This name will be used as the initContainer name in the Velero deployment
// +kubebuilder:validation:Required
Name string `json:"name"`
// Image is the OCI image reference for the plugin container
// Examples:
// - "myvendor/velero-postgresql:v1.0.0" (explicit registry)
// - "velero-plugin-postgres:v1.0.0" (will use proxy registry)
// +kubebuilder:validation:Required
Image string `json:"image"`
// ImagePullPolicy is the image pull policy for the plugin container.
// Valid values are: Always, IfNotPresent, Never
// If not specified, defaults to IfNotPresent
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Enum=Always;IfNotPresent;Never
ImagePullPolicy string `json:"imagePullPolicy,omitempty"`
}

type Domains struct {
Expand Down
36 changes: 36 additions & 0 deletions kinds/apis/v1beta1/zz_generated.deepcopy.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

78 changes: 78 additions & 0 deletions operator/charts/embedded-cluster-operator/charts/crds/templates/resources.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,45 @@ spec:
type: object
type: array
type: object
velero:
description: VeleroExtensions contains Velero-specific extension
settings
properties:
plugins:
description: Plugins is a list of custom Velero plugins to
be added as initContainers
items:
description: VeleroPlugin defines a custom Velero plugin
to be added to the Velero deployment
properties:
image:
description: |-
Image is the OCI image reference for the plugin container
Examples:
- "myvendor/velero-postgresql:v1.0.0" (explicit registry)
- "velero-plugin-postgres:v1.0.0" (will use proxy registry)
type: string
imagePullPolicy:
description: |-
ImagePullPolicy is the image pull policy for the plugin container.
Valid values are: Always, IfNotPresent, Never
If not specified, defaults to IfNotPresent
enum:
- Always
- IfNotPresent
- Never
type: string
name:
description: |-
Name is the container name for the plugin initContainer
This name will be used as the initContainer name in the Velero deployment
type: string
required:
- image
- name
type: object
type: array
type: object
type: object
metadataOverrideUrl:
type: string
Expand Down Expand Up @@ -451,6 +490,45 @@ spec:
type: object
type: array
type: object
velero:
description: VeleroExtensions contains Velero-specific extension
settings
properties:
plugins:
description: Plugins is a list of custom Velero plugins
to be added as initContainers
items:
description: VeleroPlugin defines a custom Velero plugin
to be added to the Velero deployment
properties:
image:
description: |-
Image is the OCI image reference for the plugin container
Examples:
- "myvendor/velero-postgresql:v1.0.0" (explicit registry)
- "velero-plugin-postgres:v1.0.0" (will use proxy registry)
type: string
imagePullPolicy:
description: |-
ImagePullPolicy is the image pull policy for the plugin container.
Valid values are: Always, IfNotPresent, Never
If not specified, defaults to IfNotPresent
enum:
- Always
- IfNotPresent
- Never
type: string
name:
description: |-
Name is the container name for the plugin initContainer
This name will be used as the initContainer name in the Velero deployment
type: string
required:
- image
- name
type: object
type: array
type: object
type: object
metadataOverrideUrl:
type: string
Expand Down
39 changes: 39 additions & 0 deletions operator/config/crd/bases/embeddedcluster.replicated.com_configs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,45 @@ spec:
type: object
type: array
type: object
velero:
description: VeleroExtensions contains Velero-specific extension
settings
properties:
plugins:
description: Plugins is a list of custom Velero plugins to
be added as initContainers
items:
description: VeleroPlugin defines a custom Velero plugin
to be added to the Velero deployment
properties:
image:
description: |-
Image is the OCI image reference for the plugin container
Examples:
- "myvendor/velero-postgresql:v1.0.0" (explicit registry)
- "velero-plugin-postgres:v1.0.0" (will use proxy registry)
type: string
imagePullPolicy:
description: |-
ImagePullPolicy is the image pull policy for the plugin container.
Valid values are: Always, IfNotPresent, Never
If not specified, defaults to IfNotPresent
enum:
- Always
- IfNotPresent
- Never
type: string
name:
description: |-
Name is the container name for the plugin initContainer
This name will be used as the initContainer name in the Velero deployment
type: string
required:
- image
- name
type: object
type: array
type: object
type: object
metadataOverrideUrl:
type: string
Expand Down
39 changes: 39 additions & 0 deletions operator/config/crd/bases/embeddedcluster.replicated.com_installations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,45 @@ spec:
type: object
type: array
type: object
velero:
description: VeleroExtensions contains Velero-specific extension
settings
properties:
plugins:
description: Plugins is a list of custom Velero plugins
to be added as initContainers
items:
description: VeleroPlugin defines a custom Velero plugin
to be added to the Velero deployment
properties:
image:
description: |-
Image is the OCI image reference for the plugin container
Examples:
- "myvendor/velero-postgresql:v1.0.0" (explicit registry)
- "velero-plugin-postgres:v1.0.0" (will use proxy registry)
type: string
imagePullPolicy:
description: |-
ImagePullPolicy is the image pull policy for the plugin container.
Valid values are: Always, IfNotPresent, Never
If not specified, defaults to IfNotPresent
enum:
- Always
- IfNotPresent
- Never
type: string
name:
description: |-
Name is the container name for the plugin initContainer
This name will be used as the initContainer name in the Velero deployment
type: string
required:
- image
- name
type: object
type: array
type: object
type: object
metadataOverrideUrl:
type: string
Expand Down
39 changes: 39 additions & 0 deletions operator/config/crd/bases/embeddedcluster.replicated.com_kubernetesinstallations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,45 @@ spec:
type: object
type: array
type: object
velero:
description: VeleroExtensions contains Velero-specific extension
settings
properties:
plugins:
description: Plugins is a list of custom Velero plugins
to be added as initContainers
items:
description: VeleroPlugin defines a custom Velero plugin
to be added to the Velero deployment
properties:
image:
description: |-
Image is the OCI image reference for the plugin container
Examples:
- "myvendor/velero-postgresql:v1.0.0" (explicit registry)
- "velero-plugin-postgres:v1.0.0" (will use proxy registry)
type: string
imagePullPolicy:
description: |-
ImagePullPolicy is the image pull policy for the plugin container.
Valid values are: Always, IfNotPresent, Never
If not specified, defaults to IfNotPresent
enum:
- Always
- IfNotPresent
- Never
type: string
name:
description: |-
Name is the container name for the plugin initContainer
This name will be used as the initContainer name in the Velero deployment
type: string
required:
- image
- name
type: object
type: array
type: object
type: object
metadataOverrideUrl:
type: string
Expand Down
37 changes: 37 additions & 0 deletions operator/schemas/config-embeddedcluster-v1beta1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,43 @@
}
}
}
},
"velero": {
"description": "VeleroExtensions contains Velero-specific extension settings",
"type": "object",
"properties": {
"plugins": {
"description": "Plugins is a list of custom Velero plugins to be added as initContainers",
"type": "array",
"items": {
"description": "VeleroPlugin defines a custom Velero plugin to be added to the Velero deployment",
"type": "object",
"required": [
"image",
"name"
],
"properties": {
"image": {
"description": "Image is the OCI image reference for the plugin container\nExamples:\n - \"myvendor/velero-postgresql:v1.0.0\" (explicit registry)\n - \"velero-plugin-postgres:v1.0.0\" (will use proxy registry)",
"type": "string"
},
"imagePullPolicy": {
"description": "ImagePullPolicy is the image pull policy for the plugin container.\nValid values are: Always, IfNotPresent, Never\nIf not specified, defaults to IfNotPresent",
"type": "string",
"enum": [
"Always",
"IfNotPresent",
"Never"
]
},
"name": {
"description": "Name is the container name for the plugin initContainer\nThis name will be used as the initContainer name in the Velero deployment",
"type": "string"
}
}
}
}
}
}
}
},
Expand Down
Loading
Loading