Latest revision as of 20:18, 7 November 2013

This module handles retrieving and access of the org specific config values.

Summary

Configuration is specified in an org-specific file, manifests/$org-config.pp, which is symlinked from manifests/config.pp. This file defines a class, "config", which inherits from "config::base", which defines all config variables. The inherited class only needs to define variables whose values must change.

Usage

in manifests

class foo {
  include config
  if ($config::builder_username == "")
     fail("bad settings")
  }
}

in templates (note use of empty namespace designation)

Username is <%= scope.lookupvar('::config::builder_username') %>

Variables

The available configuration variables are all listed in modules/config/manifests/base.pp; refer to that file for the most up-to-date information.

Functions

This module also defines the secret function; see ReleaseEngineering/PuppetAgain/Secrets.

@@ Line 1: / Line 1: @@
-This module handles retrieving and access of the site specific config values.
+This module handles retrieving and access of the org specific config values.
-== Summary ==
+= Summary =
-We handle config variables via puppets <tt>extlookup()</tt> function, which reads data from keys in csv files in a directory we specify, and in the order we specify. Missing files are not errors, but missing keys (when not specified with a default here) are. We do not specify any defaults in the <tt>extlookup()</tt> function at all.
+Configuration is specified in an org-specific file, <tt>manifests/$org-config.pp</tt>, which is symlinked from <tt>manifests/config.pp</tt>.  This file defines a class, "config", which inherits from "config::base", which defines all config variables.  The inherited class only needs to define variables whose values must change.
-The csv files are stored in the <tt>modules/extlookup/</tt> dir of our whole repo ([http://hg.mozilla.org/build/puppet/file/default/manifests/extlookup source]). Our search order is as follows, first->last.
+==Usage==
-# <tt>local-config.csv</tt>
-#: '''optional''', preferably symlinked to an in-repo site specific config file (e.g. <tt>[http://hg.mozilla.org/build/puppet/file/default/manifests/extlookup/seamonkey-config.csv seamonkey-config.csv]</tt>)
-# <tt>default-config.csv</tt>
-#: stored directly in puppet, and should contain reasonable defaults.
-# <tt>moco-config.csv</tt>, <tt>seamonkey-config.csv</tt>
-#: User-specific configuration (more can be added).  These are generally linked to by local-config.csv.
-# <tt>supplied-config.csv</tt>
-#: '''optional''' lower precedence than local-config.csv, this can be used for automated creation of config.  Within mozilla we use this to inject configuration from the puppet instance that builds our puppetmasters (don't think about that too hard!)
-# <tt>secrets.csv</tt>
-#: Necessarily not stored in hg as this file contains secrets (e.g. password hashes). For simplicity we have a <tt>secrets.csv.in</tt> file in this directory that can be copied over and have the secrets added.
-== Manifests ==
-=== Config ===
-====Usage====
 '''in manifests'''
   class foo {
@@ Line 33: / Line 17: @@
   Username is <%= scope.lookupvar('::config::builder_username') %>
-==== Variables ====
+==Variables ==
-;'''puppet_notif_email'''
+The available configuration variables are all listed in <tt>modules/config/manifests/base.pp</tt>; refer to that file for the most up-to-date information.
-:The e-mail address or list to send errors of the puppet daemon to. ''(Defaults to <tt>dustin@mozilla.com</tt>)''
-;'''puppet_server'''
-:The hostname of the puppet master we should connect to. Qualified or unqualified hostnames are acceptable. ''(Defaults to <tt>puppet</tt>)''
-;'''puppet_servers'''
-:A list of all puppet servers, so clients can try other servers if <tt>puppet_server</tt> is down ''(Defaults to a one-element list containing the value of <tt>puppet_server</tt>)''
-;'''data_server'''
-:The hostname of the [[ReleaseEngineering/PuppetAgain/Data|data]] server ''(Defaults to the <tt>repos</tt>)''
-;'''data_server'''
-:A list of all [[ReleaseEngineering/PuppetAgain/Data|data]] servers ''(Defaults to a one-element list containing <tt>data_server</tt>)''
-;'''builder_username'''
-:The username for the build and test slaves ''(Defaults to <tt>cltbld</tt>)''
-;'''nrpe_allowed_hosts'''
-:A comma-separated list of IPs from which NRPE should accept check requests (added in {{bug|733545}})
-;'''relay_domains'''
-:The fqdn where your smarthost will send  mail (added in {{bug|733536}})
-=== Config::Secrets ===
-The Secrets module handles all the secret config options, for clarity. It is imported directly by the config module, for simplicity throughout.
-====Usage====
-'''in manifests'''
- class foo {
-   include ::config
-   if ($::config::secrets::builder_password == "")
-      fail("missing password")
-   }
- }
-'''in strings''' (note use of empty namespace designation)
- Hash is ${::config::secrets::builder_password}
-==== Variables ====
+==Functions==
-;'''root_pw_hash'''
+This module also defines the <tt>secret</tt> function; see [[ReleaseEngineering/PuppetAgain/Secrets]].
-:linux md5 password hash for the root password ''(No Default)''
-;'''builder_pw_hash'''
-:linux md5 password hash for the builder user ''(No Default)''

ReleaseEngineering/PuppetAgain/Modules/config: Difference between revisions

Latest revision as of 20:18, 7 November 2013

Contents

Summary

Usage

Variables

Functions