srowen closed pull request #23155: [MINOR][K8S] add missing docs for podTemplateContainerName properties URL: https://github.com/apache/spark/pull/23155
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/docs/running-on-kubernetes.md b/docs/running-on-kubernetes.md index 3172b1bca8f05..3453ee912205f 100644 --- a/docs/running-on-kubernetes.md +++ b/docs/running-on-kubernetes.md @@ -229,8 +229,11 @@ pod template that will always be overwritten by Spark. Therefore, users of this the pod template file only lets Spark start with a template pod instead of an empty pod during the pod-building process. For details, see the [full list](#pod-template-properties) of pod template values that will be overwritten by spark. -Pod template files can also define multiple containers. In such cases, Spark will always assume that the first container in -the list will be the driver or executor container. +Pod template files can also define multiple containers. In such cases, you can use the spark properties +`spark.kubernetes.driver.podTemplateContainerName` and `spark.kubernetes.executor.podTemplateContainerName` +to indicate which container should be used as a basis for the driver or executor. +If not specified, or if the container name is not valid, Spark will assume that the first container in the list +will be the driver or executor container. ## Using Kubernetes Volumes @@ -932,16 +935,32 @@ specific to Spark on Kubernetes. <td><code>spark.kubernetes.driver.podTemplateFile</code></td> <td>(none)</td> <td> - Specify the local file that contains the driver [pod template](#pod-template). For example - <code>spark.kubernetes.driver.podTemplateFile=/path/to/driver-pod-template.yaml`</code> + Specify the local file that contains the driver <a href="#pod-template">pod template</a>. For example + <code>spark.kubernetes.driver.podTemplateFile=/path/to/driver-pod-template.yaml</code> + </td> +</tr> +<tr> + <td><code>spark.kubernetes.driver.podTemplateContainerName</code></td> + <td>(none)</td> + <td> + Specify the container name to be used as a basis for the driver in the given <a href="#pod-template">pod template</a>. + For example <code>spark.kubernetes.driver.podTemplateContainerName=spark-driver</code> </td> </tr> <tr> <td><code>spark.kubernetes.executor.podTemplateFile</code></td> <td>(none)</td> <td> - Specify the local file that contains the executor [pod template](#pod-template). For example - <code>spark.kubernetes.executor.podTemplateFile=/path/to/executor-pod-template.yaml`</code> + Specify the local file that contains the executor <a href="#pod-template">pod template</a>. For example + <code>spark.kubernetes.executor.podTemplateFile=/path/to/executor-pod-template.yaml</code> + </td> +</tr> +<tr> + <td><code>spark.kubernetes.executor.podTemplateContainerName</code></td> + <td>(none)</td> + <td> + Specify the container name to be used as a basis for the executor in the given <a href="#pod-template">pod template</a>. + For example <code>spark.kubernetes.executor.podTemplateContainerName=spark-executor</code> </td> </tr> <tr> ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
