Yikun commented on a change in pull request #35496:
URL: https://github.com/apache/spark/pull/35496#discussion_r805237606
##########
File path:
resource-managers/kubernetes/core/src/main/scala/org/apache/spark/deploy/k8s/features/KubernetesDriverCustomFeatureConfigStep.scala
##########
@@ -25,6 +25,39 @@ import org.apache.spark.deploy.k8s.KubernetesDriverConf
* A base interface to help user extend custom feature step in driver side.
* Note: If your custom feature step would be used only in driver or both in
driver and executor,
* please use this.
+ *
+ * Here is an example of driver feature step:
+ *
+ * {{{
+ * class DriverExampleFeatureStep extends
KubernetesDriverCustomFeatureConfigStep {
+ * private var driverConf: KubernetesDriverConf = _
+ *
+ * override def init(conf: KubernetesDriverConf): Unit = {
+ * driverConf = conf
+ * }
+ *
+ * override def configurePod(pod: SparkPod): SparkPod = {}
Review comment:
```scala
// Implements the methods of `KubernetesFeatureConfigStep`, such as
`configurePod`
override def configurePod(pod: SparkPod): SparkPod = {
// Apply modifications on the given pod in accordance to this feature.
}
```
How about this? This doc is more for giving a exmaple to introduce how to
initialize according input configuration.
##########
File path:
resource-managers/kubernetes/core/src/main/scala/org/apache/spark/deploy/k8s/features/KubernetesDriverCustomFeatureConfigStep.scala
##########
@@ -25,6 +25,39 @@ import org.apache.spark.deploy.k8s.KubernetesDriverConf
* A base interface to help user extend custom feature step in driver side.
* Note: If your custom feature step would be used only in driver or both in
driver and executor,
* please use this.
+ *
+ * Here is an example of driver feature step:
+ *
+ * {{{
+ * class DriverExampleFeatureStep extends
KubernetesDriverCustomFeatureConfigStep {
+ * private var driverConf: KubernetesDriverConf = _
+ *
+ * override def init(conf: KubernetesDriverConf): Unit = {
+ * driverConf = conf
+ * }
+ *
+ * override def configurePod(pod: SparkPod): SparkPod = {}
Review comment:
```scala
// Implements methods of `KubernetesFeatureConfigStep`, such as
`configurePod`
override def configurePod(pod: SparkPod): SparkPod = {
// Apply modifications on the given pod in accordance to this feature.
}
```
How about this? This doc is more for giving a exmaple to introduce how to
initialize according input configuration.
##########
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 feature step for both driver and executor:
Review comment:
oops, addressed
##########
File path:
resource-managers/kubernetes/core/src/main/scala/org/apache/spark/deploy/k8s/features/KubernetesDriverCustomFeatureConfigStep.scala
##########
@@ -25,6 +25,45 @@ import org.apache.spark.deploy.k8s.KubernetesDriverConf
* A base interface to help user extend custom feature step in driver side.
* Note: If your custom feature step would be used only in driver or both in
driver and executor,
* please use this.
+ *
+ * Example of driver feature step:
+ *
+ * {{{
+ * class DriverExampleFeatureStep extends
KubernetesDriverCustomFeatureConfigStep {
+ * private var driverConf: KubernetesDriverConf = _
+ *
+ * override def init(conf: KubernetesDriverConf): Unit = {
+ * driverConf = 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:
ah, yes.
> For classes whose header doesn't fit in two lines, use 4 space indentation
for its parameters, put each in each line, **put the extends on the next line
with 2 space indent**, and add a blank line after class header.
This fix was required by
https://github.com/apache/spark/pull/35496#discussion_r805153828 , but I think
2 space is right. will recover soon.
--
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]
