Packages

o

org.apache.spark.deploy.k8s

KubernetesUtils

object KubernetesUtils extends Logging

:: DeveloperApi ::

A utility class used for K8s operations internally and for implementing ExternalClusterManagers.

Annotations
@Unstable() @DeveloperApi()
Linear Supertypes
Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KubernetesUtils
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addOwnerReference(pod: Pod, resources: Seq[HasMetadata]): Unit
    Annotations
    @Since("3.1.1")
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def buildPodWithServiceAccount(serviceAccount: Option[String], pod: SparkPod): Option[Pod]
    Annotations
    @Since("3.0.0")
  7. def buildResourcesQuantities(componentName: String, sparkConf: SparkConf): Map[String, Quantity]

    This function builds the Quantity objects for each resource in the Spark resource configs based on the component name(spark.driver.resource or spark.executor.resource).

    This function builds the Quantity objects for each resource in the Spark resource configs based on the component name(spark.driver.resource or spark.executor.resource). It assumes we can use the Kubernetes device plugin format: vendor-domain/resource. It returns a set with a tuple of vendor-domain/resource and Quantity for each resource.

    Annotations
    @Since("3.0.0")
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def containerStatusDescription(containerStatus: ContainerStatus): Seq[(String, String)]
    Annotations
    @Since("3.0.0")
  10. def containersDescription(p: Pod, indent: Int = 1): String
    Annotations
    @Since("3.0.0")
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. def formatPairsBundle(pairs: Seq[(String, String)], indent: Int = 1): String
    Annotations
    @Since("3.0.0")
  15. def formatPodState(pod: Pod): String

    Given a pod, output a human readable representation of its state

    Given a pod, output a human readable representation of its state

    pod

    Pod

    returns

    Human readable pod state

    Annotations
    @Since("3.0.0")
  16. def formatTime(time: String): String
    Annotations
    @Since("3.0.0")
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  20. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isLocalAndResolvable(resource: String): Boolean
    Annotations
    @Since("3.0.0")
  23. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  24. def loadPodFromTemplate(kubernetesClient: KubernetesClient, templateFileName: String, containerName: Option[String], conf: SparkConf): SparkPod
    Annotations
    @Since("3.2.0")
  25. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  26. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  28. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  33. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. def parseMasterUrl(url: String): String
    Annotations
    @Since("2.4.0")
  41. def parsePrefixedKeyValuePairs(sparkConf: SparkConf, prefix: String): Map[String, String]

    Extract and parse Spark configuration properties with a given name prefix and return the result as a Map.

    Extract and parse Spark configuration properties with a given name prefix and return the result as a Map. Keys must not have more than one value.

    sparkConf

    Spark configuration

    prefix

    the given property name prefix

    returns

    a Map storing the configuration property keys and values

    Annotations
    @Since("2.3.0")
  42. def renameMainAppResource(resource: String, conf: Option[SparkConf] = None, shouldUploadLocal: Boolean): String
    Annotations
    @Since("3.1.1")
  43. def requireBothOrNeitherDefined(opt1: Option[_], opt2: Option[_], errMessageWhenFirstIsMissing: String, errMessageWhenSecondIsMissing: String): Unit
    Annotations
    @Since("3.0.0")
  44. def requireNandDefined(opt1: Option[_], opt2: Option[_], errMessage: String): Unit
    Annotations
    @Since("2.3.0")
  45. def requireSecondIfFirstIsDefined(opt1: Option[_], opt2: Option[_], errMessageWhenSecondIsMissing: String): Unit
    Annotations
    @Since("3.0.0")
  46. def selectSparkContainer(pod: Pod, containerName: Option[String]): SparkPod
    Annotations
    @Since("3.0.0")
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toString(): String
    Definition Classes
    AnyRef → Any
  49. def uniqueID(clock: Clock = systemClock): String

    Generates a unique ID to be used as part of identifiers.

    Generates a unique ID to be used as part of identifiers. The returned ID is a hex string of a 64-bit value containing the 40 LSBs from the current time + 24 random bits from a cryptographically strong RNG. (40 bits gives about 30 years worth of "unique" timestamps.)

    This avoids using a UUID for uniqueness (too long), and relying solely on the current time (not unique enough).

    Annotations
    @Since("3.0.0")
  50. def uploadAndTransformFileUris(fileUris: Iterable[String], conf: Option[SparkConf] = None): Iterable[String]

    Upload files and modify their uris

    Upload files and modify their uris

    Annotations
    @Since("3.0.0")
  51. def uploadFileUri(uri: String, conf: Option[SparkConf] = None): String
    Annotations
    @Since("3.0.0")
  52. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped