Rm

Remove a Docker image or container.

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

Examples

Remove multiple docker containers

yaml
id: docker_remove_containers
namespace: company.team

tasks:
  - id: remove_containers
    type: io.kestra.plugin.docker.Rm
    force: true
    containerIds:
        - 947795c71c71
        - 5ad36bff753e

Properties

config stringobject

Docker configuration file.

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

containerIds array

SubType string

Containers ID's.

List of containers IDs to remove

credentials Credentials

force booleanstring

Default false

Force.

Use flag --force to remove images and containers

host string

The URI of your Docker host e.g. localhost

imageIds array

SubType string

Images ID's.

List of images ID's to remove

removeVolumes booleanstring

Default false

Remove volumes.

Remove volumes associated to the container

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.

​Rm

Rm