Skip to content

feat: config overrides for structured config files #1177

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

Open
dervoeti wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat: config overrides for structured config files #1177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4d18a9a
feat: config overrides for structured config files
dervoeti Mar 17, 2026
b3a92e7
chore: regenerate CRD preview
dervoeti Mar 18, 2026
e10c6db
chore: apply nightly rustfmt formatting
dervoeti Mar 19, 2026
68f5837
fix: addressed first round of review feedback
dervoeti Mar 19, 2026
a839d7e
refactor!: remove HashMap default for ConfigOverrides type parameter
dervoeti Mar 20, 2026
48ac144
refactor: rename ProductSpecificCommonConfig type parameter to Common…
dervoeti Mar 23, 2026
0c5ac02
fix: use matches! assertions to verify specific error variants in tests
dervoeti Mar 23, 2026
4b84601
refactor: rename T and U type parameters to Config and RoleConfig
dervoeti Mar 26, 2026
b19c190
fix: apply rustfmt formatting
dervoeti Mar 26, 2026
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
153 changes: 143 additions & 10 deletions crates/stackable-operator/crds/DummyCluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,59 @@ spec:
and `stopped` will take no effect until `reconciliationPaused` is set to false or removed.
type: boolean
type: object
configOverrides:
default: {}
description: |-
Typed config override strategies for Dummy config files.

Demonstrates both JSON-formatted (`config.json`) and key-value-formatted
(`dummy.properties`) config file overrides.
properties:
config.json:
description: Overrides for the `config.json` file.
nullable: true
oneOf:
- required:
- jsonMergePatch
- required:
- jsonPatches
- required:
- userProvided
properties:
jsonMergePatch:
description: |-
Can be set to arbitrary YAML content, which is converted to JSON and used as
[RFC 7396](https://datatracker.ietf.org/doc/html/rfc7396) JSON merge patch.
type: object
x-kubernetes-preserve-unknown-fields: true
jsonPatches:
description: |-
List of [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patches.

Can be used when more flexibility is needed, e.g. to only modify elements
in a list based on a condition.

A patch looks something like

`{"op": "test", "path": "/0/name", "value": "Andrew"}`

or

`{"op": "add", "path": "/0/happy", "value": true}`
items:
type: string
type: array
userProvided:
description: Override the entire config file with the specified String.
type: string
type: object
dummy.properties:
additionalProperties:
type: string
description: Overrides for the `dummy.properties` file.
nullable: true
type: object
type: object
domainName:
description: A validated domain name type conforming to RFC 1123, so e.g. not an IP address
type: string
Expand Down Expand Up @@ -713,17 +766,57 @@ spec:
type: object
type: object
configOverrides:
additionalProperties:
additionalProperties:
type: string
type: object
default: {}
description: |-
The `configOverrides` can be used to configure properties in product config files
that are not exposed in the CRD. Read the
[config overrides documentation](https://docs.stackable.tech/home/nightly/concepts/overrides#config-overrides)
and consult the operator specific usage guide documentation for details on the
available config files and settings for the specific product.
properties:
config.json:
description: Overrides for the `config.json` file.
nullable: true
oneOf:
- required:
- jsonMergePatch
- required:
- jsonPatches
- required:
- userProvided
properties:
jsonMergePatch:
description: |-
Can be set to arbitrary YAML content, which is converted to JSON and used as
[RFC 7396](https://datatracker.ietf.org/doc/html/rfc7396) JSON merge patch.
type: object
x-kubernetes-preserve-unknown-fields: true
jsonPatches:
description: |-
List of [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patches.

Can be used when more flexibility is needed, e.g. to only modify elements
in a list based on a condition.

A patch looks something like

`{"op": "test", "path": "/0/name", "value": "Andrew"}`

or

`{"op": "add", "path": "/0/happy", "value": true}`
items:
type: string
type: array
userProvided:
description: Override the entire config file with the specified String.
type: string
type: object
dummy.properties:
additionalProperties:
type: string
description: Overrides for the `dummy.properties` file.
nullable: true
type: object
type: object
envOverrides:
additionalProperties:
Expand Down Expand Up @@ -1325,17 +1418,57 @@ spec:
type: object
type: object
configOverrides:
additionalProperties:
additionalProperties:
type: string
type: object
default: {}
description: |-
The `configOverrides` can be used to configure properties in product config files
that are not exposed in the CRD. Read the
[config overrides documentation](https://docs.stackable.tech/home/nightly/concepts/overrides#config-overrides)
and consult the operator specific usage guide documentation for details on the
available config files and settings for the specific product.
properties:
config.json:
description: Overrides for the `config.json` file.
nullable: true
oneOf:
- required:
- jsonMergePatch
- required:
- jsonPatches
- required:
- userProvided
properties:
jsonMergePatch:
description: |-
Can be set to arbitrary YAML content, which is converted to JSON and used as
[RFC 7396](https://datatracker.ietf.org/doc/html/rfc7396) JSON merge patch.
type: object
x-kubernetes-preserve-unknown-fields: true
jsonPatches:
description: |-
List of [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902) JSON patches.

Can be used when more flexibility is needed, e.g. to only modify elements
in a list based on a condition.

A patch looks something like

`{"op": "test", "path": "/0/name", "value": "Andrew"}`

or

`{"op": "add", "path": "/0/happy", "value": true}`
items:
type: string
type: array
userProvided:
description: Override the entire config file with the specified String.
type: string
type: object
dummy.properties:
additionalProperties:
type: string
description: Overrides for the `dummy.properties` file.
nullable: true
type: object
type: object
envOverrides:
additionalProperties:
Expand Down
5 changes: 4 additions & 1 deletion crates/stackable-operator/src/commons/resources.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@
//! role_utils::Role,
//! };
//!
//! #[derive(Clone, Debug, Default, Deserialize, JsonSchema, PartialEq, Serialize)]
//! pub struct ProductConfigOverrides {}
//!
//! #[derive(Clone, CustomResource, Debug, Deserialize, JsonSchema, Serialize)]
//! #[kube(
//! group = "product.stackable.tech",
Expand All @@ -46,7 +49,7 @@
//! #[serde(rename_all = "camelCase")]
//! pub struct ProductSpec {
//! #[serde(default, skip_serializing_if = "Option::is_none")]
//! pub nodes: Option<Role<ProductConfigFragment>>,
//! pub nodes: Option<Role<ProductConfigFragment, ProductConfigOverrides>>,
//! }
//!
//! #[derive(Debug, Default, PartialEq, Fragment, JsonSchema)]
Expand Down
Loading
Loading