Forge Home

nginx_proxy

This module helps create a simple Nginx proxy

6,467 downloads

6,467 latest version

4.3 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 Oct 11th 2016
This version is compatible with:
  • Puppet Enterprise 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 2.7.0 < 5.0.0
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'genebean-nginx_proxy', '1.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add genebean-nginx_proxy
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install genebean-nginx_proxy --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
Tags: nginx

Documentation

genebean/nginx_proxy — version 1.0.0 Oct 11th 2016

Build Status Puppet Forge GitHub tag

nginx_proxy

Table of Contents

  1. Overview
  2. Setup requirements
  3. Beginning with nginx_proxy
  4. Settings
  5. License
  6. Contributing

Overview

This module is a small utility module that does nothing but configure nginx.conf. It is designed to make Nginx act as a reverse proxy similar to the one in https://github.com/genebean/nginx-uri-proxy.

Setup requirements

Nginx must be installed and its services must be managed elsewhere. The required_packages parameter can be used to make sure this runs after the package is installed.

Beginning with nginx_proxy

The bulk of the settings for this module are contained in a pair of hashes. It is recommended to take advantage of Hiera to store these as it takes a lot less effort than creating the same structure in a manifest.

Settings

Below are all the settings this module uses and their default values.

Module-specific settings

$locations                 = [],
$required_packages         = ['nginx'],
$upstreams                 = [],

locations

This is a hash that correlates to the location blocks in nginx.conf.

  • order: Controls what order the blocks are placed in the config (required)
  • exact: Whether the path matching is an exact match or a starts with match (required)
  • path: The path the location block matches (required)
  • redirect: Whether the path redirects to https or not (required)
  • http_upstream: If redirect is false then this is the upstream used (optional)
  • https_upstream: The upstream to use for https connections (required)

upstreams

  • title: The name of the upstream (required)
  • lb_method: The load balancing algorithm to use (optional)
  • servers: An array of servers to send the traffic to (required)
Examples:
locations => [
  {
    order          => '001',
    exact          => true,
    path           => '/',
    redirect       => true,
    https_upstream => 'new_backend_https',
  },
  {
    order          => '002',
    exact          => true,
    path           => '/index.php',
    redirect       => true,
    https_upstream => 'new_backend_https',
  },
  {
    order          => '003',
    exact          => false,
    path           => '/part1',
    redirect       => true,
    https_upstream => 'new_backend_https',
  },
  {
    order          => '004',
    exact          => true,
    path           => '/part2/special/page.php',
    redirect       => true,
    https_upstream => 'new_backend_https',
  },
  {
    order          => '999',
    exact          => false,
    path           => '/',
    redirect       => false,
    http_upstream  => 'old_backend_http',
    https_upstream => 'old_backend_https',
  },
  {
    order          => '005',
    exact          => false,
    path           => '/part3',
    redirect       => true,
    https_upstream => 'new_backend_https',
  },
],
upstreams => [
  {
    title   => 'old_backend_http',
    servers => [
      '127.0.0.1:8081',
    ],
  },
  {
    title   => 'old_backend_https',
    servers => [
      '127.0.0.1:8444',
    ],
  },
  {
    title     => 'new_backend_https',
    lb_method => 'ip_hash',
    servers   => [
      '127.0.0.1:9444',
      '127.0.0.1:10444',
    ],
  },
],
---
nginx_proxy::locations:
  - order          : '001'
    exact          : true
    path           : '/'
    redirect       : true
    https_upstream : 'new_backend_https'
  - order          : '999'
    exact          : false
    path           : '/'
    redirect       : false
    http_upstream  : 'old_backend_http'
    https_upstream : 'old_backend_https'
nginx_proxy::upstreams:
  - title   : 'old_backend_http'
    servers :
      - '127.0.0.1:8081'
  - title   : 'old_backend_https'
    servers :
      - '127.0.0.1:8444'
  - title     : 'new_backend_https'
    lb_method : 'ip_hash'
    servers   :
      - '127.0.0.1:9444'
      - '127.0.0.1:10444'

Nginx-specific settings

$access_log                = '/var/log/nginx/access.log',
$config_file               = '/etc/nginx/nginx.conf',
$docroot                   = '/usr/share/nginx/html',
$dynamic_modules           = '/usr/share/nginx/modules/*.conf',
$error_log                 = '/var/log/nginx/error.log',
$mime_include              = '/etc/nginx/mime.types',
$pid_file                  = '/run/nginx.pid',
$port_http                 = 80,
$port_https                = 443,
$server_name              = '_',
$ssl_certificate           = '/etc/pki/tls/certs/localhost.crt',
$ssl_certificate_key       = '/etc/pki/tls/private/localhost.key',
$ssl_session_cache         = 'shared:SSL:1m',
$ssl_session_timeout       = '10m',
$ssl_ciphers               = 'HIGH:!aNULL:!MD5',
$ssl_prefer_server_ciphers = 'on',
$user                      = 'nginx',
$worker_connections        = 1024,
$worker_processes          = 'auto',

License

This is released under the New BSD / BSD-3-Clause license. A copy of the license can be found in the root of the module.

Contributing

Pull requests are welcome!