|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + * contributor license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright ownership. |
| 5 | + * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + * (the "License"); you may not use this file except in compliance with |
| 7 | + * the License. You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | +package org.apache.spark.deploy.kubernetes.submit.v2 |
| 18 | + |
| 19 | +import io.fabric8.kubernetes.api.model.{PodBuilder, Secret, SecretBuilder} |
| 20 | +import scala.collection.JavaConverters._ |
| 21 | + |
| 22 | +import org.apache.spark.SparkConf |
| 23 | +import org.apache.spark.deploy.kubernetes.KubernetesCredentials |
| 24 | +import org.apache.spark.deploy.kubernetes.config._ |
| 25 | +import org.apache.spark.deploy.kubernetes.constants._ |
| 26 | +import org.apache.spark.internal.config.OptionalConfigEntry |
| 27 | + |
| 28 | +private[spark] trait DriverPodKubernetesCredentialsMounter { |
| 29 | + |
| 30 | + /** |
| 31 | + * Set fields on the Spark configuration that indicate where the driver pod is |
| 32 | + * to find its Kubernetes credentials for requesting executors. |
| 33 | + */ |
| 34 | + def setDriverPodKubernetesCredentialLocations(sparkConf: SparkConf): SparkConf |
| 35 | + |
| 36 | + /** |
| 37 | + * Create the Kubernetes secret object that correspond to the driver's credentials |
| 38 | + * that have to be created and mounted into the driver pod. The single Secret |
| 39 | + * object contains all of the data entries for the driver pod's Kubernetes |
| 40 | + * credentials. Returns empty if no secrets are to be mounted. |
| 41 | + */ |
| 42 | + def createCredentialsSecret(): Option[Secret] |
| 43 | + |
| 44 | + /** |
| 45 | + * Mount any Kubernetes credentials from the submitting machine's disk into the |
| 46 | + * driver pod. |
| 47 | + */ |
| 48 | + def mountDriverKubernetesCredentials( |
| 49 | + originalPodSpec: PodBuilder, |
| 50 | + driverContainerName: String, |
| 51 | + credentialsSecret: Option[Secret]): PodBuilder |
| 52 | +} |
| 53 | + |
| 54 | +private[spark] class DriverPodKubernetesCredentialsMounterImpl( |
| 55 | + kubernetesAppId: String, |
| 56 | + submitterLocalDriverPodKubernetesCredentials: KubernetesCredentials, |
| 57 | + maybeUserSpecifiedMountedClientKeyFile: Option[String], |
| 58 | + maybeUserSpecifiedMountedClientCertFile: Option[String], |
| 59 | + maybeUserSpecifiedMountedOAuthTokenFile: Option[String], |
| 60 | + maybeUserSpecifiedMountedCaCertFile: Option[String]) |
| 61 | + extends DriverPodKubernetesCredentialsMounter { |
| 62 | + |
| 63 | + override def setDriverPodKubernetesCredentialLocations(sparkConf: SparkConf): SparkConf = { |
| 64 | + val resolvedMountedClientKeyFile = resolveSecretLocation( |
| 65 | + maybeUserSpecifiedMountedClientKeyFile, |
| 66 | + submitterLocalDriverPodKubernetesCredentials.clientKeyDataBase64, |
| 67 | + DRIVER_CREDENTIALS_CLIENT_KEY_PATH) |
| 68 | + val resolvedMountedClientCertFile = resolveSecretLocation( |
| 69 | + maybeUserSpecifiedMountedClientCertFile, |
| 70 | + submitterLocalDriverPodKubernetesCredentials.clientCertDataBase64, |
| 71 | + DRIVER_CREDENTIALS_CLIENT_CERT_PATH) |
| 72 | + val resolvedMountedCaCertFile = resolveSecretLocation( |
| 73 | + maybeUserSpecifiedMountedCaCertFile, |
| 74 | + submitterLocalDriverPodKubernetesCredentials.caCertDataBase64, |
| 75 | + DRIVER_CREDENTIALS_CA_CERT_PATH) |
| 76 | + val resolvedMountedOAuthTokenFile = resolveSecretLocation( |
| 77 | + maybeUserSpecifiedMountedOAuthTokenFile, |
| 78 | + submitterLocalDriverPodKubernetesCredentials.oauthTokenBase64, |
| 79 | + DRIVER_CREDENTIALS_OAUTH_TOKEN_PATH) |
| 80 | + val sparkConfWithCredentialLocations = sparkConf.clone() |
| 81 | + .setOption(KUBERNETES_DRIVER_MOUNTED_CA_CERT_FILE, resolvedMountedCaCertFile) |
| 82 | + .setOption(KUBERNETES_DRIVER_MOUNTED_CLIENT_KEY_FILE, resolvedMountedClientKeyFile) |
| 83 | + .setOption(KUBERNETES_DRIVER_MOUNTED_CLIENT_CERT_FILE, resolvedMountedClientCertFile) |
| 84 | + .setOption(KUBERNETES_DRIVER_MOUNTED_OAUTH_TOKEN, resolvedMountedOAuthTokenFile) |
| 85 | + sparkConfWithCredentialLocations.get(KUBERNETES_DRIVER_OAUTH_TOKEN).foreach { _ => |
| 86 | + sparkConfWithCredentialLocations.set(KUBERNETES_DRIVER_OAUTH_TOKEN, "<present_but_redacted>") |
| 87 | + } |
| 88 | + sparkConfWithCredentialLocations.get(KUBERNETES_SUBMIT_OAUTH_TOKEN).foreach { _ => |
| 89 | + sparkConfWithCredentialLocations.set(KUBERNETES_SUBMIT_OAUTH_TOKEN, "<present_but_redacted>") |
| 90 | + } |
| 91 | + sparkConfWithCredentialLocations |
| 92 | + } |
| 93 | + |
| 94 | + override def createCredentialsSecret(): Option[Secret] = { |
| 95 | + val allSecretData = resolveSecretData( |
| 96 | + maybeUserSpecifiedMountedClientKeyFile, |
| 97 | + submitterLocalDriverPodKubernetesCredentials.clientKeyDataBase64, |
| 98 | + DRIVER_CREDENTIALS_CLIENT_KEY_SECRET_NAME) ++ |
| 99 | + resolveSecretData( |
| 100 | + maybeUserSpecifiedMountedClientCertFile, |
| 101 | + submitterLocalDriverPodKubernetesCredentials.clientCertDataBase64, |
| 102 | + DRIVER_CREDENTIALS_CLIENT_CERT_SECRET_NAME) ++ |
| 103 | + resolveSecretData( |
| 104 | + maybeUserSpecifiedMountedCaCertFile, |
| 105 | + submitterLocalDriverPodKubernetesCredentials.caCertDataBase64, |
| 106 | + DRIVER_CREDENTIALS_CA_CERT_SECRET_NAME) ++ |
| 107 | + resolveSecretData( |
| 108 | + maybeUserSpecifiedMountedOAuthTokenFile, |
| 109 | + submitterLocalDriverPodKubernetesCredentials.oauthTokenBase64, |
| 110 | + DRIVER_CREDENTIALS_OAUTH_TOKEN_SECRET_NAME) |
| 111 | + if (allSecretData.isEmpty) { |
| 112 | + None |
| 113 | + } else { |
| 114 | + Some(new SecretBuilder() |
| 115 | + .withNewMetadata().withName(s"$kubernetesAppId-kubernetes-credentials").endMetadata() |
| 116 | + .withData(allSecretData.asJava) |
| 117 | + .build()) |
| 118 | + } |
| 119 | + } |
| 120 | + |
| 121 | + override def mountDriverKubernetesCredentials( |
| 122 | + originalPodSpec: PodBuilder, |
| 123 | + driverContainerName: String, |
| 124 | + credentialsSecret: Option[Secret]): PodBuilder = { |
| 125 | + credentialsSecret.map { secret => |
| 126 | + originalPodSpec.editSpec() |
| 127 | + .addNewVolume() |
| 128 | + .withName(DRIVER_CREDENTIALS_SECRET_VOLUME_NAME) |
| 129 | + .withNewSecret().withSecretName(secret.getMetadata.getName).endSecret() |
| 130 | + .endVolume() |
| 131 | + .editMatchingContainer(new ContainerNameEqualityPredicate(driverContainerName)) |
| 132 | + .addNewVolumeMount() |
| 133 | + .withName(DRIVER_CREDENTIALS_SECRET_VOLUME_NAME) |
| 134 | + .withMountPath(DRIVER_CREDENTIALS_SECRETS_BASE_DIR) |
| 135 | + .endVolumeMount() |
| 136 | + .endContainer() |
| 137 | + .endSpec() |
| 138 | + }.getOrElse(originalPodSpec) |
| 139 | + } |
| 140 | + |
| 141 | + private def resolveSecretLocation( |
| 142 | + mountedUserSpecified: Option[String], |
| 143 | + valueMountedFromSubmitter: Option[String], |
| 144 | + mountedCanonicalLocation: String): Option[String] = { |
| 145 | + mountedUserSpecified.orElse(valueMountedFromSubmitter.map( _ => { |
| 146 | + mountedCanonicalLocation |
| 147 | + })) |
| 148 | + } |
| 149 | + |
| 150 | + private def resolveSecretData( |
| 151 | + mountedUserSpecified: Option[String], |
| 152 | + valueMountedFromSubmitter: Option[String], |
| 153 | + secretName: String): Map[String, String] = { |
| 154 | + mountedUserSpecified.map { _ => Map.empty[String, String]} |
| 155 | + .getOrElse { |
| 156 | + valueMountedFromSubmitter.map { valueBase64 => |
| 157 | + Map(secretName -> valueBase64) |
| 158 | + }.getOrElse(Map.empty[String, String]) |
| 159 | + } |
| 160 | + } |
| 161 | + |
| 162 | + private implicit def augmentSparkConf(sparkConf: SparkConf): OptionSettableSparkConf = { |
| 163 | + new OptionSettableSparkConf(sparkConf) |
| 164 | + } |
| 165 | +} |
| 166 | + |
| 167 | +private class OptionSettableSparkConf(sparkConf: SparkConf) { |
| 168 | + def setOption[T](configEntry: OptionalConfigEntry[T], option: Option[T]): SparkConf = { |
| 169 | + option.map( opt => { |
| 170 | + sparkConf.set(configEntry, opt) |
| 171 | + }).getOrElse(sparkConf) |
| 172 | + } |
| 173 | +} |
0 commit comments