nginx-repo Cookbook

Installs/Configures NGINX Vendor-Specific Repositories.

This cookbook installs & configures NGINX repositories per
http://nginx.org/en/linux_packages.html for apt and yum.

Requirements

• Chef 11 or higher
• Ruby 1.9 or higher (preferably from the Chef full-stack installer)
• Network accessible package repositories
• apt Cookbook (only executed on Debian-ish platforms)
• yum Cookbook (only executed on RHEL platforms)

Attributes

nginx-repo::default

The default recipe installs & configures NGINX repositories per
http://nginx.org/en/linux_packages.html for apt and yum.

Per http://wiki.nginx.org/Install, there are currently two versions of NGINX.
The mainline branch gets new features and bugfixes sooner but might introduce
new bugs as well. Critical bugfixes are backported to the stable branch. In
general, the stable release is recommended, but the mainline release is
typically quite stable as well.

• ['nginx-repo']['nginx-stable']['managed']
  • Type: Boolean
  • Description: Does this cookbook manage the install of the NGINX Stable Repo?
  • Default: true
• ['nginx-repo']['nginx-mainline']['managed']
  • Type: Boolean
  • Description: Does this cookbook manage the install of the NGINX Mainline Repo?
  • Default: false

nginx-repo::_apt

The apt recipe is for installing & configuring the NGINX apt repostories. Any
attribute supported by the apt cookbook
is supported by this cookbook and can be used to override attributes in this
cookbook.

• ['nginx-repo']['debian']['supported-codenames']

  • Type: Hash
  • Description:

  Debian-ish platform support for this cookbook and the NGINX repository.
  Designed to be a private attribute however it can be overridden in the case
  NGINX supports additional platforms and this cookbook has not been updated
  yet.

  This check was implemented as a result of the repo could be successfully
  installed yet not be valid for a given platform and an NGINX package could
  be successfully installed as a result of it being available natively on the
  platform it which it was run which results in a false positive for the
  consumer of the cookbook.

  The hash key is the codename of the OS/version. If the hash value evaluates
  to true, the OS/version is considered supported.
  - Default:

  {
    squeeze: true,  # Debian 6.x
    wheezy:  true,  # Debian 7.x
    jessie:  true,  # Debian 8.x
    lucid:   true,  # Ubuntu 10.04
    precise: true,  # Ubuntu 12.04
    trusty:  true,  # Ubuntu 14.04
    utopic:  true   # Ubuntu 14.10
  }
  

• ['nginx-repo']['nginx-stable']['apt']['uri']

  • Type: String
  • Description: URI of NGINX Stable Repo
  • Default: http://nginx.org/packages/#{node['platform']}

• ['nginx-repo']['nginx-stable']['apt']['distribution']

  • Type: String
  • Description: Package distribution of NGINX Stable Repo
  • Default: node['lsb']['codename']

• ['nginx-repo']['nginx-stable']['apt']['components']

  • Type: Array
  • Description: NGINX Stable Repo Package Groupings
  • Default: ['nginx']

• ['nginx-repo']['nginx-stable']['apt']['key']

  • Type: String
  • Description: Cookbook File for NGINX Stable Repo Signing Key
  • Default: nginx_signing.key

• ['nginx-repo']['nginx-stable']['apt']['deb-src']

  • Type: Boolean
  • Description: Whether or not to include the NGINX Stable Source Repo?
  • Default: false

• ['nginx-repo']['nginx-mainline']['apt']['uri']

  • Type: String
  • Description: URI of NGINX Mainline Repo
  • http://nginx.org/packages/mainline/#{node['platform']}

• ['nginx-repo']['nginx-mainline']['apt']['distribution']

  • Type: String
  • Description: Package distribution of NGINX Mainline Repo
  • Default: node['lsb']['codename']

• ['nginx-repo']['nginx-mainline']['apt']['components']

  • Type: Array
  • Description: NGINX Mainline Repo Package Groupings
  • Default: ['nginx']

• ['nginx-repo']['nginx-mainline']['apt']['key']

  • Type: String
  • Description: Cookbook File for NGINX Mainline Repo Signing Key
  • Default: nginx_signing.key

• ['nginx-repo']['nginx-mainline']['apt']['deb-src']

  • Type: Boolean
  • Description: Whether or not to include the NGINX Mainline Source Repo?
  • Default: false

nginx-repo::_yum

The yum recipe is for installing & configuring the NGINX yum repostories. Any
attribute supported by the yum cookbook
is supported by this cookbook and can be used to override attributes in this
cookbook.

• ['nginx-repo']['rhel']['supported-versions']

  • Type: Hash
  • Description:

  RHEL platform support for this cookbook and the NGINX repository. Designed
  to be a private attribute however it can be overridden in the case NGINX
  supports additional platforms and this cookbook has not been update yet.

  This check was implemented as a result of the repo could be successfully
  installed yet not be valid for a given platform and an NGINX package could
  be successfully installed as a result of it being available natively on the
  platform it which it was run which results in a false positive for the
  consumer of the cookbook.

  The hash key is the codename of the OS/version. If the hash value evaluates
  to true, the OS/version is considered supported.
  - Default:

  {
    '5' => true,
    '6' => true,
    '7' => true
  }
  

• ['nginx-repo']['nginx-stable-source']['managed']

  • Type: Boolean
  • Description: Does this cookbook manage the install of the NGINX Stable Source Repo?
  • Default: false

• ['nginx-repo']['nginx-mainline-source']['managed']

  • Type: Boolean
  • Description: Does this cookbook manage the install of the NGINX Mainline Source Repo?
  • Default: false

• ['nginx-repo']['nginx-stable']['yum']['repositoryid']

  • Type: String
  • Description: Unique Name for NGINX Stable Repo
  • Default: nginx-stable

• ['nginx-repo']['nginx-stable']['yum']['description']

  • Type: String
  • Description: Description of NGINX Stable Repo
  • Default: nginx stable repo

• ['nginx-repo']['nginx-stable']['yum']['baseurl']

  • Type: String
  • Description: URL of NGINX Stable Repo
  • Default: http://nginx.org/packages/#{node['platform']}/#{node['platform_version'].to_i}/$basearch/

• ['nginx-repo']['nginx-stable']['yum']['gpgcheck']

  • Type: Boolean
  • Description: Whether or not NGINX Stable Repo should perform GPG check of packages?
  • Default: false

• ['nginx-repo']['nginx-stable']['yum']['sslverify']

  • Type: Boolean
  • Description: Whether or not yum will verify the NGINX Stable Repo SSL host?
  • Default: false

• ['nginx-repo']['nginx-stable']['yum']['enabled']

  • Type: Boolean
  • Description: Whether or not the NGINX Stable Repo is enabled?
  • Default: true

• ['nginx-repo']['nginx-stable-source']['yum']['repositoryid']

  • Type: String
  • Description: Unique Name for NGINX Stable Source Repo
  • Default: nginx-stable-source

• ['nginx-repo']['nginx-stable-source']['yum']['description']

  • Type: String
  • Description: Description of NGINX Stable Source Repo
  • Default: nginx stable source repo

• ['nginx-repo']['nginx-stable-source']['yum']['baseurl']

  • Type: String
  • Description: URL of NGINX Stable Source Repo
  • Default: http://nginx.org/packages/#{node['platform']}/#{node['platform_version'].to_i}/SRPMS/

• ['nginx-repo']['nginx-stable-source']['yum']['gpgcheck']

  • Type: Boolean
  • Description: Whether or not NGINX Stable Source Repo should perform GPG check of packages?
  • Default: false

• ['nginx-repo']['nginx-stable-source']['yum']['sslverify']

  • Type: Boolean
  • Description: Whether or not yum will verify the NGINX Stable Source Repo SSL host?
  • Default: false

• ['nginx-repo']['nginx-stable-source']['yum']['enabled']

  • Type: Boolean
  • Description: Whether or not the NGINX Stable Source Repo is enabled?
  • Default: true

• ['nginx-repo']['nginx-mainline']['yum']['repositoryid']

  • Type: String
  • Description: Unique Name for NGINX Mainline Repo
  • Default: nginx-mainline

• ['nginx-repo']['nginx-mainline']['yum']['description']

  • Type: String
  • Description: Description for NGINX Mainline Repo
  • Default: nginx mainline repo

• ['nginx-repo']['nginx-mainline']['yum']['baseurl']

  • Type: String
  • Description: URL of NGINX Mainline Repo
  • Default: http://nginx.org/packages/mainline/#{node['platform']}/#{node['platform_version'].to_i}/$basearch/

• ['nginx-repo']['nginx-mainline']['yum']['gpgcheck']

  • Type: Boolean
  • Description: Whether or not NGINX Mainline Repo should perform GPG check of packages?
  • Default: false

• ['nginx-repo']['nginx-mainline']['yum']['sslverify']

  • Type: Boolean
  • Description: Whether or not yum will verify the NGINX Mainline Repo SSL host?
  • Default: false

• ['nginx-repo']['nginx-mainline']['yum']['enabled']

  • Type: Boolean
  • Description: Whether or not the NGINX Mainline Repo is enabled?
  • Default: true

• ['nginx-repo']['nginx-mainline-source']['yum']['repositoryid']

  • Type: String
  • Description: Unique Name for NGINX Mainline Source Repo
  • Default: nginx-mainline-source

• ['nginx-repo']['nginx-mainline-source']['yum']['description']

  • Type: String
  • Description: Description of NGINX Mainline Source Repo
  • Default: nginx mainline source repo

• ['nginx-repo']['nginx-mainline-source']['yum']['baseurl']

  • Type: String
  • Description: URL of NGINX Mainline Source Repo
  • Default: http://nginx.org/packages/mainline/#{node['platform']}/#{node['platform_version'].to_i}/SRPMS/

• ['nginx-repo']['nginx-mainline-source']['yum']['gpgcheck']

  • Type: Boolean
  • Description: Whether or not NGINX Mainline Source Repo should perform GPG check of packages?
  • Default: false

• ['nginx-repo']['nginx-mainline-source']['yum']['sslverify']

  • Type: Boolean
  • Description: Whether or not yum will verify the NGINX Mainline Source Repo SSL host?
  • Default: false

• ['nginx-repo']['nginx-mainline-source']['yum']['enabled']

  • Type: Boolean
  • Description: Whether or not the NGINX Mainline Source Repo is enabled?
  • Default: true

Usage

nginx-repo::default

Just include nginx-repo in your node's run_list:

{
  "name":"my_node",
  "run_list": [
    "recipe[nginx-repo]"
  ]
}

Contributing

1. Fork the repository on GitHub
2. Create a named feature branch (like add_component_x)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using GitHub

Development Environment

This repository contains a Vagrantfile which can be used to spin up a
fully configured development environment in Vagrant.

Vagrant requires the following:
- VirtualBox
- Vagrant

The Vagrant environment for this repository is based on:
- st-isidore-de-seville/trusty64-rvm-docker

The Vagrant environment will initialize itself to:
- install required Ruby gems
- run integration testing via kitchen-docker when calling kitchen

The Vagrant environment can be spun up by performing the following commands:

1. vagrant up
2. vagrant ssh
3. cd /vagrant

Authors

• Author:: St. Isidore de Seville (st.isidore.de.seville@gmail.com)

License

The MIT License (MIT)

Copyright (c) 2015 St. Isidore de Seville (st.isidore.de.seville@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.