Skip to content

Commit 7c8a393

Browse files
committed
allow specifying a values file that will be used for operator installations
1 parent a78def7 commit 7c8a393

34 files changed

Lines changed: 1911 additions & 65 deletions

docs/modules/stackablectl/partials/commands/cache.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,30 @@ File options:
6161
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6262
to provide multiple additional release files.
6363
64+
-f, --operator-values <VALUES_FILE>
65+
Path to a Helm values file that will be used for the installation of operators
66+
67+
The file is a YAML file containing Helm values used to deploy operators. It
68+
supports a 'common' key for values shared across all operators, as well as
69+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
70+
values that only apply to a single operator. Operator-specific values are
71+
merged with common values, with operator-specific values taking precedence.
72+
73+
Example values file:
74+
75+
common:
76+
tolerations:
77+
- key: "example"
78+
operator: "Exists"
79+
effect: "NoSchedule"
80+
airflow-operator:
81+
replicas: 2
82+
zookeeper-operator:
83+
replicas: 3
84+
85+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
86+
values file.
87+
6488
Helm repository options:
6589
--helm-repo-stable <URL>
6690
Provide a custom Helm stable repository URL
@@ -90,6 +114,8 @@ Operator specific configurations:
90114
--listener-class-preset <LISTENER_CLASS_PRESET>
91115
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
92116
117+
This takes precedence over values provided via the '-f/--operator-values' flag.
118+
93119
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.
94120
95121
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/completions.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,30 @@ File options:
6464
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6565
to provide multiple additional release files.
6666
67+
-f, --operator-values <VALUES_FILE>
68+
Path to a Helm values file that will be used for the installation of operators
69+
70+
The file is a YAML file containing Helm values used to deploy operators. It
71+
supports a 'common' key for values shared across all operators, as well as
72+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
73+
values that only apply to a single operator. Operator-specific values are
74+
merged with common values, with operator-specific values taking precedence.
75+
76+
Example values file:
77+
78+
common:
79+
tolerations:
80+
- key: "example"
81+
operator: "Exists"
82+
effect: "NoSchedule"
83+
airflow-operator:
84+
replicas: 2
85+
zookeeper-operator:
86+
replicas: 3
87+
88+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
89+
values file.
90+
6791
Helm repository options:
6892
--helm-repo-stable <URL>
6993
Provide a custom Helm stable repository URL
@@ -93,6 +117,8 @@ Operator specific configurations:
93117
--listener-class-preset <LISTENER_CLASS_PRESET>
94118
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
95119
120+
This takes precedence over values provided via the '-f/--operator-values' flag.
121+
96122
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.
97123
98124
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/demo.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,30 @@ File options:
6565
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6666
to provide multiple additional release files.
6767
68+
-f, --operator-values <VALUES_FILE>
69+
Path to a Helm values file that will be used for the installation of operators
70+
71+
The file is a YAML file containing Helm values used to deploy operators. It
72+
supports a 'common' key for values shared across all operators, as well as
73+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
74+
values that only apply to a single operator. Operator-specific values are
75+
merged with common values, with operator-specific values taking precedence.
76+
77+
Example values file:
78+
79+
common:
80+
tolerations:
81+
- key: "example"
82+
operator: "Exists"
83+
effect: "NoSchedule"
84+
airflow-operator:
85+
replicas: 2
86+
zookeeper-operator:
87+
replicas: 3
88+
89+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
90+
values file.
91+
6892
Helm repository options:
6993
--helm-repo-stable <URL>
7094
Provide a custom Helm stable repository URL
@@ -94,6 +118,8 @@ Operator specific configurations:
94118
--listener-class-preset <LISTENER_CLASS_PRESET>
95119
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
96120
121+
This takes precedence over values provided via the '-f/--operator-values' flag.
122+
97123
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.
98124
99125
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/experimental-debug.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,30 @@ File options:
7878
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
7979
to provide multiple additional release files.
8080
81+
-f, --operator-values <VALUES_FILE>
82+
Path to a Helm values file that will be used for the installation of operators
83+
84+
The file is a YAML file containing Helm values used to deploy operators. It
85+
supports a 'common' key for values shared across all operators, as well as
86+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
87+
values that only apply to a single operator. Operator-specific values are
88+
merged with common values, with operator-specific values taking precedence.
89+
90+
Example values file:
91+
92+
common:
93+
tolerations:
94+
- key: "example"
95+
operator: "Exists"
96+
effect: "NoSchedule"
97+
airflow-operator:
98+
replicas: 2
99+
zookeeper-operator:
100+
replicas: 3
101+
102+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
103+
values file.
104+
81105
Helm repository options:
82106
--helm-repo-stable <URL>
83107
Provide a custom Helm stable repository URL
@@ -107,6 +131,8 @@ Operator specific configurations:
107131
--listener-class-preset <LISTENER_CLASS_PRESET>
108132
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
109133
134+
This takes precedence over values provided via the '-f/--operator-values' flag.
135+
110136
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.
111137
112138
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/index.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,30 @@ File options:
6868
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6969
to provide multiple additional release files.
7070
71+
-f, --operator-values <VALUES_FILE>
72+
Path to a Helm values file that will be used for the installation of operators
73+
74+
The file is a YAML file containing Helm values used to deploy operators. It
75+
supports a 'common' key for values shared across all operators, as well as
76+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
77+
values that only apply to a single operator. Operator-specific values are
78+
merged with common values, with operator-specific values taking precedence.
79+
80+
Example values file:
81+
82+
common:
83+
tolerations:
84+
- key: "example"
85+
operator: "Exists"
86+
effect: "NoSchedule"
87+
airflow-operator:
88+
replicas: 2
89+
zookeeper-operator:
90+
replicas: 3
91+
92+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
93+
values file.
94+
7195
Helm repository options:
7296
--helm-repo-stable <URL>
7397
Provide a custom Helm stable repository URL
@@ -97,6 +121,8 @@ Operator specific configurations:
97121
--listener-class-preset <LISTENER_CLASS_PRESET>
98122
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
99123
124+
This takes precedence over values provided via the '-f/--operator-values' flag.
125+
100126
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.
101127
102128
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/operator.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,30 @@ File options:
6464
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6565
to provide multiple additional release files.
6666
67+
-f, --operator-values <VALUES_FILE>
68+
Path to a Helm values file that will be used for the installation of operators
69+
70+
The file is a YAML file containing Helm values used to deploy operators. It
71+
supports a 'common' key for values shared across all operators, as well as
72+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
73+
values that only apply to a single operator. Operator-specific values are
74+
merged with common values, with operator-specific values taking precedence.
75+
76+
Example values file:
77+
78+
common:
79+
tolerations:
80+
- key: "example"
81+
operator: "Exists"
82+
effect: "NoSchedule"
83+
airflow-operator:
84+
replicas: 2
85+
zookeeper-operator:
86+
replicas: 3
87+
88+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
89+
values file.
90+
6791
Helm repository options:
6892
--helm-repo-stable <URL>
6993
Provide a custom Helm stable repository URL
@@ -93,6 +117,8 @@ Operator specific configurations:
93117
--listener-class-preset <LISTENER_CLASS_PRESET>
94118
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
95119
120+
This takes precedence over values provided via the '-f/--operator-values' flag.
121+
96122
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.
97123
98124
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/release.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,30 @@ File options:
6464
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6565
to provide multiple additional release files.
6666
67+
-f, --operator-values <VALUES_FILE>
68+
Path to a Helm values file that will be used for the installation of operators
69+
70+
The file is a YAML file containing Helm values used to deploy operators. It
71+
supports a 'common' key for values shared across all operators, as well as
72+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
73+
values that only apply to a single operator. Operator-specific values are
74+
merged with common values, with operator-specific values taking precedence.
75+
76+
Example values file:
77+
78+
common:
79+
tolerations:
80+
- key: "example"
81+
operator: "Exists"
82+
effect: "NoSchedule"
83+
airflow-operator:
84+
replicas: 2
85+
zookeeper-operator:
86+
replicas: 3
87+
88+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
89+
values file.
90+
6791
Helm repository options:
6892
--helm-repo-stable <URL>
6993
Provide a custom Helm stable repository URL
@@ -93,6 +117,8 @@ Operator specific configurations:
93117
--listener-class-preset <LISTENER_CLASS_PRESET>
94118
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
95119
120+
This takes precedence over values provided via the '-f/--operator-values' flag.
121+
96122
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.
97123
98124
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/stack.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,30 @@ File options:
6565
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6666
to provide multiple additional release files.
6767
68+
-f, --operator-values <VALUES_FILE>
69+
Path to a Helm values file that will be used for the installation of operators
70+
71+
The file is a YAML file containing Helm values used to deploy operators. It
72+
supports a 'common' key for values shared across all operators, as well as
73+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
74+
values that only apply to a single operator. Operator-specific values are
75+
merged with common values, with operator-specific values taking precedence.
76+
77+
Example values file:
78+
79+
common:
80+
tolerations:
81+
- key: "example"
82+
operator: "Exists"
83+
effect: "NoSchedule"
84+
airflow-operator:
85+
replicas: 2
86+
zookeeper-operator:
87+
replicas: 3
88+
89+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
90+
values file.
91+
6892
Helm repository options:
6993
--helm-repo-stable <URL>
7094
Provide a custom Helm stable repository URL
@@ -94,6 +118,8 @@ Operator specific configurations:
94118
--listener-class-preset <LISTENER_CLASS_PRESET>
95119
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
96120
121+
This takes precedence over values provided via the '-f/--operator-values' flag.
122+
97123
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.
98124
99125
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/stacklet.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,30 @@ File options:
6666
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6767
to provide multiple additional release files.
6868
69+
-f, --operator-values <VALUES_FILE>
70+
Path to a Helm values file that will be used for the installation of operators
71+
72+
The file is a YAML file containing Helm values used to deploy operators. It
73+
supports a 'common' key for values shared across all operators, as well as
74+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
75+
values that only apply to a single operator. Operator-specific values are
76+
merged with common values, with operator-specific values taking precedence.
77+
78+
Example values file:
79+
80+
common:
81+
tolerations:
82+
- key: "example"
83+
operator: "Exists"
84+
effect: "NoSchedule"
85+
airflow-operator:
86+
replicas: 2
87+
zookeeper-operator:
88+
replicas: 3
89+
90+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
91+
values file.
92+
6993
Helm repository options:
7094
--helm-repo-stable <URL>
7195
Provide a custom Helm stable repository URL
@@ -95,6 +119,8 @@ Operator specific configurations:
95119
--listener-class-preset <LISTENER_CLASS_PRESET>
96120
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
97121
122+
This takes precedence over values provided via the '-f/--operator-values' flag.
123+
98124
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.
99125
100126
[possible values: none, stable-nodes, ephemeral-nodes]

docs/modules/stackablectl/partials/commands/version.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,30 @@ File options:
6060
Use "stackablectl [OPTIONS] <COMMAND> -r path/to/releases1.yaml -r path/to/releases2.yaml"
6161
to provide multiple additional release files.
6262
63+
-f, --operator-values <VALUES_FILE>
64+
Path to a Helm values file that will be used for the installation of operators
65+
66+
The file is a YAML file containing Helm values used to deploy operators. It
67+
supports a 'common' key for values shared across all operators, as well as
68+
operator-specific keys (e.g. 'airflow-operator', 'zookeeper-operator') for
69+
values that only apply to a single operator. Operator-specific values are
70+
merged with common values, with operator-specific values taking precedence.
71+
72+
Example values file:
73+
74+
common:
75+
tolerations:
76+
- key: "example"
77+
operator: "Exists"
78+
effect: "NoSchedule"
79+
airflow-operator:
80+
replicas: 2
81+
zookeeper-operator:
82+
replicas: 3
83+
84+
Use "stackablectl [OPTIONS] <COMMAND> -f path/to/values.yaml" to provide a
85+
values file.
86+
6387
Helm repository options:
6488
--helm-repo-stable <URL>
6589
Provide a custom Helm stable repository URL
@@ -89,6 +113,8 @@ Operator specific configurations:
89113
--listener-class-preset <LISTENER_CLASS_PRESET>
90114
Choose the ListenerClass preset (`none`, `ephemeral-nodes` or `stable-nodes`).
91115
116+
This takes precedence over values provided via the '-f/--operator-values' flag.
117+
92118
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.
93119
94120
[possible values: none, stable-nodes, ephemeral-nodes]

0 commit comments

Comments
 (0)