Run
Certified
Run a Docker container with runtime controls
Run
Certified
Run a Docker container with runtime controls
yaml
type: io.kestra.plugin.docker.RunExamples
yaml
id: docker_run
namespace: company.team
tasks:
- id: run
type: io.kestra.plugin.docker.Run
containerImage: alpine:latest
yaml
id: docker_run
namespace: company.team
tasks:
- id: write
type: io.kestra.plugin.core.storage.Write
content: |
extensions:
health_check: {}
receivers:
otlp:
protocols:
grpc:
endpoint: 0.0.0.0:4317
http:
endpoint: 0.0.0.0:4318
exporters:
debug: {}
service:
pipelines:
logs:
receivers: [otlp]
exporters: [debug]
extension: .yaml
- id: run
type: io.kestra.plugin.docker.Run
containerImage: otel/opentelemetry-collector:latest
inputFiles:
otel.yaml: "{{ outputs.write.uri }}"
commands:
- --config
- otel.yaml
portBindings:
- "4318:4318"
wait: false
yaml
id: docker_run_with_output_file
namespace: company.team
inputs:
- id: greetings
type: STRING
defaults: HELLO WORLD !!
tasks:
- id: docker_run_output_file
type: io.kestra.plugin.docker.Run
containerImage: ubuntu:22.04
commands:
- "/bin/sh"
- "-c"
- echo {{ inputs.greetings }} > file.txt
outputFiles:
- file.txt
- id: log
type: io.kestra.plugin.core.log.Log
message: "{{ read(outputs.docker_run_output_file.outputFiles['file.txt']) }}"
Properties
containerImage *Requiredstring
commands array
SubTypestring
Default
[]config stringobject
cpu Non-dynamic
Definitions
io.kestra.plugin.scripts.runner.docker.Cpu
cpusnumberstring
credentials
Definitions
Credentials for a private container registry.
authstring
identityTokenstring
passwordstring
registrystring
registryTokenstring
usernamestring
deviceRequests Non-dynamicarray
Definitions
A request for devices to be sent to device drivers.
capabilitiesarray
SubTypearray
countintegerstring
deviceIdsarray
SubTypestring
driverstring
optionsobject
SubTypestring
entryPoint array
SubTypestring
env object
extraHosts array
SubTypestring
host string
inputFiles Non-dynamicobjectstring
memory Non-dynamic
Definitions
io.kestra.plugin.scripts.runner.docker.Memory
kernelMemorystring
memorystring
memoryReservationstring
memorySwapstring
memorySwappinessstring
oomKillDisablebooleanstring
namespaceFiles Non-dynamic
Definitions
io.kestra.core.models.tasks.NamespaceFiles
enabledbooleanstring
Default
trueexcludearray
SubTypestring
folderPerNamespacebooleanstring
Default
falseifExistsstring
Default
OVERWRITEPossible Values
OVERWRITEFAILWARNIGNOREincludearray
SubTypestring
namespacesarray
SubTypestring
Default
["{{flow.namespace}}"]networkMode string
outputFiles array
SubTypestring
portBindings array
SubTypestring
privileged booleanstring
pullPolicy string
Default
IF_NOT_PRESENTPossible Values
IF_NOT_PRESENTALWAYSNEVERshmSize string
user string
volumes array
SubTypestring
wait booleanstring
Default
trueOutputs
exitCode integer
Default
0outputFiles object
SubTypestring
taskRunner
Definitions