Docker Swarm

7 min

Resumo

Gerenciar um cluster do Docker Swarm.

Requisitos

Docker API >= 1.25

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
default_addr_pool	list / elements=string		Conjunto de endereços padrão no formato CIDR. Usado somente quando o enxame é inicializado. Por isso, não é considerado para verificação de idempotência.
dispatcher_heartbeat_period	integer		O atraso para um agente enviar uma pulsação ao dispatcher. O valor padrão do Docker é 5s.
election_tick	integer		Quantidade de ticks (em segundos) necessários sem um líder, para acionar uma nova eleição. O valor padrão do Docker é 10s.
force	boolean	Escolhas: - false (default) - true	Use com o estado present para forçar a criação de um novo Swarm, mesmo se já fizer parte de um. Use com o estado absent para deixar o swarm mesmo se este node for um gerenciador.
heartbeat_tick	integer		Quantidade de tiques (em segundos) entre cada heartbeat tick. O valor padrão do Docker é 1s.
join_token	string		Token swarm utilizado para se conectar ao swarm cluster. Usado quando state for igual a join.
keep_old_snapshots	integer		Número de snapshots a manter para além do snapshot atual. O valor por padrão do Docker é 0.
labels	dictionary		As operações de metadados de chave / valor definidas pelo usuário neste módulo se aplicam ao cluster docker swarm. Use o módulo docker_node para adicionar / modificar / remover rótulos de nodes de um swarm.
listen_addr	string	- "0.0.0.0:2377" (default)	Endereço usado para comunicação entre gerenciadores. Pode ser uma combinação de endereço / porta no formato 192.168.1.1:4567 ou uma interface seguida por um número de porta, como eth0:4567. Se o número da porta for omitido, o porta padrão do swarm é usada. Usada somente quando o swarm é inicializado ou unido. Por isso, não é considerado para verificação de idempotência.
log_entries_for_slow_followers	integer		Número de entradas de registro a serem mantidas para sincronizar slow followers, após a criação de um snapshot.
name	string		O nome do swarm.
node_cert_expiry	integer		Expiração automática para certificados de nodes. O valor padrão do Docker é 3 meses.
node_id	string		ID do swarm do node a ser removido. Utilizado quando o state = remove.
remote_addrs	list / elements=string		Endereço remoto de um ou mais nodes gerenciadores de um Swarm existente para se conectar. Utilizado quando o state = join.
rotate_manager_token	boolean	Escolhas: - false (default) - true	Alterne o token de junção do node gerenciador.
rotate_worker_token	boolean	Escolhas: - false (default) - true	Alterne o token de junção do node trabalhador.
signing_ca_cert	string		O certificado CA de assinatura desejado para todos os certificados TLS de node do swarm, no formato PEM. Este não deve ser um caminho para um certificado, mas o conteúdo do mesmo.
signing_ca_key	string		A chave CA de assinatura desejada para todos os certificados TLS de node do swarm, no formato PEM. Este não deve ser um caminho para uma chave, mas o conteúdo da chave.
snapshot_interval	integer		Número de entradas de logs entre snapshots. O valor padrão do Docker é 10000.
state	string	Escolhas: - present (default) - join - absent - remove	Defina como present, para criar / atualizar um novo cluster. Defina como join para ingressar em um cluster existente. Defina como absent, para deixar um cluster existente. Defina como remove, para remover um node ausente do cluster.
subnet_size	integer		Tamanho da máscara de sub-rede de endereços padrão. Usado somente quando o swarm é inicializado. Por isso, não é considerado para verificação de idempotência.
task_history_retention_limit	integer		Número máximo de histórico de tarefas armazenado. O valor padrão do Docker é 5.

Exemplos

# Exemplo: Inicie um novo swarm com parâmetros padrões
  docker_swarm:
    state: present

# Exemplo: Atualizar configuração do swarm
  docker_swarm:
    state: present
    election_tick: 5

# Exemplo: Adicionar nodes
- docker_swarm:
    state: join
    advertise_addr: 192.168.1.2
    join_token: SWMTKN-1--xxxxx
    remote_addrs: [ '192.168.1.1:2377' ]

# Exemplo: Sair do swarm por meio de um node
- docker_swarm:
    state: absent
    force: true

# Exemplo: Remover o gerenciador do swarm
- docker_swarm:
    state: absent
    force: true

# Exemplo: Remover o node do swarm
- docker_swarm:
    state: remove
    node_id: mynode

Valores retornados

Chave	Tipo	Retornado quando	Descrição
actions	list / elements=string	A ação falhar	Fornece as ações realizadas no swarm.
swarm_facts (Possíveis valores)	dictionary	Sucesso	Informações sobre o swarm.

Subcampos da chave de retorno swarm_facts

Chave	Tipo	Retornado quando	Descrição
JoinTokens options: Manager Worker	dictionary string string	Sucesso Sucesso Sucesso	Tokens para conectar ao Swarm. Token para criar um novo node "gerenciador" Token para criar um novo node "trabalhador"
UnlockKey	string	Sucesso, se autolock_managers for verdadeiro e o swarm for inicializado, ou se autolock_managers tiver mudado.	A chave de desbloqueio do swarm se autolock_managers for verdadeiro.