Class: Ansible::Ruby::Modules::Docker_image

Inherits:

Base

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

Defined in:

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

Overview

Build, load or pull an image, making the image available for creating containers. Also supports tagging an image into a repository and archiving an image to a .tar file.

Instance Method Summary

• #archive_path ⇒ String^?

  Use with state C(present) to archive an image to a .tar file.

• #buildargs ⇒ Hash^?

  Provide a dictionary of C(key:value) build arguments that map to Dockerfile ARG directive.,Docker expects the value to be a string.

• #container_limits ⇒ Object^?

  A dictionary of limits applied to each container created by the build process.

• #dockerfile ⇒ Object^?

  Use with state C(present) to provide an alternate name for the Dockerfile to use when building an image.

• #force ⇒ Symbol^?

  Use with state I(absent) to un-tag and remove all images matching the specified name.

• #http_timeout ⇒ Object^?

  Timeout for HTTP requests during the image build operation.

• #load_path ⇒ String^?

  Use with state C(present) to load an image from a .tar file.

• #name ⇒ String

  Image name.

• #nocache ⇒ Symbol^?

  Do not use cache when building an image.

• #path ⇒ String^?

  Use with state ‘present’ to build an image.

• #pull ⇒ Boolean^?

  When building an image downloads any updates to the FROM image in Dockerfile.

• #push ⇒ Symbol^?

  Push the image to the registry.

• #repository ⇒ String^?

  Full path to a repository.

• #rm ⇒ Boolean^?

  Remove intermediate containers after build.

• #state ⇒ :absent, ...

  Make assertions about the state of an image.,When C(absent) an image will be removed.

• #tag ⇒ String^?

  Used to select an image when pulling.

• #use_tls ⇒ :no, ...

  DEPRECATED.

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

#archive_path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 12

attribute :archive_path

#buildargs ⇒ Hash^?

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

attribute :buildargs

#container_limits ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 70

attribute :container_limits

#dockerfile ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 20

attribute :dockerfile

#force ⇒ Symbol^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 23

attribute :force

#http_timeout ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 27

attribute :http_timeout

#load_path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 16

attribute :load_path

#name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 30

attribute :name

#nocache ⇒ Symbol^?

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

attribute :nocache

#path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 34

attribute :path

#pull ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 38

attribute :pull

#push ⇒ Symbol^?

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

attribute :push

#repository ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 54

attribute :repository

#rm ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 46

attribute :rm

#state ⇒ :absent, ...

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

attribute :state

#tag ⇒ String^?

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

attribute :tag

#use_tls ⇒ :no, ...

# File 'lib/ansible/ruby/modules/generated/cloud/docker/docker_image.rb', line 73

attribute :use_tls