Class: Ansible::Ruby::Modules::Deploy_helper

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb

Overview

The Deploy Helper manages some of the steps common in deploying software. It creates a folder structure, manages a symlink for the current release and cleans up old releases. Running it with the C(state=query) or C(state=present) will return the C(deploy_helper) fact. C(project_path), whatever you set in the path parameter, C(current_path), the path to the symlink that points to the active release, C(releases_path), the path to the folder to keep releases in, C(shared_path), the path to the folder to keep shared resources in, C(unfinished_filename), the file to check for to recognize unfinished builds, C(previous_release), the release the ‘current’ symlink is pointing to, C(previous_release_path), the full path to the ‘current’ symlink target, C(new_release), either the ‘release’ parameter or a generated timestamp, C(new_release_path), the path to the new release folder (not created by the module).

Instance Method Summary

• #clean ⇒ Boolean^?

  Whether to run the clean procedure in case of C(state=finalize).

• #current_path ⇒ String^?

  The name of the symlink that is created when the deploy is finalized.

• #keep_releases ⇒ Integer^?

  The number of old releases to keep when cleaning.

• #path ⇒ String

  The root path of the project.

• #release ⇒ String^?

  The release version that is being deployed.

• #releases_path ⇒ String^?

  The name of the folder that will hold the releases.

• #shared_path ⇒ String^?

  The name of the folder that will hold the shared resources.

• #state ⇒ :present, ...

  The state of the project.

• #unfinished_filename ⇒ String^?

  The name of the file that indicates a deploy has not finished.

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

#clean ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 40

attribute :clean

#current_path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 32

attribute :current_path

#keep_releases ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 44

attribute :keep_releases

#path ⇒ String

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 12

attribute :path

#release ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 20

attribute :release

#releases_path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 24

attribute :releases_path

#shared_path ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 28

attribute :shared_path

#state ⇒ :present, ...

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 16

attribute :state

#unfinished_filename ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb', line 36

attribute :unfinished_filename