Skip to content

feat: Allow specifying Helm values for operator installations #425

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
labrenbe merged 9 commits into from
Mar 9, 2026
Merged

feat: Allow specifying Helm values for operator installations #425

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7c8a393
allow specifying a values file that will be used for operator install…
labrenbe Feb 17, 2026
f501087
minor refactor
labrenbe Feb 17, 2026
15cde97
rename FileTransfer error variant
labrenbe Feb 17, 2026
f4a2fb7
Remove common key in yaml and deep merge logic; recommend yaml anchors
labrenbe Mar 4, 2026
77e65c3
Improve helm value file error output
labrenbe Mar 4, 2026
ad04934
Fix values file example
labrenbe Mar 4, 2026
a726a87
explain why serialization statement won't fail
labrenbe Mar 4, 2026
f03ff88
fix pre-commit
labrenbe Mar 4, 2026
ce6bc24
Merge branch 'main' into feat/operator-values
labrenbe Mar 6, 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
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/cache.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -90,6 +114,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/completions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -93,6 +117,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/demo.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -94,6 +118,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/experimental-debug.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -107,6 +131,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -97,6 +121,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -93,6 +117,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/release.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -93,6 +117,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/stack.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -94,6 +118,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/stacklet.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -95,6 +119,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
26 changes: 26 additions & 0 deletions docs/modules/stackablectl/partials/commands/version.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,30 @@ File options:
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
to provide multiple additional release files.

-f, --operator-values <VALUES_FILE>
Path to a Helm values file that will be used for the installation of operators

The file is a YAML file containing Helm values used to deploy operators. It
supports a 'common' key for values shared across all operators, as well as
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
values that only apply to a single operator. Operator-specific values are
merged with common values, with operator-specific values taking precedence.

Example values file:

common:
Comment thread
NickLarsenNZ marked this conversation as resolved.
Outdated
tolerations:
- key: "example"
operator: "Exists"
effect: "NoSchedule"
airflow-operator:
replicas: 2
zookeeper-operator:
replicas: 3

Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
values file.

Helm repository options:
--helm-repo-stable <URL>
Provide a custom Helm stable repository URL
Expand Down Expand Up @@ -89,6 +113,8 @@ Operator specific configurations:
--listener-class-preset <LISTENER_CLASS_PRESET>
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).

This takes precedence over values provided via the '-f/--operator-values' flag.

This maps to the listener-operator Helm Chart preset value, see [the listener-operator documentation](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass/#presets) for details.

[possible values: none, stable-nodes, ephemeral-nodes]
Expand Down
Loading
Loading