Stop

Stop a Docker container.

yaml
type: "io.kestra.plugin.docker.Stop"

Examples

Kill a docker container

yaml
id: docker_stop
namespace: company.team

tasks:
  - id: run
    type: io.kestra.plugin.docker.Stop
    containerId: 8088357a1974
    kill: true

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

The container id to stop.

credentials Credentials

delete booleanstring

Default true

Does we will remove the container.

host string

The URI of your Docker host e.g. localhost

kill booleanstring

Default false

Does a kill or a stop command will be used.

Definitions

Credentials for a private container registry.

auth string

The registry authentication.

The auth field is a base64-encoded authentication string of username: password or a token.

identityToken string

The identity token.

password string

The registry password.

registry string

The registry URL.

If not defined, the registry will be extracted from the image name.

registryToken string

The registry token.

username string

The registry username.

​Stop