Package io.kestra.plugin.scripts.runner.docker

Class Docker

java.lang.Object
io.kestra.core.models.tasks.runners.TaskRunner
io.kestra.plugin.scripts.runner.docker.Docker
All Implemented Interfaces:
io.kestra.core.models.Plugin, io.kestra.core.models.WorkerJobLifecycle
@Example(title="Execute a Shell command.",code="id: simple_shell_example\nnamespace: company.team\n\ntasks:\n - id: shell\n type: io.kestra.plugin.scripts.shell.Commands\n taskRunner:\n type: io.kestra.plugin.scripts.runner.docker.Docker\n commands:\n - echo \"Hello World\"",full=true) @Example(title="Pass input files to the task, execute a Shell command, then retrieve output files.",code="id: shell_example_with_files\nnamespace: company.team\n\ninputs:\n - id: file\n type: FILE\n\ntasks:\n - id: shell\n type: io.kestra.plugin.scripts.shell.Commands\n inputFiles:\n data.txt: \"{{ inputs.file }}\"\n outputFiles:\n - \"*.txt\"\n containerImage: centos\n taskRunner:\n type: io.kestra.plugin.scripts.runner.docker.Docker\n commands:\n - cp {{ workingDir }}/data.txt {{ workingDir }}/out.txt",full=true) @Example(title="Run a Python script in Docker and allocate a specific amount of memory.",code="id: allocate_memory_to_python_script\nnamespace: company.team\n\ntasks:\n - id: script\n type: io.kestra.plugin.scripts.python.Script\n taskRunner:\n type: io.kestra.plugin.scripts.runner.docker.Docker\n pullPolicy: IF_NOT_PRESENT\n cpu:\n cpus: 1\n memory: \n memory: \"512Mb\"\n containerImage: ghcr.io/kestra-io/kestrapy:latest\n script: |\n from kestra import Kestra\n \n data = dict(message=\"Hello from Kestra!\")\n Kestra.outputs(data)",full=true) public class Docker extends io.kestra.core.models.tasks.runners.TaskRunner

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Docker.FileHandlingStrategy
     

    Nested classes/interfaces inherited from class io.kestra.core.models.tasks.runners.TaskRunner

    io.kestra.core.models.tasks.runners.TaskRunner.TaskRunnerBuilder<C extends io.kestra.core.models.tasks.runners.TaskRunner,B extends io.kestra.core.models.tasks.runners.TaskRunner.TaskRunnerBuilder<C,B>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected Cpu
    cpu
     
    protected List<DeviceRequest>
    deviceRequests
     
    protected List<String>
    entryPoint
     
    protected List<String>
    extraHosts
     
    protected String
    image
     
    protected Memory
    memory
     
    protected String
    networkMode
     
    protected PullPolicy
    pullPolicy
     
    protected String
    user
     
    protected List<String>
    volumes
     

    Fields inherited from class io.kestra.core.models.tasks.runners.TaskRunner

    type

  • Constructor Summary

    Constructors
    Constructor
    Description
    Docker()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Docker
    from(DockerOptions dockerOptions)
     
    static Docker
    instance()
    Convenient default instance to be used as task default value for a 'taskRunner' property.
    io.kestra.core.models.tasks.runners.RunnerResult
    run(io.kestra.core.runners.RunContext runContext, io.kestra.core.models.tasks.runners.TaskCommands taskCommands, List<String> filesToDownload)
     
    Map<String,Object>
    runnerAdditionalVars(io.kestra.core.runners.RunContext runContext, io.kestra.core.models.tasks.runners.TaskCommands taskCommands)
     

    Methods inherited from class io.kestra.core.models.tasks.runners.TaskRunner

    additionalVars, env, getIsKilled, getType, kill, onKill, runnerEnv, toAbsolutePath

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface io.kestra.core.models.WorkerJobLifecycle

    stop

  • Field Details

    • image

      protected String image

    • user

      @PluginProperty(dynamic=true) protected String user

    • entryPoint

      @PluginProperty(dynamic=true) protected List<String> entryPoint

    • extraHosts

      @PluginProperty(dynamic=true) protected List<String> extraHosts

    • networkMode

      @PluginProperty(dynamic=true) protected String networkMode

    • volumes

      @PluginProperty(dynamic=true) protected List<String> volumes

    • pullPolicy

      @PluginProperty protected PullPolicy pullPolicy

    • deviceRequests

      @PluginProperty protected List<DeviceRequest> deviceRequests

    • cpu

      @PluginProperty protected Cpu cpu

    • memory

      @PluginProperty protected Memory memory

  • Constructor Details

    • Docker

      public Docker()

  • Method Details

    • instance

      public static Docker instance()
      Convenient default instance to be used as task default value for a 'taskRunner' property.

    • from

      public static Docker from(DockerOptions dockerOptions)

    • run

      public io.kestra.core.models.tasks.runners.RunnerResult run(io.kestra.core.runners.RunContext runContext, io.kestra.core.models.tasks.runners.TaskCommands taskCommands, List<String> filesToDownload) throws Exception
      Specified by:
      run in class io.kestra.core.models.tasks.runners.TaskRunner
      Throws:
      Exception

    • runnerAdditionalVars

      public Map<String,Object> runnerAdditionalVars(io.kestra.core.runners.RunContext runContext, io.kestra.core.models.tasks.runners.TaskCommands taskCommands)
      Overrides:
      runnerAdditionalVars in class io.kestra.core.models.tasks.runners.TaskRunner