Class: Ansible::Ruby::Modules::Docker_swarm_service

Inherits:

Base

Object
Ansible::Ruby::Models::Base
Base
Ansible::Ruby::Modules::Docker_swarm_service

show all

Defined in:: lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb

Overview

Manage docker services. Allows live altering of already defined services

Instance Method Summary collapse

#args ⇒ Object^?
List comprised of the command and the arguments to be run inside,the container.
#configs ⇒ Object^?
List of dictionaries describing the service configs.,Every item must be a dictionary exposing the keys config_id, config_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444),Maps docker service --config option.
#constraints ⇒ Object^?
List of the service constraints.,Maps docker service --constraint option.
#container_labels ⇒ Object^?
List of the service containers labels.,Maps docker service --container-label option.
#dns ⇒ Object^?
List of custom DNS servers.,Maps docker service --dns option.,Requires api_version >= 1.25.
#dns_options ⇒ Object^?
List of custom DNS options.,Maps docker service --dns-option option.,Requires api_version >= 1.25.
#dns_search ⇒ Object^?
List of custom DNS search domains.,Maps docker service --dns-search option.,Requires api_version >= 1.25.
#endpoint_mode ⇒ :vip, ...
Service endpoint mode.,Maps docker service --endpoint-mode option.
#env ⇒ Object^?
List of the service environment variables.,Maps docker service --env option.
#force_update ⇒ Symbol^?
Force update even if no changes require it.,Maps to docker service update --force option.,Requires api_version >= 1.25.
#hostname ⇒ String^?
Container hostname,Maps docker service --hostname option.,Requires api_version >= 1.25.
#image ⇒ String
Service image path and tag.
#labels ⇒ Object^?
List of the service labels.,Maps docker service --label option.
#limit_cpu ⇒ Float^?
Service CPU limit.
#limit_memory ⇒ Integer^?
Service memory limit in MB.
#log_driver ⇒ String^?
Configure the logging driver for a service.
#log_driver_options ⇒ Object^?
Options for service logging driver.
#mode ⇒ String^?
Service replication mode.,Maps docker service --mode option.
#mounts ⇒ Object^?
List of dictionaries describing the service mounts.,Every item must be a dictionary exposing the keys source, target, type (defaults to 'bind'), readonly (defaults to false),Maps docker service --mount option.
#name ⇒ String
Service name.
#networks ⇒ Object^?
List of the service networks names.,Maps docker service --network option.
#publish ⇒ Object^?
List of dictionaries describing the service published ports.,Every item must be a dictionary exposing the keys published_port, target_port, protocol (defaults to 'tcp'), mode <ingress|host>, default to ingress.,Only used with api_version >= 1.25.
#replicas ⇒ Integer^?
Number of containers instantiated in the service.
#reserve_cpu ⇒ Float^?
Service CPU reservation.
#reserve_memory ⇒ Integer^?
Service memory reservation in MB.
#restart_policy ⇒ :none, ...
Restart condition of the service.,Maps docker service --restart-condition option.
#restart_policy_attempts ⇒ Integer^?
Maximum number of service restarts.,Maps docker service --restart-max-attempts option.
#restart_policy_delay ⇒ Integer^?
Delay between restarts.,Maps docker service --restart-delay option.
#restart_policy_window ⇒ Integer^?
Restart policy evaluation window.,Maps docker service --restart-window option.
#secrets ⇒ Object^?
List of dictionaries describing the service secrets.,Every item must be a dictionary exposing the keys secret_id, secret_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444),Maps docker service --secret option.
#state ⇒ :present, :absent
Service state.
#tty ⇒ Symbol^?
Allocate a pseudo-TTY,Maps docker service --tty option.,Requires api_version >= 1.25.
#update_delay ⇒ Integer^?
Rolling update delay,Maps docker service --update-delay option.
#update_failure_action ⇒ :continue, ...
Action to take in case of container failure,Maps to docker service --update-failure-action option.
#update_max_failure_ratio ⇒ Float^?
Fraction of tasks that may fail during an update before the failure action is invoked,Maps to docker service --update-max-failure-ratio.
#update_monitor ⇒ Integer^?
Time to monitor updated tasks for failures, in nanoseconds.,Maps to docker service --update-monitor option.
#update_order ⇒ :"stop-first", ...
Specifies the order of operations when rolling out an updated task.,Maps to docker service --update-order.
#update_parallelism ⇒ Integer^?
Rolling update parallelism,Maps docker service --update-parallelism option.
#user ⇒ String^?
Username or UID.

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

#args ⇒ `Object`^?

Returns List comprised of the command and the arguments to be run inside,the container.

Returns:

(Object, nil) —
List comprised of the command and the arguments to be run inside,the container

25	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 25 attribute :args

#configs ⇒ `Object`^?

Returns List of dictionaries describing the service configs.,Every item must be a dictionary exposing the keys config_id, config_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444),Maps docker service --config option.

Returns:

(Object, nil) —
List of dictionaries describing the service configs.,Every item must be a dictionary exposing the keys config_id, config_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444),Maps docker service --config option.

98	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 98 attribute :configs

#constraints ⇒ `Object`^?

Returns List of the service constraints.,Maps docker service --constraint option.

Returns:

(Object, nil) —
List of the service constraints.,Maps docker service --constraint option.

28	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 28 attribute :constraints

#container_labels ⇒ `Object`^?

Returns List of the service containers labels.,Maps docker service --container-label option.

Returns:

(Object, nil) —
List of the service containers labels.,Maps docker service --container-label option.

55	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 55 attribute :container_labels

#dns ⇒ `Object`^?

Returns List of custom DNS servers.,Maps docker service --dns option.,Requires api_version >= 1.25.

Returns:

(Object, nil) —
List of custom DNS servers.,Maps docker service --dns option.,Requires api_version >= 1.25

39	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 39 attribute :dns

#dns_options ⇒ `Object`^?

Returns List of custom DNS options.,Maps docker service --dns-option option.,Requires api_version >= 1.25.

Returns:

(Object, nil) —
List of custom DNS options.,Maps docker service --dns-option option.,Requires api_version >= 1.25

45	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 45 attribute :dns_options

#dns_search ⇒ `Object`^?

Returns List of custom DNS search domains.,Maps docker service --dns-search option.,Requires api_version >= 1.25.

Returns:

(Object, nil) —
List of custom DNS search domains.,Maps docker service --dns-search option.,Requires api_version >= 1.25

42	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 42 attribute :dns_search

#endpoint_mode ⇒ `:vip`, ...

Returns Service endpoint mode.,Maps docker service --endpoint-mode option.

Returns:

(:vip, :dnsrr, nil) —
Service endpoint mode.,Maps docker service --endpoint-mode option.

58	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 58 attribute :endpoint_mode

#env ⇒ `Object`^?

Returns List of the service environment variables.,Maps docker service --env option.

Returns:

(Object, nil) —
List of the service environment variables.,Maps docker service --env option.

62	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 62 attribute :env

#force_update ⇒ `Symbol`^?

Returns Force update even if no changes require it.,Maps to docker service update --force option.,Requires api_version >= 1.25.

Returns:

(Symbol, nil) —
Force update even if no changes require it.,Maps to docker service update --force option.,Requires api_version >= 1.25

48	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 48 attribute :force_update

#hostname ⇒ `String`^?

Returns Container hostname,Maps docker service --hostname option.,Requires api_version >= 1.25.

Returns:

(String, nil) —
Container hostname,Maps docker service --hostname option.,Requires api_version >= 1.25

31	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 31 attribute :hostname

#image ⇒ `String`

Returns Service image path and tag. Maps docker service IMAGE parameter.

Returns:

(String) —
Service image path and tag. Maps docker service IMAGE parameter.

17	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 17 attribute :image

#labels ⇒ `Object`^?

Returns List of the service labels.,Maps docker service --label option.

Returns:

(Object, nil) —
List of the service labels.,Maps docker service --label option.

52	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 52 attribute :labels

#limit_cpu ⇒ `Float`^?

Returns Service CPU limit. 0 equals no limit.,Maps docker service --limit-cpu option.

Returns:

(Float, nil) —
Service CPU limit. 0 equals no limit.,Maps docker service --limit-cpu option.

72	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 72 attribute :limit_cpu

#limit_memory ⇒ `Integer`^?

Returns Service memory limit in MB. 0 equals no limit.,Maps docker service --limit-memory option.

Returns:

(Integer, nil) —
Service memory limit in MB. 0 equals no limit.,Maps docker service --limit-memory option.

80	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 80 attribute :limit_memory

#log_driver ⇒ `String`^?

Returns Configure the logging driver for a service.

Returns:

(String, nil) —
Configure the logging driver for a service

65	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 65 attribute :log_driver

#log_driver_options ⇒ `Object`^?

Returns Options for service logging driver.

Returns:

(Object, nil) —
Options for service logging driver

69	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 69 attribute :log_driver_options

#mode ⇒ `String`^?

Returns Service replication mode.,Maps docker service --mode option.

Returns:

(String, nil) —
Service replication mode.,Maps docker service --mode option.

88	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 88 attribute :mode

#mounts ⇒ `Object`^?

Returns List of dictionaries describing the service mounts.,Every item must be a dictionary exposing the keys source, target, type (defaults to 'bind'), readonly (defaults to false),Maps docker service --mount option.

Returns:

(Object, nil) —
List of dictionaries describing the service mounts.,Every item must be a dictionary exposing the keys source, target, type (defaults to 'bind'), readonly (defaults to false),Maps docker service --mount option.

92	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 92 attribute :mounts

#name ⇒ `String`

Returns Service name.

Returns:

(String) —
Service name

13	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 13 attribute :name

#networks ⇒ `Object`^?

Returns List of the service networks names.,Maps docker service --network option.

Returns:

(Object, nil) —
List of the service networks names.,Maps docker service --network option.

101	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 101 attribute :networks

#publish ⇒ `Object`^?

Returns List of dictionaries describing the service published ports.,Every item must be a dictionary exposing the keys published_port, target_port, protocol (defaults to 'tcp'), mode <ingress|host>, default to ingress.,Only used with api_version >= 1.25.

Returns:

(Object, nil) —
List of dictionaries describing the service published ports.,Every item must be a dictionary exposing the keys published_port, target_port, protocol (defaults to 'tcp'), mode <ingress|host>, default to ingress.,Only used with api_version >= 1.25

104	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 104 attribute :publish

#replicas ⇒ `Integer`^?

Returns Number of containers instantiated in the service. Valid only if mode=='replicated'.,If set to -1, and service is not present, service replicas will be set to 1.,If set to -1, and service is present, service replicas will be unchanged.,Maps docker service --replicas option.

Returns:

(Integer, nil) —
Number of containers instantiated in the service. Valid only if mode=='replicated'.,If set to -1, and service is not present, service replicas will be set to 1.,If set to -1, and service is present, service replicas will be unchanged.,Maps docker service --replicas option.

107	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 107 attribute :replicas

#reserve_cpu ⇒ `Float`^?

Returns Service CPU reservation. 0 equals no reservation.,Maps docker service --reserve-cpu option.

Returns:

(Float, nil) —
Service CPU reservation. 0 equals no reservation.,Maps docker service --reserve-cpu option.

76	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 76 attribute :reserve_cpu

#reserve_memory ⇒ `Integer`^?

Returns Service memory reservation in MB. 0 equals no reservation.,Maps docker service --reserve-memory option.

Returns:

(Integer, nil) —
Service memory reservation in MB. 0 equals no reservation.,Maps docker service --reserve-memory option.

84	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 84 attribute :reserve_memory

#restart_policy ⇒ `:none`, ...

Returns Restart condition of the service.,Maps docker service --restart-condition option.

Returns:

(:none, :"on-failure", :any, nil) —
Restart condition of the service.,Maps docker service --restart-condition option.

111	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 111 attribute :restart_policy

#restart_policy_attempts ⇒ `Integer`^?

Returns Maximum number of service restarts.,Maps docker service --restart-max-attempts option.

Returns:

(Integer, nil) —
Maximum number of service restarts.,Maps docker service --restart-max-attempts option.

115	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 115 attribute :restart_policy_attempts

#restart_policy_delay ⇒ `Integer`^?

Returns Delay between restarts.,Maps docker service --restart-delay option.

Returns:

(Integer, nil) —
Delay between restarts.,Maps docker service --restart-delay option.

119	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 119 attribute :restart_policy_delay

#restart_policy_window ⇒ `Integer`^?

Returns Restart policy evaluation window.,Maps docker service --restart-window option.

Returns:

(Integer, nil) —
Restart policy evaluation window.,Maps docker service --restart-window option.

123	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 123 attribute :restart_policy_window

#secrets ⇒ `Object`^?

Returns List of dictionaries describing the service secrets.,Every item must be a dictionary exposing the keys secret_id, secret_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444),Maps docker service --secret option.

Returns:

(Object, nil) —
List of dictionaries describing the service secrets.,Every item must be a dictionary exposing the keys secret_id, secret_name, filename, uid (defaults to 0), gid (defaults to 0), mode (defaults to 0o444),Maps docker service --secret option.

95	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 95 attribute :secrets

#state ⇒ `:present`, `:absent`

Returns Service state.

Returns:

(:present, :absent) —
Service state.

21	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 21 attribute :state

#tty ⇒ `Symbol`^?

Returns Allocate a pseudo-TTY,Maps docker service --tty option.,Requires api_version >= 1.25.

Returns:

(Symbol, nil) —
Allocate a pseudo-TTY,Maps docker service --tty option.,Requires api_version >= 1.25

35	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 35 attribute :tty

#update_delay ⇒ `Integer`^?

Returns Rolling update delay,Maps docker service --update-delay option.

Returns:

(Integer, nil) —
Rolling update delay,Maps docker service --update-delay option

127	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 127 attribute :update_delay

#update_failure_action ⇒ `:continue`, ...

Returns Action to take in case of container failure,Maps to docker service --update-failure-action option.

Returns:

(:continue, :pause, nil) —
Action to take in case of container failure,Maps to docker service --update-failure-action option

135	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 135 attribute :update_failure_action

#update_max_failure_ratio ⇒ `Float`^?

Returns Fraction of tasks that may fail during an update before the failure action is invoked,Maps to docker service --update-max-failure-ratio.

Returns:

(Float, nil) —
Fraction of tasks that may fail during an update before the failure action is invoked,Maps to docker service --update-max-failure-ratio

143	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 143 attribute :update_max_failure_ratio

#update_monitor ⇒ `Integer`^?

Returns Time to monitor updated tasks for failures, in nanoseconds.,Maps to docker service --update-monitor option.

Returns:

(Integer, nil) —
Time to monitor updated tasks for failures, in nanoseconds.,Maps to docker service --update-monitor option

139	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 139 attribute :update_monitor

#update_order ⇒ `:"stop-first"`, ...

Returns Specifies the order of operations when rolling out an updated task.,Maps to docker service --update-order.

Returns:

(:"stop-first", :"start-first", nil) —
Specifies the order of operations when rolling out an updated task.,Maps to docker service --update-order

147	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 147 attribute :update_order

#update_parallelism ⇒ `Integer`^?

Returns Rolling update parallelism,Maps docker service --update-parallelism option.

Returns:

(Integer, nil) —
Rolling update parallelism,Maps docker service --update-parallelism option

131	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 131 attribute :update_parallelism

#user ⇒ `String`^?

Returns username or UID.

Returns:

(String, nil) —
username or UID

151	# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_swarm_service.rb', line 151 attribute :user

Class: Ansible::Ruby::Modules::Docker_swarm_service

Overview

Instance Method Summary collapse

Methods inherited from Base

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

Constructor Details

Instance Method Details

#args ⇒ Object?

#configs ⇒ Object?

#constraints ⇒ Object?

#container_labels ⇒ Object?

#dns ⇒ Object?

#dns_options ⇒ Object?

#dns_search ⇒ Object?

#endpoint_mode ⇒ :vip, ...

#env ⇒ Object?

#force_update ⇒ Symbol?

#hostname ⇒ String?

#image ⇒ String

#labels ⇒ Object?

#limit_cpu ⇒ Float?

#limit_memory ⇒ Integer?

#log_driver ⇒ String?

#log_driver_options ⇒ Object?

#mode ⇒ String?

#mounts ⇒ Object?

#name ⇒ String

#networks ⇒ Object?

#publish ⇒ Object?

#replicas ⇒ Integer?

#reserve_cpu ⇒ Float?

#reserve_memory ⇒ Integer?

#restart_policy ⇒ :none, ...

#restart_policy_attempts ⇒ Integer?

#restart_policy_delay ⇒ Integer?

#restart_policy_window ⇒ Integer?

#secrets ⇒ Object?

#state ⇒ :present, :absent

#tty ⇒ Symbol?

#update_delay ⇒ Integer?

#update_failure_action ⇒ :continue, ...

#update_max_failure_ratio ⇒ Float?

#update_monitor ⇒ Integer?

#update_order ⇒ :"stop-first", ...

#update_parallelism ⇒ Integer?

#user ⇒ String?

#args ⇒ `Object`^?

#configs ⇒ `Object`^?

#constraints ⇒ `Object`^?

#container_labels ⇒ `Object`^?

#dns ⇒ `Object`^?

#dns_options ⇒ `Object`^?

#dns_search ⇒ `Object`^?

#endpoint_mode ⇒ `:vip`, ...

#env ⇒ `Object`^?

#force_update ⇒ `Symbol`^?

#hostname ⇒ `String`^?

#image ⇒ `String`

#labels ⇒ `Object`^?

#limit_cpu ⇒ `Float`^?

#limit_memory ⇒ `Integer`^?

#log_driver ⇒ `String`^?

#log_driver_options ⇒ `Object`^?

#mode ⇒ `String`^?

#mounts ⇒ `Object`^?

#name ⇒ `String`

#networks ⇒ `Object`^?

#publish ⇒ `Object`^?

#replicas ⇒ `Integer`^?

#reserve_cpu ⇒ `Float`^?

#reserve_memory ⇒ `Integer`^?

#restart_policy ⇒ `:none`, ...

#restart_policy_attempts ⇒ `Integer`^?

#restart_policy_delay ⇒ `Integer`^?

#restart_policy_window ⇒ `Integer`^?

#secrets ⇒ `Object`^?

#state ⇒ `:present`, `:absent`

#tty ⇒ `Symbol`^?

#update_delay ⇒ `Integer`^?

#update_failure_action ⇒ `:continue`, ...

#update_max_failure_ratio ⇒ `Float`^?

#update_monitor ⇒ `Integer`^?

#update_order ⇒ `:"stop-first"`, ...

#update_parallelism ⇒ `Integer`^?

#user ⇒ `String`^?