Skip to content

Commit 6be1a39

Browse files
committed
[SPARK-59991] Remove unused operatorConfiguration.append and fix broken conf/ links
### What changes were proposed in this pull request? This PR aims to remove the unused `operatorConfiguration.append` from the Helm chart and fix the broken `conf/` links in the documentation. ### Why are the changes needed? The Helm chart has never had a `conf/` directory, so `operatorConfiguration.append` has no effect in any release, e.g. [1.0.0](https://github.com/apache/spark-kubernetes-operator/releases/tag/1.0.0) (2026-07-23). However, `values.yaml` and the documentation still describe it and link to the non-existent conf files. ### Does this PR introduce _any_ user-facing change? Yes, `operatorConfiguration.append` is removed, but the rendered manifests are identical. The migration guide is updated. ### How was this patch tested? Pass the CIs. I also verified manually that `helm template` renders identical manifests before and after this PR. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Claude Opus 5.5 Closes #937 from dongjoon-hyun/SPARK-59991. Authored-by: Dongjoon Hyun <dongjoon@apache.org> Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
1 parent e2b5899 commit 6be1a39

7 files changed

Lines changed: 9 additions & 22 deletions

File tree

‎build-tools/helm/spark-kubernetes-operator/templates/spark-operator.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -218,15 +218,9 @@ metadata:
218218
{{- end }}
219219
data:
220220
log4j2.properties: |
221-
{{- if .Values.operatorConfiguration.append }}
222-
{{- with $.Files.Get "conf/log4j2.properties" }}{{ . | nindent 4 }}{{ end }}
223-
{{- end }}
224221
{{- with index .Values.operatorConfiguration "log4j2.properties" }}{{ . | nindent 4 }}{{ end }}
225222
spark-operator.properties: |
226223
{{- include "spark-operator.defaultPropertyOverrides" . | nindent 4 }}
227-
{{- if .Values.operatorConfiguration.append }}
228-
{{- with $.Files.Get "conf/spark-operator.properties" }}{{ . | nindent 4 }}{{ end }}
229-
{{- end }}
230224
{{- with index .Values.operatorConfiguration "spark-operator.properties" }}{{ . | nindent 4 }}{{ end }}
231225
metrics.properties: |
232226
{{- with index .Values.operatorConfiguration "metrics.properties" }}{{ . | nindent 4 }}{{ end }}

‎build-tools/helm/spark-kubernetes-operator/values.schema.json‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -792,14 +792,7 @@
792792
"operatorConfiguration": {
793793
"type": "object",
794794
"description": "Operator configuration",
795-
"required": [
796-
"append"
797-
],
798795
"properties": {
799-
"append": {
800-
"type": "boolean",
801-
"description": "Append configuration instead of replacing"
802-
},
803796
"configMap": {
804797
"type": "object",
805798
"description": "Configuration for the operator config map",

‎build-tools/helm/spark-kubernetes-operator/values.yaml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,6 @@ workloadResources:
209209
"app.kubernetes.io/component": "spark-workload"
210210

211211
operatorConfiguration:
212-
# If set to true, below properties would be appended to default conf files under conf/
213-
# Otherwise, below would override default conf files
214-
append: true
215212
# Labels and annotations for the operatorConfiguration config map
216213
configMap:
217214
annotations:

‎docs/configuration.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@ under the License.
2323

2424
Spark Operator supports different ways to configure the behavior:
2525

26-
* **spark-operator.properties** provided when deploying the operator. In addition to the
27-
[property file](../build-tools/helm/spark-kubernetes-operator/conf/spark-operator.properties),
28-
it is also possible to override or append config properties in helm
26+
* **spark-operator.properties** provided when deploying the operator. It is possible to override
27+
the [default values](./config_properties.md) of config properties in helm
2928
[Values files](../build-tools/helm/spark-kubernetes-operator/values.yaml).
3029
* **System Properties** : when provided as system properties (e.g. via -D options to the
3130
operator JVM), they apply only to the properties which are not provided in the property file,

‎docs/migration_guide.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,12 @@ affect building the project, CI, tests or examples.
9393
take precedence over `JAVA_TOOL_OPTIONS` and `JDK_JAVA_OPTIONS` in `operatorContainer.env`, and
9494
cannot contain a space, since the value is split on spaces. To restore the behavior before
9595
1.1.0, set `jvmArgs` to `-Dfile.encoding=UTF8` ([SPARK-58426](https://issues.apache.org/jira/browse/SPARK-58426)).
96+
- Since 1.1.0, `operatorConfiguration.append` is removed, and the chart no longer reads
97+
`conf/log4j2.properties` and `conf/spark-operator.properties` in the chart directory, which it
98+
has never included. A values file which still sets `append` keeps working, since the key is
99+
ignored. If you added such files to the chart, prepend their content to
100+
`operatorConfiguration.log4j2.properties` and `operatorConfiguration.spark-operator.properties`
101+
respectively to restore the behavior before 1.1.0.
96102

97103
### Operator
98104

‎docs/operations.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,9 @@ following table:
162162
| workloadResources.sparkClusterSentinel.create | If enabled, sentinel resources will be created for operator to watch and reconcile for the health probe purpose. | false |
163163
| workloadResources.sparkClusterSentinel.name | Name for sentinel resources. | "spark-cluster-sentinel" |
164164
| workloadResources.sparkClusterSentinel.sentinelNamespaces.data | A list of namespaces where sentinel resources will be created in. Note that these namespaces have to be a subset of `workloadResources.namespaces.data`. | |
165-
| operatorConfiguration.append | If set to true, below conf file & properties would be appended to default conf. Otherwise, they would override default properties. | true |
166165
| operatorConfiguration.configMap.annotations | Annotations to be applied for the operator configuration config map. | |
167166
| operatorConfiguration.configMap.labels | Labels to be applied for the operator configuration config map. | |
168-
| operatorConfiguration.log4j2.properties | The default log4j2 configuration. | Refer default [log4j2.properties](../build-tools/helm/spark-kubernetes-operator/conf/log4j2.properties) |
167+
| operatorConfiguration.log4j2.properties | The default log4j2 configuration. | Refer default [values.yaml](../build-tools/helm/spark-kubernetes-operator/values.yaml) |
169168
| operatorConfiguration.spark-operator.properties | The default operator configuration. | |
170169
| operatorConfiguration.metrics.properties | The default operator metrics (sink) configuration. | |
171170
| operatorConfiguration.dynamicConfig.create | If set to true, a config map would be created & watched by operator as source of truth for hot properties loading. | false |

‎tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
# and can be used to validate the Helm test for this functionality.
2727

2828
operatorConfiguration:
29-
append: true
3029
configMap:
3130
labels:
3231
test.example.com/label: "test-value"

0 commit comments

Comments
 (0)