Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with nsq
- Setup requirements
- Beginning with nsq
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
Installs and configures NSQ [http://nsq.io]
Module Description
The NSQ module installs, configures and optionally sets up a service for running NSQ on Ubuntu 16.04 and Centos 7.
Setup
Setup Requirements
- wget module - [https://forge.puppet.com/maestrodev/wget]
Beginning with nsq
include nsq
include nsq::nsqlookupd
include nsq::nsqadmin
include nsq::nsqd
include nsq::nsqlookupd
include nsq::nsqadmin
include nsq::nsqd
Usage
Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.
Reference
Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)
Limitations
Currently only tested on Ubuntu 16.04, Centos 7, Puppet 4.x, and Puppet 5.x.