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

Inherits:

Base

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

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

• #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^?

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

attribute :args

#configs ⇒ Object^?

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

attribute :configs

#constraints ⇒ Object^?

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

attribute :constraints

#container_labels ⇒ Object^?

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

attribute :container_labels

#dns ⇒ Object^?

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

attribute :dns

#dns_options ⇒ Object^?

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

attribute :dns_options

#dns_search ⇒ Object^?

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

attribute :dns_search

#endpoint_mode ⇒ :vip, ...

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

attribute :endpoint_mode

#env ⇒ Object^?

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

attribute :env

#force_update ⇒ Symbol^?

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

attribute :force_update

#hostname ⇒ String^?

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

attribute :hostname

#image ⇒ String

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

attribute :image

#labels ⇒ Object^?

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

attribute :labels

#limit_cpu ⇒ Float^?

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

attribute :limit_cpu

#limit_memory ⇒ Integer^?

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

attribute :limit_memory

#log_driver ⇒ String^?

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

attribute :log_driver

#log_driver_options ⇒ Object^?

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

attribute :log_driver_options

#mode ⇒ String^?

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

attribute :mode

#mounts ⇒ Object^?

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

attribute :mounts

#name ⇒ String

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

attribute :name

#networks ⇒ Object^?

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

attribute :networks

#publish ⇒ Object^?

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

attribute :publish

#replicas ⇒ Integer^?

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

attribute :replicas

#reserve_cpu ⇒ Float^?

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

attribute :reserve_cpu

#reserve_memory ⇒ Integer^?

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

attribute :reserve_memory

#restart_policy ⇒ :none, ...

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

attribute :restart_policy

#restart_policy_attempts ⇒ Integer^?

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

attribute :restart_policy_attempts

#restart_policy_delay ⇒ Integer^?

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

attribute :restart_policy_delay

#restart_policy_window ⇒ Integer^?

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

attribute :restart_policy_window

#secrets ⇒ Object^?

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

attribute :secrets

#state ⇒ :present, :absent

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

attribute :state

#tty ⇒ Symbol^?

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

attribute :tty

#update_delay ⇒ Integer^?

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

attribute :update_delay

#update_failure_action ⇒ :continue, ...

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

attribute :update_failure_action

#update_max_failure_ratio ⇒ Float^?

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

attribute :update_max_failure_ratio

#update_monitor ⇒ Integer^?

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

attribute :update_monitor

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

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

attribute :update_order

#update_parallelism ⇒ Integer^?

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

attribute :update_parallelism

#user ⇒ String^?

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

attribute :user