Docker Stop
CertifiedStop or kill a Docker container
Docker Stop
Stop or kill a Docker container
Stops a running container by default, or kills it when kill is true, then optionally deletes it. Defaults: kill=false, delete=true.
type: io.kestra.plugin.docker.cli.StopExamples
Kill a Docker container by ID
id: docker_stop
namespace: company.team
tasks:
- id: run
type: io.kestra.plugin.docker.cli.Stop
containerId: 8088357a1974
kill: true
Stop a Docker container by name
id: docker_stop_by_name
namespace: company.team
tasks:
- id: stop
type: io.kestra.plugin.docker.cli.Stop
containerId: my-app
Properties
config stringobject
Docker configuration file
Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.
containerId string
Container ID or name
ID, ID prefix, or name of the container to stop or kill. For example: 8088357a1974, 8088, or my-app.
credentials
Credentials for a private container registry
Credentials for a private container registry.
The registry authentication.
The auth field is a base64-encoded authentication string of username: password or a token.
The identity token.
The registry password.
The registry URL.
If not defined, the registry will be extracted from the image name.
The registry token.
The registry username.
delete booleanstring
trueDelete container after stop
Defaults to true; set false to keep the container after stopping/killing.
host string
The URI of your Docker host e.g. localhost
kill booleanstring
falseKill instead of stop
When true, sends SIGKILL; otherwise uses a graceful stop.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
