---
title: Docker Node
slug: homologacao-atmosphere/docker-node
description: Learn how to manage Docker nodes with the "docker_node" module through the Swarm Manager. This document provides a summary of the module, including parameters like API version, availability, certificates, and more. Discover how to change the node's role,
docTags:
createdAt: 2021-03-17T17:32:58.000Z
---
## Resumo
- Gerencia os nodes do Docker por meio do Swarm Manager.
- Este módulo permite alterar a função do node, sua disponibilidade e modificar, adicionar ou remover labels de node.
## Parâmetros
| **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** |
| -------------------------------------------------------------- | ---------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| api\_version
aliases: docker\_api\_version | string | Escolhas:
- "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. |
| availability | string | Escolhas:
- active
- pause
- drain | Disponibilidade do node para atribuir. Se não for fornecido, a disponibilidade do node permanecerá inalterada. |
| 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.pemdo 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.pemdo 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.pemdo diretório especificado na variável de ambiente `DOCKER_CERT_PATH` será usado. |
| debug | boolean | Escolhas:
- false (default)
- true | Modo de depuração |
| docker\_host
aliases: docker\_url | string | Escolhas:
- "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 tcp na 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. |
| hostname | string | | O nome do host ou ID do node conforme registrado no Swarm.Se mais de um node for registrado usando o mesmo nome de host, o ID deve ser usado, caso contrário, o módulo falhará. |
| labels | dictionary | | Metadados de chave/valor definidos pelo usuário que serão atribuídos como atributo do node. As operações de label neste módulo se aplicam ao node docker swarm especificado pelo *nome* do *host* .
Use o módulo docker\_swarm para adicionar/modificar/remover labels de cluster swarm. O estado real de etiquetas atribuídas ao node quando o módulo completa o seu trabalho depende *labels\_state* e *labels\_to\_remove* valores dos parâmetros. Veja a descrição abaixo. |
| label\_state | string | Escolhas:
- merge (default)
- replace | Ele define a operação nos labels atribuídos ao node e labels especificados na opção de labels .Defina como mergepara combinar labels fornecidos em labels com aqueles já atribuídos ao node. Se nenhum label for atribuído, ele adicionará os labels listados. Para labels já atribuídos ao node, ele atualizará seus valores.
Os labels não especificados nos labels permanecerão inalterados. Se os labels estiverem vazios, nenhuma alteração será feita.Defina como replacepara substituir todos os labels atribuídos pelos fornecidos. Se os labels estiverem vazios, todos os labels atribuídos ao node serão removidos. |
| labels\_to\_remove | list / elements=string | | Lista de labels que serão removidos da configuração do node. A lista deve conter apenas nomes de labels, não seus valores.Se o label fornecido na lista não for atribuído ao node, a entrada será ignorada.
Se o label estiver em *labels\_to\_remove* e labels , o valor fornecido nos labels permanecerá atribuído ao node.
Se *label\_state* for replacee *label* não for fornecido ou estiver vazio, todos os labels atribuídos ao node serão removidos e *labels\_to\_remove* será ignorada. |
| role | string | Escolhas:
- manager
- worker | Função do node a ser atribuída. Se não for fornecido, a função do node permanecerá inalterada. |
| 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 | Escolhas:
- 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_TIMEOUT` será 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_TLS` será usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
| tls\_hostname | string | Escolhas:
- "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_HOSTNAME` será 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_VERIFY` será usado. Se a variável de ambiente não for definida, o valor padrão será usado. |
## Exemplos
```yaml
# Definir função do node
docker_node:
hostname: mynode
role: manager
# Definir a disponibilidade do node
docker_node:
hostname: mynode
availability: drain
# Substitua os labels dos nodes por novos labels
docker_node:
hostname: mynode
labels:
key: value
labels_state: replace
# Mesclar labels de nodes e novos labels
docker_node:
hostname: mynode
labels:
key: value
# Remova todos os labels atribuídos ao node
docker_node:
hostname: mynode
labels_state: replace
# Remover labels selecionados do node
docker_node:
hostname: mynode
labels_to_remove:
- key1
- key2
```
## Valores Retornados
| **Chave** | **Tipo** | **Retornado quando** | **Descrição** |
| --------- | ---------- | -------------------- | ---------------------------------------------------------- |
| node | dictionary | sucesso | Informações sobre o node após a operação de 'update'
|