[SPARK-23529][K8s] Support mounting volumes #21260
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * 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 | ||
|
|
||
| private[spark] sealed trait KubernetesVolumeSpecificConf | ||
| private[spark] case class KubernetesHostPathVolumeConf( | ||
| hostPath: String) extends KubernetesVolumeSpecificConf | ||
| private[spark] case class KubernetesPVCVolumeConf( | ||
| claimName: String) extends KubernetesVolumeSpecificConf | ||
| private[spark] case class KubernetesEmptyDirVolumeConf( | ||
| medium: String, | ||
| sizeLimit: String) extends KubernetesVolumeSpecificConf | ||
|
|
||
| private[spark] case class KubernetesVolumeSpec[T <: KubernetesVolumeSpecificConf]( | ||
| volumeName: String, | ||
| mountPath: String, | ||
| mountReadOnly: Boolean, | ||
| volumeConf: T) |
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 | ||
|
|
||
| import java.util.NoSuchElementException | ||
|
|
||
| import scala.util.{Failure, Success, Try} | ||
|
|
||
| import org.apache.spark.SparkConf | ||
| import org.apache.spark.deploy.k8s.Config._ | ||
|
|
||
| private[spark] object KubernetesVolumeUtils { | ||
| /** | ||
| * Extract Spark volume configuration properties with a given name prefix. | ||
| * | ||
| * @param sparkConf Spark configuration | ||
| * @param prefix the given property name prefix | ||
| * @return a Map storing with volume name as key and spec as value | ||
| */ | ||
| def parseVolumesWithPrefix( | ||
|
||
| sparkConf: SparkConf, | ||
| prefix: String): Iterable[Try[KubernetesVolumeSpec[_ <: KubernetesVolumeSpecificConf]]] = { | ||
| val properties = sparkConf.getAllWithPrefix(prefix).toMap | ||
|
|
||
| getVolumeTypesAndNames(properties).map { case (volumeType, volumeName) => | ||
| val pathKey = s"$volumeType.$volumeName.$KUBERNETES_VOLUMES_MOUNT_PATH_KEY" | ||
| val readOnlyKey = s"$volumeType.$volumeName.$KUBERNETES_VOLUMES_MOUNT_READONLY_KEY" | ||
|
|
||
| for { | ||
| path <- properties.getTry(pathKey) | ||
| readOnly <- properties.getTry(readOnlyKey) | ||
|
||
| volumeConf <- parseVolumeSpecificConf(properties, volumeType, volumeName) | ||
| } yield KubernetesVolumeSpec( | ||
| volumeName = volumeName, | ||
| mountPath = path, | ||
| mountReadOnly = readOnly.toBoolean, | ||
| volumeConf = volumeConf | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get unique pairs of volumeType and volumeName, | ||
| * assuming options are formatted in this way: | ||
| * `volumeType`.`volumeName`.`property` = `value` | ||
| * @param properties flat mapping of property names to values | ||
| * @return Set[(volumeType, volumeName)] | ||
| */ | ||
| private def getVolumeTypesAndNames( | ||
| properties: Map[String, String] | ||
| ): Set[(String, String)] = { | ||
| properties.keys.flatMap { k => | ||
| k.split('.').toList match { | ||
| case tpe :: name :: _ => Some((tpe, name)) | ||
| case _ => None | ||
| } | ||
| }.toSet | ||
| } | ||
|
|
||
| private def parseVolumeSpecificConf( | ||
| options: Map[String, String], | ||
| volumeType: String, | ||
| volumeName: String): Try[KubernetesVolumeSpecificConf] = { | ||
| volumeType match { | ||
| case KUBERNETES_VOLUMES_HOSTPATH_TYPE => | ||
| val pathKey = s"$volumeType.$volumeName.$KUBERNETES_VOLUMES_OPTIONS_PATH_KEY" | ||
| for { | ||
| path <- options.getTry(pathKey) | ||
| } yield KubernetesHostPathVolumeConf(path) | ||
|
|
||
| case KUBERNETES_VOLUMES_PVC_TYPE => | ||
| val claimNameKey = s"$volumeType.$volumeName.$KUBERNETES_VOLUMES_OPTIONS_CLAIM_NAME_KEY" | ||
| for { | ||
| claimName <- options.getTry(claimNameKey) | ||
| } yield KubernetesPVCVolumeConf(claimName) | ||
|
|
||
| case KUBERNETES_VOLUMES_EMPTYDIR_TYPE => | ||
| val mediumKey = s"$volumeType.$volumeName.$KUBERNETES_VOLUMES_OPTIONS_MEDIUM_KEY" | ||
| val sizeLimitKey = s"$volumeType.$volumeName.$KUBERNETES_VOLUMES_OPTIONS_SIZE_LIMIT_KEY" | ||
| for { | ||
| medium <- options.getTry(mediumKey) | ||
| sizeLimit <- options.getTry(sizeLimitKey) | ||
|
||
| } yield KubernetesEmptyDirVolumeConf(medium, sizeLimit) | ||
|
|
||
| case _ => | ||
| Failure(new RuntimeException(s"Kubernetes Volume type `$volumeType` is not supported")) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Convenience wrapper to accumulate key lookup errors | ||
| */ | ||
| implicit private class MapOps[A, B](m: Map[A, B]) { | ||
| def getTry(key: A): Try[B] = { | ||
| m | ||
| .get(key) | ||
| .fold[Try[B]](Failure(new NoSuchElementException(key.toString)))(Success(_)) | ||
| } | ||
| } | ||
| } | ||
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
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.
It's worth mentioning that
VolumeTypeshould be a type supported by Kubernetes and use the same type names as those used by Kubernetes.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.
This is mentioned higher up in documentation. I'm not sure if it should be repeated: