This is an automated email from the ASF dual-hosted git repository.
dongjoon-hyun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/spark-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new bef03cf2 [SPARK-59960] Fix Helm command examples to use `spark`
release name consistently
bef03cf2 is described below
commit bef03cf2a86e17f67b9e1e6725b10d103fd78d7d
Author: Dongjoon Hyun <[email protected]>
AuthorDate: Fri Oct 2 12:44:23 2026 -0700
[SPARK-59960] Fix Helm command examples to use `spark` release name
consistently
### What changes were proposed in this pull request?
This PR aims to fix the Helm command examples that fail as written,
following
[SPARK-53639](https://github.com/apache/spark-kubernetes-operator/pull/323).
- `docs/operations.md`: Add the missing release name `spark` to the `--set`
example.
- `tests/e2e/helm/helm-test-values/*/values.yaml`: Fix the `Usage:`
comments to match the CI, i.e., run from the repository root with the release
name `spark`.
### Why are the changes needed?
SPARK-53639 unified the Helm release name to `spark`, but missed these
examples.
- The `--set` example fails with `must either provide a name or specify
--generate-name`.
- The `Usage:` comments use `spark-operator` and mix the chart path `.`
with repository-root `-f` paths, so they fail in any directory.
`configmap-metadata` also refers to a non-existent file.
### Does this PR introduce _any_ user-facing change?
No behavior change. Only a documentation example and test comments are
fixed.
### How was this patch tested?
Manually ran the fixed commands with `helm install --dry-run=client` from
the repository root.
### Was this patch authored or co-authored using generative AI tooling?
Generated-by: Claude Opus 5.5
Closes #929 from dongjoon-hyun/SPARK-59960.
Authored-by: Dongjoon Hyun <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
docs/operations.md | 5 +++--
tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml | 7 +++++--
tests/e2e/helm/helm-test-values/network-policy/values.yaml | 7 +++++--
tests/e2e/helm/helm-test-values/operator-command/values.yaml | 7 +++++--
4 files changed, 18 insertions(+), 8 deletions(-)
diff --git a/docs/operations.md b/docs/operations.md
index 820403cf..b75d82e4 100644
--- a/docs/operations.md
+++ b/docs/operations.md
@@ -74,9 +74,10 @@ in `values.yaml`) for the Helm chart.
To override single parameters you can use `--set`, for example:
```bash
-helm install --set image.repository=<my_registry>/spark-kubernetes-operator \
+helm install spark \
+ --set image.repository=<my_registry>/spark-kubernetes-operator \
-f build-tools/helm/spark-kubernetes-operator/values.yaml \
- build-tools/helm/spark-kubernetes-operator/
+ build-tools/helm/spark-kubernetes-operator/
```
You can also provide multiple custom values file by using the `-f` flag, the
latest takes
diff --git a/tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml
b/tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml
index 5b767d91..b0636a14 100644
--- a/tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml
+++ b/tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml
@@ -16,8 +16,11 @@
# Test values for validating ConfigMap labels and annotations feature
#
# Usage:
-# helm install spark-operator . -f tests/test-values-configmap-metadata.yaml
-# helm test spark-operator
+# helm install spark --create-namespace \
+# -f build-tools/helm/spark-kubernetes-operator/values.yaml \
+# -f tests/e2e/helm/helm-test-values/configmap-metadata/values.yaml \
+# build-tools/helm/spark-kubernetes-operator/
+# helm test spark
#
# This file demonstrates the ConfigMap labels and annotations feature
# and can be used to validate the Helm test for this functionality.
diff --git a/tests/e2e/helm/helm-test-values/network-policy/values.yaml
b/tests/e2e/helm/helm-test-values/network-policy/values.yaml
index 62ab1d85..a82fb658 100644
--- a/tests/e2e/helm/helm-test-values/network-policy/values.yaml
+++ b/tests/e2e/helm/helm-test-values/network-policy/values.yaml
@@ -16,8 +16,11 @@
# Test values for validating the operator NetworkPolicy feature
#
# Usage:
-# helm install spark-operator . -f
tests/e2e/helm/helm-test-values/network-policy/values.yaml
-# helm test spark-operator
+# helm install spark --create-namespace \
+# -f build-tools/helm/spark-kubernetes-operator/values.yaml \
+# -f tests/e2e/helm/helm-test-values/network-policy/values.yaml \
+# build-tools/helm/spark-kubernetes-operator/
+# helm test spark
operatorDeployment:
networkPolicy:
diff --git a/tests/e2e/helm/helm-test-values/operator-command/values.yaml
b/tests/e2e/helm/helm-test-values/operator-command/values.yaml
index 12b5e193..6247e04b 100644
--- a/tests/e2e/helm/helm-test-values/operator-command/values.yaml
+++ b/tests/e2e/helm/helm-test-values/operator-command/values.yaml
@@ -16,8 +16,11 @@
# Test values for validating how jvmArgs is rendered into the operator
container command
#
# Usage:
-# helm install spark-operator . -f
tests/e2e/helm/helm-test-values/operator-command/values.yaml
-# helm test spark-operator
+# helm install spark --create-namespace \
+# -f build-tools/helm/spark-kubernetes-operator/values.yaml \
+# -f tests/e2e/helm/helm-test-values/operator-command/values.yaml \
+# build-tools/helm/spark-kubernetes-operator/
+# helm test spark
#
# jvmArgs is quoted and deliberately awkward: surrounding and repeated
separators must not
# produce empty argv elements, and the '#' / '{' / ':' metacharacters must
survive rendering.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
