[SPARK-25815][k8s] Support kerberos in client mode, keytab-based token renewal. #22911
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.spark.deploy.k8s.features | ||
|
|
||
| import io.fabric8.kubernetes.api.model.{ContainerBuilder, HasMetadata, PodBuilder, SecretBuilder} | ||
| import org.apache.commons.codec.binary.Base64 | ||
| import org.apache.hadoop.security.UserGroupInformation | ||
|
|
||
| import org.apache.spark.deploy.SparkHadoopUtil | ||
| import org.apache.spark.deploy.k8s.{KubernetesConf, KubernetesUtils, SparkPod} | ||
| import org.apache.spark.deploy.k8s.Config._ | ||
| import org.apache.spark.deploy.k8s.Constants._ | ||
| import org.apache.spark.deploy.security.HadoopDelegationTokenManager | ||
| import org.apache.spark.internal.config._ | ||
|
|
||
| /** | ||
| * Delegation token support for Spark apps on kubernetes. | ||
| * | ||
| * When preparing driver resources, this step will generate delegation tokens for the app if | ||
| * they're needed. | ||
| * | ||
| * When preparing pods, this step will mount the delegation token secret (either pre-defined, | ||
| * or generated by this step when preparing the driver). | ||
| */ | ||
| private[spark] class DelegationTokenFeatureStep(conf: KubernetesConf[_], isDriver: Boolean) | ||
|
There was a problem hiding this comment. During the recent discussion in the sig meeting I was thinking about this guy. I think it may not be necessary to mount this secret in executors, and let the driver propagate the tokens to executors through its normal means. e.g. later if/when adding code to monitor delegation tokens for updates, that would mean only the driver has to do it. I'll git this a try; if it works, it might be feasible to re-merge this code with the kerberos step. There was a problem hiding this comment. This is what I meant above when I said that the There was a problem hiding this comment. I think you're missing one use case there. There are 3 use cases:
The third use case is actually the most common. In your reply above you're only covering the other two. My code covers all three. I'm just saying that this code actually doesn't need to do anything on the executor side, because the driver takes care of everything when the credentials are provided. |
||
| extends KubernetesFeatureConfigStep { | ||
|
|
||
| private val existingSecret = conf.get(KUBERNETES_KERBEROS_DT_SECRET_NAME) | ||
| private val existingItemKey = conf.get(KUBERNETES_KERBEROS_DT_SECRET_ITEM_KEY) | ||
| private val shouldCreateTokens = isDriver && !conf.sparkConf.contains(KEYTAB) && | ||
| existingSecret.isEmpty && isSecurityEnabled | ||
|
|
||
| KubernetesUtils.requireBothOrNeitherDefined( | ||
| existingSecret, | ||
| existingItemKey, | ||
| "If a secret data item-key where the data of the Kerberos Delegation Token is specified" + | ||
| " you must also specify the name of the secret", | ||
| "If a secret storing a Kerberos Delegation Token is specified you must also" + | ||
| " specify the item-key where the data is stored") | ||
|
|
||
| private def dtSecretName: String = s"${conf.appResourceNamePrefix}-delegation-tokens" | ||
|
|
||
| override def configurePod(pod: SparkPod): SparkPod = { | ||
| pod.transform { case pod if shouldCreateTokens | existingSecret.isDefined => | ||
| val secretName = existingSecret.getOrElse(dtSecretName) | ||
| val itemKey = existingItemKey.getOrElse(KERBEROS_SECRET_KEY) | ||
|
|
||
| val podWithTokens = new PodBuilder(pod.pod) | ||
| .editOrNewSpec() | ||
| .addNewVolume() | ||
| .withName(SPARK_APP_HADOOP_SECRET_VOLUME_NAME) | ||
| .withNewSecret() | ||
| .withSecretName(secretName) | ||
| .endSecret() | ||
| .endVolume() | ||
| .endSpec() | ||
| .build() | ||
|
|
||
| val containerWithTokens = new ContainerBuilder(pod.container) | ||
| .addNewVolumeMount() | ||
| .withName(SPARK_APP_HADOOP_SECRET_VOLUME_NAME) | ||
| .withMountPath(SPARK_APP_HADOOP_CREDENTIALS_BASE_DIR) | ||
| .endVolumeMount() | ||
| .addNewEnv() | ||
| .withName(ENV_HADOOP_TOKEN_FILE_LOCATION) | ||
| .withValue(s"$SPARK_APP_HADOOP_CREDENTIALS_BASE_DIR/$itemKey") | ||
| .endEnv() | ||
| .build() | ||
|
|
||
| SparkPod(podWithTokens, containerWithTokens) | ||
| } | ||
| } | ||
|
|
||
| override def getAdditionalKubernetesResources(): Seq[HasMetadata] = { | ||
| if (shouldCreateTokens) { | ||
| val tokenData = createDelegationTokens() | ||
| Seq(new SecretBuilder() | ||
| .withNewMetadata() | ||
| .withName(dtSecretName) | ||
| .endMetadata() | ||
| .addToData(KERBEROS_SECRET_KEY, Base64.encodeBase64String(tokenData)) | ||
| .build()) | ||
| } else { | ||
| Nil | ||
| } | ||
| } | ||
|
|
||
| // Visible for testing. | ||
| def isSecurityEnabled: Boolean = UserGroupInformation.isSecurityEnabled() | ||
|
|
||
| // Visible for testing. | ||
| def createDelegationTokens(): Array[Byte] = { | ||
| val tokenManager = new HadoopDelegationTokenManager(conf.sparkConf, | ||
| SparkHadoopUtil.get.newConfiguration(conf.sparkConf)) | ||
| val creds = UserGroupInformation.getCurrentUser().getCredentials() | ||
| tokenManager.obtainDelegationTokens(creds) | ||
| SparkHadoopUtil.get.serialize(creds) | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this because I started to get tired of code like the following:
To me that's hard to follow and brittle, and this pattern makes things clearer IMO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would think that this change is out of the scope of this PR, but I do love the use of a PartialFunction here. Thanks for this!