You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[SPARK-53679] Fix typos in Spark Kubernetes Operator documentation
### What changes were proposed in this pull request?
This PR fixes a few typos in the documentation:
- Fix grammar error in config property description ("to for" → "for")
- Correct property name consistency in configuration.md
- Fix spelling errors: registory→registry, secuirty→security, etc.
- Update cluster state diagram reference to use correct image
- Fix table header typo and various other spelling corrections
### Why are the changes needed?
To have better documentation.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
This PR changes only documentation, no test is needed.
### Was this patch authored or co-authored using generative AI tooling?
Yes, this PR was generated with `claude-sonnet-4` and was reviewed manually.
Closesapache#334 from peter-toth/fix-typos.
Authored-by: Peter Toth <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
Copy file name to clipboardExpand all lines: docs/config_properties.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
| spark.kubernetes.operator.terminateOnInformerFailureEnabled | Boolean | false | false | Enable to indicate informer errors should stop operator startup. If disabled, operator startup will ignore recoverable errors, caused for example by RBAC issues and will retry periodically. |
9
9
| spark.kubernetes.operator.reconciler.terminationTimeoutSeconds | Integer | 30 | false | Grace period for operator shutdown before reconciliation threads are killed. |
10
10
| spark.kubernetes.operator.reconciler.parallelism | Integer | 50 | false | Thread pool size for Spark Operator reconcilers. Unbounded pool would be used if set to non-positive number. |
11
-
| spark.kubernetes.operator.reconciler.foregroundRequestTimeoutSeconds | Long | 30 | true | Timeout (in seconds) to for requests made to API server. This applies only to foreground requests. |
11
+
| spark.kubernetes.operator.reconciler.foregroundRequestTimeoutSeconds | Long | 30 | true | Timeout (in seconds) for requests made to API server. This applies only to foreground requests. |
12
12
| spark.kubernetes.operator.reconciler.intervalSeconds | Long | 120 | true | Interval (in seconds, non-negative) to reconcile Spark applications. Note that reconciliation is always expected to be triggered when app spec / status is updated. This interval controls the reconcile behavior of operator reconciliation even when there's no update on SparkApplication, e.g. to determine whether a hanging app needs to be proactively terminated. Thus this is recommended to set to above 2 minutes to avoid unnecessary no-op reconciliation. |
13
13
| spark.kubernetes.operator.reconciler.trimStateTransitionHistoryEnabled | Boolean | true | true | When enabled, operator would trim state transition history when a new attempt starts, keeping previous attempt summary only. |
14
14
| spark.kubernetes.operator.reconciler.appStatusListenerClassNames | String || false | Comma-separated names of SparkAppStatusListener class implementations |
| operatorDeployment.operatorPod.operatorContainer.env | Custom env to be added to the operator container. ||
81
81
| operatorDeployment.operatorPod.operatorContainer.envFrom | Custom envFrom to be added to the operator container, e.g. for downward API. ||
82
82
| operatorDeployment.operatorPod.operatorContainer.probes | Probe config for the operator container. ||
83
-
| operatorDeployment.operatorPod.operatorContainer.securityContext | Security context overrides for the operator container. | run as non root for baseline secuirty standard compliance |
83
+
| operatorDeployment.operatorPod.operatorContainer.securityContext | Security context overrides for the operator container. | run as non root for baseline security standard compliance |
84
84
| operatorDeployment.operatorPod.operatorContainer.resources | Resources for the operator container. | memory 2Gi, ephemeral storage 2Gi and 1 cpu |
85
85
| operatorDeployment.additionalContainers | Additional containers to be added to the operator pod, e.g. sidecar. ||
86
86
| operatorRbac.serviceAccount.create | Whether to create service account for operator to use. | true |
@@ -125,7 +125,7 @@ following table:
125
125
For more information check the [Helm documentation](https://helm.sh/docs/helm/helm_install/).
126
126
127
127
__Notice__: The pod resources should be set as your workload in different environments to
128
-
archive a matched K8s pod QoS. See
128
+
achieve a matched K8s pod QoS. See
129
129
also [Pod Quality of Service Classes](https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes).
130
130
131
131
## Operator Health(Liveness) Probe with Sentinel Resource
| .spec.applicationTolerations.applicationTimeoutConfig.driverStartTimeoutMillis | integer | 300000 | Time to wait for driver reaches running state after requested driver. |
245
245
| .spec.applicationTolerations.applicationTimeoutConfig.executorStartTimeoutMillis | integer | 300000 | Time to wait for driver to acquire minimal number of running executors. |
@@ -270,7 +270,7 @@ sparkConf:
270
270
Spark would try to bring up 10 executors as defined in SparkConf. In addition, from
271
271
operator perspective,
272
272
273
-
* If Spark app acquires less than 5 executors in given tine window (.spec.
273
+
* If Spark app acquires less than 5 executors in given time window (.spec.
274
274
applicationTolerations.applicationTimeoutConfig.executorStartTimeoutMillis) after
275
275
submitted, it would be shut down proactively in order to avoid resource deadlock.
276
276
* Spark app would be marked as 'RunningWithBelowThresholdExecutors' if it loses executors after
0 commit comments