Forge Home

hyperglass

installs, configures, and manages hyperglass

1,506 downloads

1,506 latest version

4.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

  • 1.0.0 (latest)
released Jun 17th 2021
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
  • Puppet >= 6.1.0 < 8.0.0
  • , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-hyperglass', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-hyperglass
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-hyperglass --version 1.0.0

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

puppet/hyperglass — version 1.0.0 Jun 17th 2021

puppet-hyperglass

CI Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores puppetmodule.info docs AGPL v3 License

Table of contents

Hyperglass Setup

Hyperglass is shipped as a python package. This Puppet module can install all the required services:

  • nginx
  • redis
  • npm
  • yarn

And hyperglass itself. It ships gunicorn as a webserver. nginx is used as a reverse proxy.

Examples

In case you want this module to manage all the required services, simply do:

include hyperglass::server

In your puppet code. If this is a box with multiple applications, you might want to manage the required services on your own. In this case you can do:

class { 'hyperglass::server':
  manage_depended_services => false,
}

hyperglass needs a list of devices to talk to. You can pass the hash from the docs to the $devices parameter. It will be converted to yaml and written to the config file.

The same applies for the generic hyperglass server configuration ($data attribute) and specific commands for the devices $commands attribute).

class { 'hyperglass::server':
  data     => {...},
  commands => {...},
  devices  => {...},
}

Please take a look at the official hyperglass documentation.

It explains the three different options very well. You can pass the hashes from the documentation 1:1 to the three parameters.

Tests

This module has several unit tests and linters configured. You can execute them by running:

bundle exec rake test

Detailed instructions are in the CONTRIBUTING.md file.

Contributions

Contribution is fairly easy:

  • Fork the module into your namespace
  • Create a new branch
  • Commit your bugfix or enhancement
  • Write a test for it (maybe start with the test first)
  • Create a pull request

Detailed instructions are in the CONTRIBUTING.md file.

License and author

This module was originally written by Tim Meusel. It's licensed with AGPL version 3.