Docker Prune

4 min

Resumo

Permite executar docker container prune, docker image prune, docker network prune e docker volume prune por meio da API.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
api_version aliases: docker_api_version	string	Default: - "auto"	A versão da API Docker em execução no Docker Host.O padrão é a versão mais recente da API suportada pelo Docker SDK para Python e o docker daemon.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_API_VERSION será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
builder_cache	boolean	Escolhas: - false (default) - true	Se deve limpar o cache do construtor.Requer a versão 3.3.0 do Docker SDK para Python ou mais recente.
ca_cert aliases: tls_ca_cert, cacert_path	path		Use um certificado CA ao executar a verificação do servidor, fornecendo o caminho para um arquivo de certificado CA.Se o valor não for especificado na tarefa e a variável de ambiente DOCKER_CERT_PATH for definida, o arquivo ca.pem do diretório especificado na variável de ambiente DOCKER_CERT_PATH será usado.
client_cert aliases: tls_client_cert, cert_path	path		Caminho para o arquivo de certificado TLS do cliente.Se o valor não for especificado na tarefa e a variável de ambiente DOCKER_CERT_PATH for definida, o arquivo cert.pem do diretório especificado na variável de ambiente DOCKER_CERT_PATH será usado.
client_key aliases: tls_client_key, key_path	path		Caminho para o arquivo de chave TLS do cliente.Se o valor não for especificado na tarefa e a variável de ambiente DOCKER_CERT_PATH for definida, o arquivo key.pem do diretório especificado na variável de ambiente DOCKER_CERT_PATH será usado.
containers	boolean	Escolhas: - false (default) - true	Se deve realizar o Prune containers.
containers_filters	dictionary		Um dicionário de valores de filtro usado para selecionar contêineres a serem excluídos. Por exemplo until: 24h. Consulte a documentação do docker para obter mais informações sobre os filtros possíveis.
debug	boolean	Escolhas: - false (default) - true	Modo de depuração
docker_host aliases: docker_url	string	Default: - "unix: //var/run/docker.sock"	O URL ou o caminho do soquete Unix usado para se conectar à API Docker. Para se conectar a um host remoto, forneça a string de conexão TCP. Por exemplo tcp://192.0.2.23:2376. Se TLS for usado para criptografar a conexão, o módulo será automaticamente substituído tcpno URL de conexão por https.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_HOST será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
images	boolean	Escolhas: - false (default) - true	Se deve usar imagens.
images_filters	dictionary		Um dicionário de valores de filtro usado para selecionar imagens a serem excluídas.Por exemplo dangling: true.
networks	boolean	Escolhas: - false (default) - true	Se deve usar redes.
networks_filters	dictionary		Um dicionário de valores de filtro usado para selecionar as redes a serem excluídas.
ssl_version	string		Forneça um número de versão SSL válido. Valor padrão determinado pelo módulo ssl.py.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_SSL_VERSION será usado.
timeout	integer	Default: - 60	O tempo máximo em segundos de espera por uma resposta da API.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TIMEOUTserá usado. Se a variável de ambiente não for definida, o valor padrão será usado.
tls	boolean	Escolhas: - false (default) - true	Proteja a conexão com a API usando TLS sem verificar a autenticidade do servidor host Docker. Observe que se validate_certs também for definido yescomo, ele terá precedência.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TLSserá usado. Se a variável de ambiente não for definida, o valor padrão será usado.
tls_hostname	string	Default: - "localhost"	Ao verificar a autenticidade do servidor Docker Host, forneça o nome esperado do servidor.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TLS_HOSTNAMEserá usado. Se a variável de ambiente não for definida, o valor padrão será usado.
validate_certs aliases: tls_verify	boolean	Escolhas: - false (default) - true	Proteja a conexão com a API usando TLS e verificando a autenticidade do servidor host Docker.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TLS_VERIFYserá usado. Se a variável de ambiente não for definida, o valor padrão será usado.
volumes	boolean	Escolhas: - false (default) - true	Se deseja dar Prune nos volumes.
volumes_filters	dictionary		Um dicionário de valores de filtro usado para selecionar os volumes a serem excluídos.

Exemplos

# Prune containers com mais de 24h
  docker_prune:
    containers: yes
    containers_filters:
      # considere apenas containers criados há mais de 24 horas
      until: 24h

# Prune tudo
  docker_prune:
    containers: yes
    images: yes
    networks: yes
    volumes: yes
    builder_cache: yes

# Prune tudo (incluindo imagens não pendentes)
  docker_prune:
    containers: yes
    images: yes
    images_filters:
      dangling: false
    networks: yes
    volumes: yes
    builder_cache: yes

Valores Retornados

Chave	Tipo	Retornado quando	Descrição
builder_cache_space_reclaimed	integer	builder_cache = true	Quantidade de espaço em disco recuperado da limpeza do cache do construtor em bytes.
containers	list / elements=string	containers = true	Lista de IDs de contêineres excluídos.
containers_space_reclaimed	integer	containers = true	Quantidade de espaço em disco recuperado pela remoção do contêiner em bytes.
images	list / elements=string	images = true	Lista de IDs de imagens excluídas.
images_space_reclaimed	integer	images = true	Quantidade de espaço em disco recuperado pela remoção de imagens em bytes.
networks	list / elements=string	networks = true	Lista de IDs de redes excluídas.
volumes	list / elements=string	volumes = true	Lista de IDs de volumes excluídos.
volumes_space_reclaimed	integer	volumes = true	Quantidade de espaço em disco recuperado a partir da remoção de volumes em bytes.