PLUGINSPLUGIN-SPARKTASKSIO.KESTRA.PLUGIN.SPARK.SPARKCLI

​Spark​C​L​I

SparkCLI SparkCLI

yaml
type: "io.kestra.plugin.spark.SparkCLI"

Execute spark CLI commands.

Examples

Submit a Python Spark Job to a master

yaml
id: spark-cli
namespace: dev
tasks:
  - id: workingDirectory
    type: io.kestra.core.tasks.flows.WorkingDirectory
    tasks:
    - id: local-file
      type: io.kestra.core.tasks.storages.LocalFiles
      inputs:
        pi.py: |
          import sys
          from random import random
          from operator import add
          from pyspark.sql import SparkSession


          if __name__ == "__main__":
              spark = SparkSession \
                  .builder \
                  .appName("PythonPi") \
                  .getOrCreate()

              partitions = int(sys.argv[1]) if len(sys.argv) > 1 else 2
              n = 100000 * partitions

              def f(_: int) -> float:
                  x = random() * 2 - 1
                  y = random() * 2 - 1
                  return 1 if x ** 2 + y ** 2 <= 1 else 0

              count = spark.sparkContext.parallelize(range(1, n + 1), partitions).map(f).reduce(add)
              print("Pi is roughly %f" % (4.0 * count / n))

              spark.stop()
    - id: hello
      type: io.kestra.plugin.spark.SparkCLI
      docker:
        networkMode: host
      commands:
        - spark-submit --name Pi --master spark://localhost:7077 pi.py

Properties

commands

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min items: 1

The list of Spark CLI commands to run

interpreter

  • Type: array
  • SubType: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: [/bin/sh, -c]
  • Min items: 1

Which interpreter to use

runner

  • Type: string
  • Dynamic: ❌
  • Required: ✔️
  • Default: DOCKER
  • Possible Values:
    • PROCESS
    • DOCKER

Runner to use

warningOnStdErr

  • Type: boolean
  • Dynamic: ❌
  • Required: ✔️
  • Default: true

Set the task state to WARNINGif any stdErr is emitted

beforeCommands

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

A list of commands that will run before commands, allowing to set up the environment e.g. pip install -r requirements.txt

docker

  • Type: DockerOptions
  • Dynamic: ❌
  • Required: ❌
  • Default: {image=bitnami/spark, pullPolicy=ALWAYS}

Docker options for the DOCKER runner

env

  • Type: object
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Additional environment variables for the current process.

Outputs

exitCode

  • Type: integer
  • Default: 0

The exit code of the entire Flow Execution

outputFiles

  • Type: object
  • SubType: string

The output files URI in Kestra internal storage

vars

  • Type: object

The value extracted from the output of the executed commands

Definitions

DeviceRequest

capabilities

  • Type: array
  • SubType: array
  • Dynamic: ❌
  • Required: ❌

A list of capabilities; an OR list of AND lists of capabilities.

count

  • Type: integer
  • Dynamic: ❌
  • Required: ❌

A request for devices to be sent to device drivers

deviceIds

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

A request for devices to be sent to device drivers

driver

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

A request for devices to be sent to device drivers

options

  • Type: object
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

Memory

kernelMemory

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See --kernel-memory details.

memory

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of memory resources the container can use.

That is, you must set the value to at least 6 megabytes.

memoryReservation

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Allows you to specify a soft limit smaller than --memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

memorySwap

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The amount of memory this container is allowed to swap to disk

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap is the amount of combined memory and swap that can be used, while memory is only the amount of physical memory that can be used.

memorySwappiness

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The amount of memory this container is allowed to swap to disk

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100, to tune this percentage.

oomKillDisable

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

DockerOptions

image

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Docker image to use

config

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker config file

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json

cpu

  • Type: Cpu
  • Dynamic: ❌
  • Required: ❌

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

deviceRequests

A list of device requests to be sent to device drivers

entryPoint

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Docker entrypoint to use

extraHosts

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Extra hostname mappings to the container network interface configuration

host

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker api uri

memory

  • Type: Memory
  • Dynamic: ❌
  • Required: ❌

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

networkMode

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker network mode to use e.g. host, none, etc.

pullPolicy

  • Type: object
  • Dynamic: ❓
  • Required: ❌

user

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

User within the container

volumes

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

List of volumes to mount

Must be a valid mount expression as string, example : /home/user:/app

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true

Cpu

cpus

  • Type: integer
  • Dynamic: ❌
  • Required: ❌

The maximum amount of CPU resources a container can use.

For instance, if the host machine has two CPUs and you set cpus:"1.5", the container is guaranteed at most one and a half of the CPUs