Skip to content

[SPARK-44906][K8S] Make Kubernetes[Driver|Executor]Conf.annotations substitute annotations instead of feature steps #42600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
zwangsheng wants to merge 7 commits into from
Closed

[SPARK-44906][K8S] Make Kubernetes[Driver|Executor]Conf.annotations substitute annotations instead of feature steps #42600

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ec776f3
[SPARK-44906][K8S] Move Utils. SubstituteAppNExecIds logic into Kube…
zwangsheng Aug 22, 2023
529187a
Add Unit test
zwangsheng Aug 22, 2023
a422aa1
fix missing executorId
zwangsheng Aug 22, 2023
be10416
fix style
zwangsheng Aug 23, 2023
796659f
fix comments
zwangsheng Aug 23, 2023
74635dc
Update resource-managers/kubernetes/core/src/main/scala/org/apache/sp…
yaooqinn Aug 23, 2023
1bfe492
Update resource-managers/kubernetes/core/src/main/scala/org/apache/sp…
yaooqinn Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ...-managers/kubernetes/core/src/main/scala/org/apache/spark/deploy/k8s/KubernetesConf.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,10 @@ private[spark] class KubernetesDriverConf(
}

override def annotations: Map[String, String] = {
KubernetesUtils.parsePrefixedKeyValuePairs(sparkConf, KUBERNETES_DRIVER_ANNOTATION_PREFIX)
KubernetesUtils.parsePrefixedKeyValuePairs(sparkConf, KUBERNETES_DRIVER_ANNOTATION_PREFIX).map {
case(k, v) =>
(k, Utils.substituteAppNExecIds(v, appId, ""))
}
Copy link
Member

@dongjoon-hyun dongjoon-hyun Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you don't mind, shall we use the consistent short style like KubernetesExecutorConf, @zwangsheng ?

}

def serviceLabels: Map[String, String] = {
Expand Down Expand Up @@ -188,6 +191,7 @@ private[spark] class KubernetesExecutorConf(

override def annotations: Map[String, String] = {
KubernetesUtils.parsePrefixedKeyValuePairs(sparkConf, KUBERNETES_EXECUTOR_ANNOTATION_PREFIX)
.map { case (k, v) => (k, Utils.substituteAppNExecIds(v, appId, executorId)) }
}

override def secretNamesToMountPaths: Map[String, String] = {
Expand Down
3 changes: 1 addition & 2 deletions ...tes/core/src/main/scala/org/apache/spark/deploy/k8s/features/BasicDriverFeatureStep.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,7 @@ private[spark] class BasicDriverFeatureStep(conf: KubernetesDriverConf)
.editOrNewMetadata()
.withName(driverPodName)
.addToLabels(conf.labels.asJava)
.addToAnnotations(conf.annotations.map { case (k, v) =>
(k, Utils.substituteAppNExecIds(v, conf.appId, "")) }.asJava)
.addToAnnotations(conf.annotations.asJava)
.endMetadata()
.editOrNewSpec()
.withRestartPolicy("Never")
Expand Down
6 changes: 2 additions & 4 deletions ...s/core/src/main/scala/org/apache/spark/deploy/k8s/features/BasicExecutorFeatureStep.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,14 +255,12 @@ private[spark] class BasicExecutorFeatureStep(
case "statefulset" => "Always"
case _ => "Never"
}
val annotations = kubernetesConf.annotations.map { case (k, v) =>
(k, Utils.substituteAppNExecIds(v, kubernetesConf.appId, kubernetesConf.executorId))
}

val executorPodBuilder = new PodBuilder(pod.pod)
.editOrNewMetadata()
.withName(name)
.addToLabels(kubernetesConf.labels.asJava)
.addToAnnotations(annotations.asJava)
.addToAnnotations(kubernetesConf.annotations.asJava)
.addToOwnerReferences(ownerReference.toSeq: _*)
.endMetadata()
.editOrNewSpec()
Expand Down
15 changes: 12 additions & 3 deletions ...gers/kubernetes/core/src/test/scala/org/apache/spark/deploy/k8s/KubernetesConfSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import org.apache.spark.deploy.k8s.Config._
import org.apache.spark.deploy.k8s.Constants._
import org.apache.spark.deploy.k8s.submit._
import org.apache.spark.resource.ResourceProfile.DEFAULT_RESOURCE_PROFILE_ID
import org.apache.spark.util.Utils

class KubernetesConfSuite extends SparkFunSuite {

Expand All @@ -42,7 +43,9 @@ class KubernetesConfSuite extends SparkFunSuite {
"customLabel2Key" -> "customLabel2Value")
private val CUSTOM_ANNOTATIONS = Map(
"customAnnotation1Key" -> "customAnnotation1Value",
"customAnnotation2Key" -> "customAnnotation2Value")
"customAnnotation2Key" -> "customAnnotation2Value",
"customAnnotation3Key" -> "{{APP_ID}}",
"customAnnotation4Key" -> "{{EXECUTOR_ID}}")
private val SECRET_NAMES_TO_MOUNT_PATHS = Map(
"secret1" -> "/mnt/secrets/secret1",
"secret2" -> "/mnt/secrets/secret2")
Expand Down Expand Up @@ -93,7 +96,10 @@ class KubernetesConfSuite extends SparkFunSuite {
SPARK_APP_NAME_LABEL -> KubernetesConf.getAppNameLabel(conf.appName),
SPARK_ROLE_LABEL -> SPARK_POD_DRIVER_ROLE) ++
CUSTOM_LABELS)
assert(conf.annotations === CUSTOM_ANNOTATIONS)
assert(conf.annotations === CUSTOM_ANNOTATIONS.map {
case (k, v) =>
(k, Utils.substituteAppNExecIds(v, conf.appId, ""))
Copy link
Member

@dongjoon-hyun dongjoon-hyun Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can merge it into one line.

-      case (k, v) =>
-        (k, Utils.substituteAppNExecIds(v, conf.appId, ""))
+      case (k, v) => (k, Utils.substituteAppNExecIds(v, conf.appId, ""))

})
assert(conf.secretNamesToMountPaths === SECRET_NAMES_TO_MOUNT_PATHS)
assert(conf.secretEnvNamesToKeyRefs === SECRET_ENV_VARS)
assert(conf.environment === CUSTOM_ENVS)
Expand Down Expand Up @@ -161,7 +167,10 @@ class KubernetesConfSuite extends SparkFunSuite {
SPARK_APP_NAME_LABEL -> KubernetesConf.getAppNameLabel(conf.appName),
SPARK_ROLE_LABEL -> SPARK_POD_EXECUTOR_ROLE,
SPARK_RESOURCE_PROFILE_ID_LABEL -> DEFAULT_RESOURCE_PROFILE_ID.toString) ++ CUSTOM_LABELS)
assert(conf.annotations === CUSTOM_ANNOTATIONS)
assert(conf.annotations === CUSTOM_ANNOTATIONS.map {
case (k, v) =>
(k, Utils.substituteAppNExecIds(v, conf.appId, EXECUTOR_ID))
Copy link
Member

@dongjoon-hyun dongjoon-hyun Aug 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

})
assert(conf.secretNamesToMountPaths === SECRET_NAMES_TO_MOUNT_PATHS)
assert(conf.secretEnvNamesToKeyRefs === SECRET_ENV_VARS)
}
Expand Down