Forge Home

nimbus

Single-system Puppetized configuration utility

11,718 downloads

7,408 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.7.1 (latest)
  • 0.7.0
  • 0.6.4
  • 0.6.3
  • 0.6.2
  • 0.6.1
  • 0.6.0
  • 0.5.2
  • 0.5.1
  • 0.5.0
released Nov 28th 2015
This version is compatible with:
  • Puppet Enterprise >=2015.2.0
  • Puppet >=4.2.1
  • , , , , , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'tse-nimbus', '0.6.4'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add tse-nimbus
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install tse-nimbus --version 0.6.4

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

tse/nimbus — version 0.6.4 Nov 28th 2015

Nimbus

This module provides a new Puppet command, puppet nimbus.

When puppet nimbus apply is run, Puppet will set the runtime $environmentpath to $nimbus_environmentpath, set the runtime $environment to $nimbus_environment, and read $nimbus_config. A custom node terminus will be switched to that reads classes from the classes config key. A custom data terminus will be used to bind data from the data config key. The $nimbus_environment will be populated to match the modules defined in the modules config key. With this configuration primed, Puppet will be run.

The end result is that users may define a single text file or set of text files to be merged that list all the modules they want, the data they want, and the classes they want applied to their local machine. They may then use the puppet nimbus command to easily puppetize their system from that input.

Note that alternatively, a confdir may be specified, in which case all .conf files inside the confdir will be read and merged into a compositional configuration. This allows for things such as starting from a common configuration and adding in personal customization by including an additional file.

New users can get started with a config provided by their company or team.

Examples

Basic

Assume that the Puppet AIO package has just been installed and nothing else. This is an example of bootstrapping a nimbus configuration. Try it!

puppet module install tse/nimbus
curl -Lo example.conf https://git.io/vZBXu
puppet nimbus install_modules example.conf
puppet nimbus apply example.conf

Or:

puppet module install tse/nimbus
puppet nimbus install_modules https://git.io/vZBXu
puppet nimbus apply https://git.io/vZBXu

Or just:

puppet module install tse/nimbus
puppet nimbus apply https://git.io/vZBXu

Note on OSX: due to https://tickets.puppetlabs.com/browse/PUP-3450 it is necessary to update root CA bundles used by Puppet to get the module tool working (to install modules). The following can be used to do that:

export OPENSSL=/opt/puppetlabs/puppet/bin/openssl
sudo /opt/puppetlabs/puppet/bin/c_rehash /opt/puppetlabs/puppet/lib/ruby/2.1.0/rubygems/ssl_certs
export SSL_CERT_DIR=/opt/puppetlabs/puppet/lib/ruby/2.1.0/rubygems/ssl_certs

As long as SSL_CERT_DIR is set correctly any Puppet command that needs access to the > Forge will work.

With Existing Modules

In the event an r10k control repo is used to define the environment, nimbus may be used for classification and data while referencing the environment r10k sets up.

r10k puppetfile install /path/to/prod/Puppetfile
puppet module install tse/nimbus
curl -Lo example.conf http://git.io/vZBXu

r10k of course isn't strictly necessary. Any means of populating the modules will work.

After the modules have been configured, use one of:

puppet nimbus apply example.conf --modulepath=/path/to/prod/modules

or

puppet nimbus apply example.conf --environmentpath=/path/to --environment=prod

Directory structure

$codedir/
|-- environments/
`-- nimbus_environments/    # $nimbus_environmentpath
    `-- default                  # $nimbus_environment
        |-- manifests/
        |   `-- site.pp
        |-- modules/
        `-- hieradata/

$confdir/
`-- nimbus/               # $nimbus_confdir
    `-- nimbus.conf         # $nimbus_config

Configuration File

# nimbus.conf (hocon)
classes: [
  "stdlib::stages",
  "nimbus::test",
]

data: {
  "nimbus::test::arg1": "example",
  "nimbus::test::arg2": "like hiera data",
}

modules: {
  "puppetlabs/stdlib": {
    "version": "4.9.0",
  },
  "tse/nimbus": {
    "version": "0.5.0",
  },
  "lwf/remote_file": {
    "type": "tarball",
    "source": "https://github.com/lwf/puppet-remote_file/archive/v1.0.1.tar.gz",
    "version": "1.0.1",
  }
}