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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/web_infrastructure/deploy_helper.rb

Instance Method Summary collapse

Methods inherited from Base

#to_h

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

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

Constructor Details

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

Instance Method Details

#clean ⇒ Boolean?

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

Returns:

  • (Boolean, nil) —

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



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

attribute :clean

#current_path ⇒ String?

Returns the name of the symlink that is created when the deploy is finalized. Used in C(finalize) and C(clean). Returned in the C(deploy_helper.current_path) fact.

Returns:

  • (String, nil) —

    the name of the symlink that is created when the deploy is finalized. Used in C(finalize) and C(clean). Returned in the C(deploy_helper.current_path) fact.



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

attribute :current_path

#keep_releases ⇒ Integer?

Returns the number of old releases to keep when cleaning. Used in C(finalize) and C(clean). Any unfinished builds will be deleted first, so only correct releases will count. The current version will not count.

Returns:

  • (Integer, nil) —

    the number of old releases to keep when cleaning. Used in C(finalize) and C(clean). Any unfinished builds will be deleted first, so only correct releases will count. The current version will not count.



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

attribute :keep_releases

#path ⇒ String

Returns the root path of the project. Alias I(dest). Returned in the C(deploy_helper.project_path) fact.

Returns:

  • (String) —

    the root path of the project. Alias I(dest). Returned in the C(deploy_helper.project_path) fact.



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

attribute :path

#release ⇒ String?

Returns the release version that is being deployed. Defaults to a timestamp format %Y%m%d%H%M%S (i.e. ‘20141119223359’). This parameter is optional during C(state=present), but needs to be set explicitly for C(state=finalize). You can use the generated fact C(release=deploy_helper.new_release }).

Returns:

  • (String, nil) —

    the release version that is being deployed. Defaults to a timestamp format %Y%m%d%H%M%S (i.e. ‘20141119223359’). This parameter is optional during C(state=present), but needs to be set explicitly for C(state=finalize). You can use the generated fact C(release=deploy_helper.new_release }).



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

attribute :release

#releases_path ⇒ String?

Returns the name of the folder that will hold the releases. This can be relative to C(path) or absolute. Returned in the C(deploy_helper.releases_path) fact.

Returns:

  • (String, nil) —

    the name of the folder that will hold the releases. This can be relative to C(path) or absolute. Returned in the C(deploy_helper.releases_path) fact.



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

attribute :releases_path

#shared_path ⇒ String?

Returns the name of the folder that will hold the shared resources. This can be relative to C(path) or absolute. If this is set to an empty string, no shared folder will be created. Returned in the C(deploy_helper.shared_path) fact.

Returns:

  • (String, nil) —

    the name of the folder that will hold the shared resources. This can be relative to C(path) or absolute. If this is set to an empty string, no shared folder will be created. Returned in the C(deploy_helper.shared_path) fact.



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

attribute :shared_path

#state ⇒ :present, ...

Returns the state of the project. C(query) will only gather facts, C(present) will create the project I(root) folder, and in it the I(releases) and I(shared) folders, C(finalize) will remove the unfinished_filename file, create a symlink to the newly deployed release and optionally clean old releases, C(clean) will remove failed & old releases, C(absent) will remove the project folder (synonymous to the M(file) module with C(state=absent)).

Returns:

  • (:present, :finalize, :absent, :clean, :query, nil) —

    the state of the project. C(query) will only gather facts, C(present) will create the project I(root) folder, and in it the I(releases) and I(shared) folders, C(finalize) will remove the unfinished_filename file, create a symlink to the newly deployed release and optionally clean old releases, C(clean) will remove failed & old releases, C(absent) will remove the project folder (synonymous to the M(file) module with C(state=absent))



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

attribute :state

#unfinished_filename ⇒ String?

Returns the name of the file that indicates a deploy has not finished. All folders in the releases_path that contain this file will be deleted on C(state=finalize) with clean=True, or C(state=clean). This file is automatically deleted from the I(new_release_path) during C(state=finalize).

Returns:

  • (String, nil) —

    the name of the file that indicates a deploy has not finished. All folders in the releases_path that contain this file will be deleted on C(state=finalize) with clean=True, or C(state=clean). This file is automatically deleted from the I(new_release_path) during C(state=finalize).



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

attribute :unfinished_filename