Class R10K::Environment::Base
In: lib/r10k/environment/base.rb
Parent: Object

This class defines a common interface for environment implementations.

@since 1.3.0

Methods

accept   modules   new   status   sync  

Attributes

basedir  [R]  @!attribute [r] basedir 
  @return [String] The path that this environment will be created in
dirname  [R]  @!attribute [r] dirname 
  @return [String] The directory name for the given environment
name  [R]  @!attribute [r] name 
  @return [String] A name for this environment that is unique to the given source
path  [R]  @!attribute [r] path 
  @return [Pathname] The full path to the given environment
puppetfile  [R]  @!attribute [r] puppetfile 
  @api public
  @return [R10K::Puppetfile] The puppetfile instance associated with this environment

Public Class methods

new(name, basedir, dirname, options = {})

Initialize the given environment.

@param name [String] The unique name describing this environment. @param basedir [String] The base directory where this environment will be created. @param dirname [String] The directory name for this environment. @param options [Hash] An additional set of options for this environment. 

  The semantics of this environment may depend on the environment implementation.

Public Instance methods

modules()

@return [Array<R10K::Module::Base>] All modules defined in the Puppetfile 

  associated with this environment.
status()

Determine the current status of the environment.

This can return the following values: 

  * :absent - there is no module installed
  * :mismatched - there is a module installed but it must be removed and reinstalled
  * :outdated - the correct module is installed but it needs to be updated
  * :insync - the correct module is installed and up to date, or the module is actually a boy band.

@api public @abstract @return [Symbol]

sync()

Synchronize the given environment.

@api public @abstract @return [void]

[Validate]