Class: Puppet::Environments::Directories Private
- Includes:
- 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.
Reads environments from a directory on disk. Each environment is represented as a sub-directory. The environment’s manifest setting is the ‘manifest` directory of the environment directory. The environment’s modulepath setting is the global modulepath (from the ‘[master]` section for the master) prepended with the `modules` directory of the environment directory.
Class Method Summary collapse
-
.from_path(path, global_module_path) ⇒ Array<Puppet::Environments::Directories>
private
Generate an array of directory loaders from a path string.
Instance Method Summary collapse
-
#get(name) ⇒ Puppet::Node::Environment?
private
Find a named environment.
-
#get_conf(name) ⇒ Puppet::Setting::EnvironmentConf?
private
Attempt to obtain the initial configuration for the environment.
-
#initialize(environment_dir, global_module_path) ⇒ Directories
constructor
private
A new instance of Directories.
-
#list ⇒ Array<Puppet::Node::Environment>
private
All of the environments known to the loader.
-
#search_paths ⇒ Array<String>
private
A list of indicators of where the loader is getting its environments from.
Methods included from EnvironmentLoader
Constructor Details
#initialize(environment_dir, global_module_path) ⇒ Directories
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 Directories.
169 170 171 172 173 174 |
# File 'lib/puppet/environments.rb', line 169 def initialize(environment_dir, global_module_path) @environment_dir = Puppet::FileSystem.(environment_dir) @global_module_path = global_module_path ? global_module_path.map { |p| Puppet::FileSystem.(p) } : nil end |
Class Method Details
.from_path(path, global_module_path) ⇒ Array<Puppet::Environments::Directories>
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.
Generate an array of directory loaders from a path string.
181 182 183 184 185 186 |
# File 'lib/puppet/environments.rb', line 181 def self.from_path(path, global_module_path) environments = path.split(File::PATH_SEPARATOR) environments.map do |dir| Puppet::Environments::Directories.new(dir, global_module_path) end 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
203 204 205 206 207 |
# File 'lib/puppet/environments.rb', line 203 def get(name) if valid_directory?(File.join(@environment_dir, name.to_s)) create_environment(name) 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.
Attempt to obtain the initial configuration for the environment. Not all loaders can provide this.
210 211 212 213 214 215 216 |
# File 'lib/puppet/environments.rb', line 210 def get_conf(name) envdir = File.join(@environment_dir, name.to_s) if valid_directory?(envdir) return Puppet::Settings::EnvironmentConf.load_from(envdir, @global_module_path) end nil 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.
194 195 196 197 198 199 200 |
# File 'lib/puppet/environments.rb', line 194 def list valid_directories.collect do |envdir| name = Puppet::FileSystem.basename_string(envdir).intern create_environment(name) end 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.
189 190 191 |
# File 'lib/puppet/environments.rb', line 189 def search_paths ["file://#{@environment_dir}"] end |