dongjoon-hyun commented on a change in pull request #35496:
URL: https://github.com/apache/spark/pull/35496#discussion_r805462951
##########
File path:
resource-managers/kubernetes/core/src/main/scala/org/apache/spark/deploy/k8s/features/KubernetesExecutorCustomFeatureConfigStep.scala
##########
@@ -25,6 +25,45 @@ import org.apache.spark.deploy.k8s.KubernetesExecutorConf
* A base interface to help user extend custom feature step in executor side.
* Note: If your custom feature step would be used only in driver or both in
driver and executor,
* please use this.
+ *
+ * Example of executor feature step:
+ *
+ * {{{
+ * class ExecutorExampleFeatureStep extends
KubernetesExecutorCustomFeatureConfigStep {
+ * private var executorConf: KubernetesExecutorConf = _
+ *
+ * override def init(conf: KubernetesExecutorConf): Unit = {
+ * executorConf = conf
+ * }
+ *
+ * // Implements methods of `KubernetesFeatureConfigStep`, such as
`configurePod`
+ * override def configurePod(pod: SparkPod): SparkPod = {
+ * // Apply modifications on the given pod in accordance to this feature.
+ * }
+ * }
+ * }}}
+ *
+ * Example of feature step for both driver and executor:
+ *
+ * {{{
+ * class ExecutorExampleFeatureStep extends
KubernetesDriverCustomFeatureConfigStep
+ * with KubernetesExecutorCustomFeatureConfigStep {
Review comment:
ditto
--
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]
