dongjoon-hyun opened a new pull request, #839:
URL: https://github.com/apache/spark-kubernetes-operator/pull/839

   ### What changes were proposed in this pull request?
   
   This PR aims to fix the Helm chart configuration table in 
`docs/operations.md` to be consistent with the Helm chart (`values.yaml` and 
`templates/*.yaml`).
   
   **Fix the wrong keys, descriptions and default values**
   
   | Parameter | Before | After |
   |---|---|---|
   | Key | `operatorDeployment.replica` | `operatorDeployment.replicas` |
   | Key | `operatorDeployment.additionalContainers` | 
`operatorDeployment.operatorPod.additionalContainers` |
   | Default value of 
`operatorDeployment.operatorPod.operatorContainer.jvmArgs` | 
`-Dfile.encoding=UTF8 -XX:+CrashOnOutOfMemoryError -XX:ErrorFile=/dev/stderr 
-XX:+UseParallelGC` | `-Dfile.encoding=UTF8 -XX:+CrashOnOutOfMemoryError 
-XX:ErrorFile=/dev/stderr -XX:+UseParallelGC -XX:InitialRAMPercentage=80 
-XX:MaxRAMPercentage=80 -XX:+AlwaysPreTouch -XX:+UseCompactObjectHeaders` |
   | Description of `operatorRbac.serviceAccount.name` | Name of the operator 
Role. | Name of the operator ServiceAccount. |
   | Description of `operatorRbac.configManagement.create` | ... (hot property 
loading and leader election). | ... (hot property loading from ConfigMap). 
Requires `dynamicConfig` with the `configMap` source. |
   | Default value of `operatorRbac.configManagement.roleName` | 
`spark-operator-config-role` | `"spark-operator-config-monitor"` |
   | Key | `operatorRbac.configManagement.roleBinding` | 
`operatorRbac.configManagement.roleBindingName` |
   | Key | `workloadResources.serviceAccounts.create` | 
`workloadResources.serviceAccount.create` |
   | Key | `workloadResources.serviceAccounts.name` | 
`workloadResources.serviceAccount.name` |
   | Key | `workloadResources.sparkApplicationSentinel.sentinelNamespaces` | 
`workloadResources.sparkApplicationSentinel.sentinelNamespaces.data` |
   | Key | `workloadResources.sparkClusterSentinel.sentinelNamespaces` | 
`workloadResources.sparkClusterSentinel.sentinelNamespaces.data` |
   
   **Add the missing keys**
   
   | Parameter | Default value |
   |---|---|
   | `operatorDeployment.networkPolicy.enabled` | `false` |
   | `operatorDeployment.networkPolicy.metricsIngress` | |
   | `operatorDeployment.operatorPod.affinity` | |
   | `operatorDeployment.operatorPod.tolerations` | |
   | `operatorDeployment.operatorPod.dnsPolicy` | |
   | `operatorDeployment.operatorPod.operatorContainer.volumeMounts` | |
   | `operatorDeployment.operatorPod.operatorContainer.metrics.port` | `19090` |
   | `operatorRbac.annotations` | |
   | `operatorConfiguration.configMap.annotations` | |
   | `operatorConfiguration.configMap.labels` | |
   | `operatorConfiguration.dynamicConfig.source` | `configMap` |
   
   ### Why are the changes needed?
   
   The documentation is inconsistent with the actual Helm chart. Some 
documented keys do not exist in the chart, so users cannot configure the chart 
by following the documentation. In addition, several supported keys are not 
documented.
   
   ### Does this PR introduce _any_ user-facing change?
   
   No behavior change. This is a documentation-only fix.
   
   ### How was this patch tested?
   
   Manual review.
   
   ### Was this patch authored or co-authored using generative AI tooling?
   
   Generated-by: Claude Opus 5


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to