Class: Puppet::Environments::Static Private

Inherits:
Object
  • Object
show all
Includes:
EnvironmentCreator, EnvironmentLoader
Defined in:
lib/puppet/environments.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A source of pre-defined environments.

Direct Known Subclasses

StaticDirectory, StaticPrivate

Instance Method Summary collapse

Methods included from EnvironmentLoader

#clear_all, #get!, #guard, #unguard

Methods included from EnvironmentCreator

#for

Constructor Details

#initialize(*environments) ⇒ Static

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Static.



99
100
101
 
# File 'lib/puppet/environments.rb', line 99

def initialize(*environments)
  @environments = environments
end

Instance Method Details

#get(name) ⇒ Puppet::Node::Environment?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Find a named environment

Parameters:

  • name (String, Symbol) —

    The name of environment to find

Returns:



114
115
116
117
118
 
# File 'lib/puppet/environments.rb', line 114

def get(name)
  @environments.find do |env|
    env.name == name.intern
  end
end

#get_conf(name) ⇒ Puppet::Setting::EnvironmentConf?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a basic environment configuration object tied to the environment’s implementation values. Will not interpolate.

Attempt to obtain the initial configuration for the environment. Not all loaders can provide this.

Parameters:

  • name (String, Symbol) —

    The name of the environment whose configuration we are looking up

Returns:

  • (Puppet::Setting::EnvironmentConf, nil) —

    the configuration for the requested environment, or nil if not found or no configuration is available



124
125
126
127
128
129
130
131
 
# File 'lib/puppet/environments.rb', line 124

def get_conf(name)
  env = get(name)
  if env
    Puppet::Settings::EnvironmentConf.static_for(env, Puppet[:environment_timeout], Puppet[:static_catalogs], Puppet[:rich_data])
  else
    nil
  end
end

#list ⇒ Array<Puppet::Node::Environment>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns All of the environments known to the loader.

Returns:



109
110
111
 
# File 'lib/puppet/environments.rb', line 109

def list
  @environments
end

#search_paths ⇒ Array<String>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

A list of indicators of where the loader is getting its environments from.

Returns:

  • (Array<String>) —

    The URIs of the load locations



104
105
106
 
# File 'lib/puppet/environments.rb', line 104

def search_paths
  ["data:text/plain,internal"]
end