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

Inherits:
Base show all
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 collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :advertise_addr

#autolock_managers ⇒ Symbol?

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

Returns:

  • (Symbol, nil) —

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



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

attribute :autolock_managers

#ca_force_rotate ⇒ Object?

Returns 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).

Returns:

  • (Object, nil) —

    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).



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

attribute :ca_force_rotate

#dispatcher_heartbeat_period ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :dispatcher_heartbeat_period

#election_tick ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :election_tick

#force ⇒ :yes, ...

Returns 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.

Returns:

  • (:yes, :no, nil) —

    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.



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

attribute :force

#heartbeat_tick ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :heartbeat_tick

#join_token ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :join_token

#keep_old_snapshots ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :keep_old_snapshots

#labels ⇒ Object?

Returns User-defined key/value metadata.

Returns:

  • (Object, nil) —

    User-defined key/value metadata.



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

attribute :labels

#listen_addr ⇒ String?

Returns 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.

Returns:

  • (String, nil) —

    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.



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

attribute :listen_addr

#log_entries_for_slow_followers ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :log_entries_for_slow_followers

#name ⇒ Object?

Returns The name of the swarm.

Returns:

  • (Object, nil) —

    The name of the swarm.



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

attribute :name

#node_cert_expiry ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :node_cert_expiry

#node_id ⇒ String?

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

Returns:

  • (String, nil) —

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



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

attribute :node_id

#remote_addrs ⇒ Array<String>, ...

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

Returns:

  • (Array<String>, String, nil) —

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



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

attribute :remote_addrs

#rotate_manager_token ⇒ :yes, ...

Returns Rotate the manager join token.

Returns:

  • (:yes, :no, nil) —

    Rotate the manager join token.



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

attribute :rotate_manager_token

#rotate_worker_token ⇒ :yes, ...

Returns Rotate the worker join token.

Returns:

  • (:yes, :no, nil) —

    Rotate the worker join token.



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

attribute :rotate_worker_token

#signing_ca_cert ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :signing_ca_cert

#signing_ca_key ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :signing_ca_key

#snapshot_interval ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :snapshot_interval

#state ⇒ :present, ...

Returns 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.

Returns:

  • (:present, :join, :absent, :remove, :inspect) —

    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.



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

attribute :state

#task_history_retention_limit ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :task_history_retention_limit