Skip to content

[SPARK-47730][K8S] Support APP_ID and EXECUTOR_ID placeholders in labels #46149

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
jshmchenxi wants to merge 2 commits into from
Closed

[SPARK-47730][K8S] Support APP_ID and EXECUTOR_ID placeholders in labels #46149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bddb23f
[SPARK-47730][K8S] Support APP_ID and EXECUTOR_ID placeholders in labels
jshmchenxi Apr 21, 2024
528539c
Address comments to use a general label key in unit tests.
jshmchenxi Apr 27, 2024
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
10 changes: 6 additions & 4 deletions ...-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 @@ -100,8 +100,9 @@ private[spark] class KubernetesDriverConf(
SPARK_APP_ID_LABEL -> appId,
SPARK_APP_NAME_LABEL -> KubernetesConf.getAppNameLabel(appName),
SPARK_ROLE_LABEL -> SPARK_POD_DRIVER_ROLE)
val driverCustomLabels = KubernetesUtils.parsePrefixedKeyValuePairs(
sparkConf, KUBERNETES_DRIVER_LABEL_PREFIX)
val driverCustomLabels =
KubernetesUtils.parsePrefixedKeyValuePairs(sparkConf, KUBERNETES_DRIVER_LABEL_PREFIX)
.map { case(k, v) => (k, Utils.substituteAppNExecIds(v, appId, "")) }

presetLabels.keys.foreach { key =>
require(
Expand Down Expand Up @@ -173,8 +174,9 @@ private[spark] class KubernetesExecutorConf(
SPARK_ROLE_LABEL -> SPARK_POD_EXECUTOR_ROLE,
SPARK_RESOURCE_PROFILE_ID_LABEL -> resourceProfileId.toString)

val executorCustomLabels = KubernetesUtils.parsePrefixedKeyValuePairs(
sparkConf, KUBERNETES_EXECUTOR_LABEL_PREFIX)
val executorCustomLabels =
KubernetesUtils.parsePrefixedKeyValuePairs(sparkConf, KUBERNETES_EXECUTOR_LABEL_PREFIX)
.map { case(k, v) => (k, Utils.substituteAppNExecIds(v, appId, executorId)) }

presetLabels.keys.foreach { key =>
require(
Expand Down
13 changes: 10 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 @@ -40,7 +40,9 @@ class KubernetesConfSuite extends SparkFunSuite {
"execNodeSelectorKey2" -> "execNodeSelectorValue2")
private val CUSTOM_LABELS = Map(
"customLabel1Key" -> "customLabel1Value",
"customLabel2Key" -> "customLabel2Value")
"customLabel2Key" -> "customLabel2Value",
"customLabel3Key" -> "{{APP_ID}}",
"customLabel4Key" -> "{{EXECUTOR_ID}}")
private val CUSTOM_ANNOTATIONS = Map(
"customAnnotation1Key" -> "customAnnotation1Value",
"customAnnotation2Key" -> "customAnnotation2Value",
Expand Down Expand Up @@ -95,7 +97,9 @@ class KubernetesConfSuite extends SparkFunSuite {
SPARK_APP_ID_LABEL -> KubernetesTestConf.APP_ID,
SPARK_APP_NAME_LABEL -> KubernetesConf.getAppNameLabel(conf.appName),
SPARK_ROLE_LABEL -> SPARK_POD_DRIVER_ROLE) ++
CUSTOM_LABELS)
CUSTOM_LABELS.map {
case (k, v) => (k, Utils.substituteAppNExecIds(v, conf.appId, ""))
})
assert(conf.annotations === CUSTOM_ANNOTATIONS.map {
case (k, v) => (k, Utils.substituteAppNExecIds(v, conf.appId, ""))
})
Expand Down Expand Up @@ -165,7 +169,10 @@ class KubernetesConfSuite extends SparkFunSuite {
SPARK_APP_ID_LABEL -> KubernetesTestConf.APP_ID,
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)
SPARK_RESOURCE_PROFILE_ID_LABEL -> DEFAULT_RESOURCE_PROFILE_ID.toString) ++
CUSTOM_LABELS.map {
case (k, v) => (k, Utils.substituteAppNExecIds(v, conf.appId, EXECUTOR_ID))
})
assert(conf.annotations === CUSTOM_ANNOTATIONS.map {
case (k, v) => (k, Utils.substituteAppNExecIds(v, conf.appId, EXECUTOR_ID))
})
Expand Down
11 changes: 7 additions & 4 deletions ...ore/src/test/scala/org/apache/spark/deploy/k8s/features/BasicDriverFeatureStepSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,13 @@ import org.apache.spark.util.Utils

class BasicDriverFeatureStepSuite extends SparkFunSuite {

private val CUSTOM_DRIVER_LABELS = Map("labelkey" -> "labelvalue")
private val CUSTOM_DRIVER_LABELS = Map(
"labelkey" -> "labelvalue",
"customAppIdLabelKey" -> "{{APP_ID}}")
private val CONTAINER_IMAGE_PULL_POLICY = "IfNotPresent"
private val DRIVER_ANNOTATIONS = Map(
"customAnnotation" -> "customAnnotationValue",
"yunikorn.apache.org/app-id" -> "{{APPID}}")
"customAppIdAnnotation" -> "{{APP_ID}}")
private val DRIVER_ENVS = Map(
"customDriverEnv1" -> "customDriverEnv1Value",
"customDriverEnv2" -> "customDriverEnv2Value")
Expand Down Expand Up @@ -121,10 +123,11 @@ class BasicDriverFeatureStepSuite extends SparkFunSuite {
assert(driverPodMetadata.getName === "spark-driver-pod")

// Check custom and preset labels are as expected
val labels = driverPodMetadata.getLabels
CUSTOM_DRIVER_LABELS.foreach { case (k, v) =>
assert(driverPodMetadata.getLabels.get(k) === v)
assert(labels.get(k) === Utils.substituteAppNExecIds(v, KubernetesTestConf.APP_ID, ""))
}
assert(driverPodMetadata.getLabels === kubernetesConf.labels.asJava)
assert(labels === kubernetesConf.labels.asJava)

val annotations = driverPodMetadata.getAnnotations.asScala
DRIVER_ANNOTATIONS.foreach { case (k, v) =>
Expand Down
6 changes: 4 additions & 2 deletions ...on-tests/src/test/scala/org/apache/spark/deploy/k8s/integrationtest/BasicTestsSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,16 +102,18 @@ private[spark] trait BasicTestsSuite { k8sSuite: KubernetesSuite =>
sparkAppConf
.set("spark.kubernetes.driver.label.label1", "label1-value")
.set("spark.kubernetes.driver.label.label2", "label2-value")
.set("spark.kubernetes.driver.label.customAppIdLabelKey", "{{APP_ID}}")
.set("spark.kubernetes.driver.annotation.annotation1", "annotation1-value")
.set("spark.kubernetes.driver.annotation.annotation2", "annotation2-value")
.set("spark.kubernetes.driver.annotation.yunikorn.apache.org/app-id", "{{APP_ID}}")
.set("spark.kubernetes.driver.annotation.customAppIdAnnotation", "{{APP_ID}}")
.set("spark.kubernetes.driverEnv.ENV1", "VALUE1")
.set("spark.kubernetes.driverEnv.ENV2", "VALUE2")
.set("spark.kubernetes.executor.label.label1", "label1-value")
.set("spark.kubernetes.executor.label.label2", "label2-value")
.set("spark.kubernetes.executor.label.customAppIdLabelKey", "{{APP_ID}}")
.set("spark.kubernetes.executor.annotation.annotation1", "annotation1-value")
.set("spark.kubernetes.executor.annotation.annotation2", "annotation2-value")
.set("spark.kubernetes.executor.annotation.yunikorn.apache.org/app-id", "{{APP_ID}}")
.set("spark.kubernetes.executor.annotation.customAppIdAnnotation", "{{APP_ID}}")
.set("spark.executorEnv.ENV1", "VALUE1")
.set("spark.executorEnv.ENV2", "VALUE2")

Expand Down
6 changes: 4 additions & 2 deletions ...on-tests/src/test/scala/org/apache/spark/deploy/k8s/integrationtest/KubernetesSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,8 @@ class KubernetesSuite extends SparkFunSuite
assert(pod.getMetadata.getLabels.get("label2") === "label2-value")
assert(pod.getMetadata.getAnnotations.get("annotation1") === "annotation1-value")
assert(pod.getMetadata.getAnnotations.get("annotation2") === "annotation2-value")
val appId = pod.getMetadata.getAnnotations.get("yunikorn.apache.org/app-id")
val appIdLabel = pod.getMetadata.getLabels.get("customAppIdLabelKey")
val appIdAnnotation = pod.getMetadata.getAnnotations.get("customAppIdAnnotation")

val container = pod.getSpec.getContainers.get(0)
val envVars = container
Expand All @@ -601,7 +602,8 @@ class KubernetesSuite extends SparkFunSuite
.toMap
assert(envVars("ENV1") === "VALUE1")
assert(envVars("ENV2") === "VALUE2")
assert(appId === envVars(ENV_APPLICATION_ID))
assert(appIdLabel === envVars(ENV_APPLICATION_ID))
assert(appIdAnnotation === envVars(ENV_APPLICATION_ID))
}

private def deleteDriverPod(): Unit = {
Expand Down