aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/scala/org/apache/spark/scheduler/cluster/mesos/MesosSchedulerBackendUtil.scala
blob: 3fe06743b8809c0429ab136fc0fd949bcf528054 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
 * 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.scheduler.cluster.mesos

import org.apache.mesos.Protos.{ContainerInfo, Image, Volume}
import org.apache.mesos.Protos.ContainerInfo.DockerInfo

import org.apache.spark.{SparkConf, SparkException}
import org.apache.spark.internal.Logging

/**
 * A collection of utility functions which can be used by both the
 * MesosSchedulerBackend and the [[MesosFineGrainedSchedulerBackend]].
 */
private[mesos] object MesosSchedulerBackendUtil extends Logging {
  /**
   * Parse a comma-delimited list of volume specs, each of which
   * takes the form [host-dir:]container-dir[:rw|:ro].
   */
  def parseVolumesSpec(volumes: String): List[Volume] = {
    volumes.split(",").map(_.split(":")).flatMap { spec =>
        val vol: Volume.Builder = Volume
          .newBuilder()
          .setMode(Volume.Mode.RW)
        spec match {
          case Array(container_path) =>
            Some(vol.setContainerPath(container_path))
          case Array(container_path, "rw") =>
            Some(vol.setContainerPath(container_path))
          case Array(container_path, "ro") =>
            Some(vol.setContainerPath(container_path)
              .setMode(Volume.Mode.RO))
          case Array(host_path, container_path) =>
            Some(vol.setContainerPath(container_path)
              .setHostPath(host_path))
          case Array(host_path, container_path, "rw") =>
            Some(vol.setContainerPath(container_path)
              .setHostPath(host_path))
          case Array(host_path, container_path, "ro") =>
            Some(vol.setContainerPath(container_path)
              .setHostPath(host_path)
              .setMode(Volume.Mode.RO))
          case spec =>
            logWarning(s"Unable to parse volume specs: $volumes. "
              + "Expected form: \"[host-dir:]container-dir[:rw|:ro](, ...)\"")
            None
      }
    }
    .map { _.build() }
    .toList
  }

  /**
   * Parse a comma-delimited list of port mapping specs, each of which
   * takes the form host_port:container_port[:udp|:tcp]
   *
   * Note:
   * the docker form is [ip:]host_port:container_port, but the DockerInfo
   * message has no field for 'ip', and instead has a 'protocol' field.
   * Docker itself only appears to support TCP, so this alternative form
   * anticipates the expansion of the docker form to allow for a protocol
   * and leaves open the chance for mesos to begin to accept an 'ip' field
   */
  def parsePortMappingsSpec(portmaps: String): List[DockerInfo.PortMapping] = {
    portmaps.split(",").map(_.split(":")).flatMap { spec: Array[String] =>
      val portmap: DockerInfo.PortMapping.Builder = DockerInfo.PortMapping
        .newBuilder()
        .setProtocol("tcp")
      spec match {
        case Array(host_port, container_port) =>
          Some(portmap.setHostPort(host_port.toInt)
            .setContainerPort(container_port.toInt))
        case Array(host_port, container_port, protocol) =>
          Some(portmap.setHostPort(host_port.toInt)
            .setContainerPort(container_port.toInt)
            .setProtocol(protocol))
        case spec =>
          logWarning(s"Unable to parse port mapping specs: $portmaps. "
            + "Expected form: \"host_port:container_port[:udp|:tcp](, ...)\"")
          None
      }
    }
    .map { _.build() }
    .toList
  }

  /**
   * Construct a DockerInfo structure and insert it into a ContainerInfo
   */
  def addDockerInfo(
      container: ContainerInfo.Builder,
      image: String,
      containerizer: String,
      forcePullImage: Boolean = false,
      volumes: Option[List[Volume]] = None,
      portmaps: Option[List[ContainerInfo.DockerInfo.PortMapping]] = None): Unit = {

    containerizer match {
      case "docker" =>
        container.setType(ContainerInfo.Type.DOCKER)
        val docker = ContainerInfo.DockerInfo.newBuilder()
          .setImage(image)
          .setForcePullImage(forcePullImage)
        // TODO (mgummelt): Remove this. Portmaps have no effect,
        //                  as we don't support bridge networking.
        portmaps.foreach(_.foreach(docker.addPortMappings))
        container.setDocker(docker)
      case "mesos" =>
        container.setType(ContainerInfo.Type.MESOS)
        val imageProto = Image.newBuilder()
          .setType(Image.Type.DOCKER)
          .setDocker(Image.Docker.newBuilder().setName(image))
          .setCached(!forcePullImage)
        container.setMesos(ContainerInfo.MesosInfo.newBuilder().setImage(imageProto))
      case _ =>
        throw new SparkException(
          "spark.mesos.containerizer must be one of {\"docker\", \"mesos\"}")
    }

    volumes.foreach(_.foreach(container.addVolumes))
  }

  /**
   * Setup a docker containerizer from MesosDriverDescription scheduler properties
   */
  def setupContainerBuilderDockerInfo(
    imageName: String,
    conf: SparkConf,
    builder: ContainerInfo.Builder): Unit = {
    val forcePullImage = conf
      .getOption("spark.mesos.executor.docker.forcePullImage")
      .exists(_.equals("true"))
    val volumes = conf
      .getOption("spark.mesos.executor.docker.volumes")
      .map(parseVolumesSpec)
    val portmaps = conf
      .getOption("spark.mesos.executor.docker.portmaps")
      .map(parsePortMappingsSpec)

    val containerizer = conf.get("spark.mesos.containerizer", "docker")
    addDockerInfo(
      builder,
      imageName,
      containerizer,
      forcePullImage = forcePullImage,
      volumes = volumes,
      portmaps = portmaps)
    logDebug("setupContainerDockerInfo: using docker image: " + imageName)
  }
}