Skip to content

Latest commit

 

History

History
103 lines (64 loc) · 4.56 KB

configuration-enc.md

File metadata and controls

103 lines (64 loc) · 4.56 KB
Raw

Configuring octocatalog-diff to use ENC

If you use an External Node Classifier (ENC) on your Puppet master, you should configure octocatalog-diff to use the same ENC when it compiles catalogs.

Before you start, please understand how octocatalog-diff compiles a catalog:

  • It creates a temporary directory (e.g. /var/tmp/puppet-compile-dir-92347829847)
  • It copies or creates hiera configuration, ENC, PuppetDB configuration, etc., in the temporary directory
  • It symlinks /var/tmp/puppet-compile-dir-92347829847/environments/production to your code
  • It compiles the catalog, based on the temporary directory, for environment=production
  • It removes the temporary directory

NOTE: If you are using the built-in node classification in Puppet Enterprise, you don't need to worry about any of this. Instead, please read about Puppet Enterprise as your ENC.

Configuring the path to the ENC

The command line option --enc PATH allows you to set the path to your ENC script.

You may specify this as either an absolute or a relative path.

  • As a relative path

    octocatalog-diff knows to use a relative path when the supplied path for --enc does not start with a /.

    bin/octocatalog-diff --enc config/enc.sh ...

    The path is relative to a checkout of your Puppet repository. As per the example in the introduction, say that octocatalog-diff is using a temporary directory of /var/tmp/puppet-compile-dir-92347829847 when compiling a Puppet catalog. With the setting above, it will copy config/enc.sh (relative to your Puppet checkout) into the temporary directory.

    If you are specifying the ENC path in the configuration file, you will instead set the variable like this:

    settings[:enc] = 'config/enc.sh'

    octocatalog-diff will fail if you specify a ENC location that cannot be opened.

  • As an absolute path

    octocatalog-diff knows to use a relative path when the supplied path for --enc starts with a /.

    For example:

    bin/octocatalog-diff --enc /etc/puppetlabs/puppet/enc.sh ...

    If you are specifying the ENC path in the configuration file, you will instead set the variable like this:

    settings[:enc] = '/etc/puppetlabs/puppet/enc.sh'

    Please note that octocatalog-diff will copy the file from the specified location into the compile directory. Since this ENC file is not copied from your Puppet repo, there is no way to compile the "to" and "from" branches using different ENC scripts. Furthermore, you are responsible for getting this file into place on any machine that will run octocatalog-diff.

    We strongly recommend that you version-control your ENC script within your Puppet repository, and use the relative path option described above.

Executing the ENC

When Puppet runs the ENC, it will do so with one argument (the node name for which you are compiling the catalog).

For example, when compiling the catalog for some-node.github.net, Puppet will effectively execute this command:

/etc/puppetlabs/puppet/enc.sh some-node.github.net

Sometimes the ENC script requires credentials or makes other assumptions about the system on which it is running. To be able to run the ENC script on systems other than your Puppet master, you will need to ensure that any such credentials are supplied and other assumptions are met.

Environment

When the ENC is executed, the following environment variables are set to match the environment of the shell in which octocatalog-diff executes:

  • HOME
  • PATH
  • PWD (set to the temporary directory as previously described)

No other environment variables are passed from the shell. If you wish to pass additional environment variables, you must explicitly list them with the --pass-env-vars CLI flag or settings[:pass_env_vars] array in your configuration file.

As an example, consider that your ENC is written in Python, and needs the PYTHONPATH variable set to /usr/local/lib/python-custom. Even if this environment variable is set when octocatalog-diff is run, it will not be available to the ENC script. You may pass the variable via the command line:

octocatalog-diff --pass-env-vars PYTHONPATH ...

Or you may specify it in your configuration file:

settings[:pass_env_vars] = [ 'PYTHONPATH' ]

If you wish to specify multiple environment variables to pass:

octocatalog-diff --pass-env-vars PYTHONPATH,SECONDVAR,THIRDVAR ...

or

settings[:pass_env_vars] = [ 'PYTHONPATH', 'SECONDVAR', 'THIRDVAR' ]