Class: Ansible::Ruby::Modules::Docker_swarm

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Docker_swarm

Defined in:

lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb

Overview

Create a new Swarm cluster. Add/Remove nodes or managers to an existing cluster.

Instance Method Summary

• #advertise_addr ⇒ String^?

  Externally reachable address advertised to other nodes.,This can either be an address/port combination in the form C(192.168.1.1:4567), or an interface followed by a port number, like C(eth0:4567).,If the port number is omitted, the port number from the listen address is used.,If C(advertise_addr) is not specified, it will be automatically detected when possible.

• #autolock_managers ⇒ Symbol^?

  If set, generate a key and use it to lock data stored on the managers.,Docker default value is C(no).

• #ca_force_rotate ⇒ Object^?

  An integer whose purpose is to force swarm to generate a new signing CA certificate and key, if none have been specified.,Docker default value is C(0).

• #dispatcher_heartbeat_period ⇒ Object^?

  The delay for an agent to send a heartbeat to the dispatcher.,Docker default value is C(5s).

• #election_tick ⇒ Integer^?

  Amount of ticks (in seconds) needed without a leader to trigger a new election.,Docker default value is C(10s).

• #force ⇒ :yes, ...

  Use with state C(present) to force creating a new Swarm, even if already part of one.,Use with state C(absent) to Leave the swarm even if this node is a manager.

• #heartbeat_tick ⇒ Object^?

  Amount of ticks (in seconds) between each heartbeat.,Docker default value is C(1s).

• #join_token ⇒ String^?

  Swarm token used to join a swarm cluster.,Used with I(state=join).

• #keep_old_snapshots ⇒ Object^?

  Number of snapshots to keep beyond the current snapshot.,Docker default value is C(0).

• #labels ⇒ Object^?

  User-defined key/value metadata.

• #listen_addr ⇒ String^?

  Listen address used for inter-manager communication.,This can either be an address/port combination in the form C(192.168.1.1:4567), or an interface followed by a port number, like C(eth0:4567).,If the port number is omitted, the default swarm listening port is used.

• #log_entries_for_slow_followers ⇒ Object^?

  Number of log entries to keep around to sync up slow followers after a snapshot is created.

• #name ⇒ Object^?

  The name of the swarm.

• #node_cert_expiry ⇒ Object^?

  Automatic expiry for nodes certificates.,Docker default value is C(3months).

• #node_id ⇒ String^?

  Swarm id of the node to remove.,Used with I(state=remove).

• #remote_addrs ⇒ Array<String>, ...

  Remote address of a manager to connect to.,Used with I(state=join).

• #rotate_manager_token ⇒ :yes, ...

  Rotate the manager join token.

• #rotate_worker_token ⇒ :yes, ...

  Rotate the worker join token.

• #signing_ca_cert ⇒ Object^?

  The desired signing CA certificate for all swarm node TLS leaf certificates, in PEM format.

• #signing_ca_key ⇒ Object^?

  The desired signing CA key for all swarm node TLS leaf certificates, in PEM format.

• #snapshot_interval ⇒ Object^?

  Number of logs entries between snapshot.,Docker default value is C(10000).

• #state ⇒ :present, ...

  Set to C(present), to create/update a new cluster.,Set to C(join), to join an existing cluster.,Set to C(absent), to leave an existing cluster.,Set to C(remove), to remove an absent node from the cluster.,Set to C(inspect) to display swarm informations.

• #task_history_retention_limit ⇒ Object^?

  Maximum number of tasks history stored.,Docker default value is C(5).

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#advertise_addr ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 13

attribute :advertise_addr

#autolock_managers ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 81

attribute :autolock_managers

#ca_force_rotate ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 78

attribute :ca_force_rotate

#dispatcher_heartbeat_period ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 60

attribute :dispatcher_heartbeat_period

#election_tick ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 56

attribute :election_tick

#force ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 21

attribute :force

#heartbeat_tick ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 53

attribute :heartbeat_tick

#join_token ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 33

attribute :join_token

#keep_old_snapshots ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 47

attribute :keep_old_snapshots

#labels ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 69

attribute :labels

#listen_addr ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 17

attribute :listen_addr

#log_entries_for_slow_followers ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 50

attribute :log_entries_for_slow_followers

#name ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 66

attribute :name

#node_cert_expiry ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 63

attribute :node_cert_expiry

#node_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 29

attribute :node_id

#remote_addrs ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 37

attribute :remote_addrs

#rotate_manager_token ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 89

attribute :rotate_manager_token

#rotate_worker_token ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 85

attribute :rotate_worker_token

#signing_ca_cert ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 72

attribute :signing_ca_cert

#signing_ca_key ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 75

attribute :signing_ca_key

#snapshot_interval ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 44

attribute :snapshot_interval

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 25

attribute :state

#task_history_retention_limit ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm.rb', line 41

attribute :task_history_retention_limit