Adoptable Cookbooks List

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

aix

amazon

centos

debian

fedora

freebsd

gentoo

mac_os_x

omnios

openbsd

opensuse

opensuseleap

oracle

redhat

ubuntu

scientific

smartos

solaris

suse

windows

zlinux

The chef_nginx
cookbook has been deprecated

The chef_nginx cookbook has been deprecated and is no longer
being maintained by its authors. Use of the chef_nginx
cookbook is no longer recommended.
You may find that the nginx
cookbook is a suitable alternative.

nginx Cookbook

Installs nginx from package OR source code and sets up configuration handling similar to Debian's Apache2 scripts.

nginx vs. chef_nginx

This cookbook is a fork from the 2.7.x branch of the community nginx cookbook. This branch will be actively supported by Chef Software.

We will continue to migrate the cookbook to a more resource driven model, with incremental changes that are non-breaking when possible.

If this cookbook is eventually merged into the nginx namespace on the supermarket, this chef_nginx cookbook will receive updates in parallel (mirroring) in order to minimize disruption to users that have adopted this cookbook.

Requirements

Cookbooks

The following cookbooks are direct dependencies because they're used for common "default" functionality.

build-essential for source installations

ohai for setting up the ohai plugin

runit for source installs

compat_resource for setting up the Nginx.org repository on Chef 12.1 - 12.13

yum-epel for setting up the EPEL repository on RHEL platforms

zypper for setting up the Nginx.org repository on Suse platforms

Platforms

The following platforms are supported and tested with Test Kitchen:

Ubuntu 12.04+

CentOS 5+

Debian 7+

openSUSE 13.2+

FreeBSD 9+

Other Debian and RHEL family distributions are assumed to work.

Chef

Chef 12.1+

Attributes

Node attributes for this cookbook are logically separated into different files. Some attributes are set only via a specific recipe.

default

Generally used attributes. Some have platform specific values. See attributes/default.rb. "The Config" refers to "nginx.conf" the main config file.

node['nginx']['dir'] - Location for Nginx configuration.

node['nginx']['conf_template'] - The source template to use when creating the nginx.conf.

node['nginx']['init_style'] - How to run Nginx as a service when using chef_nginx::source. Values can be "runit", "upstart", or "init". When using runit that recipes will be included as well. Recipes are not included for upstart, it is assumed that upstart is built into the platform you are using (ubuntu). This attribute is not used in the nginx recipe because the package manager's init script style for the platform is assumed. Upstart is never set as a default as this represents a change in behavior, if you are running ubuntu or el6 and want to use upstart, please set this attribute in a role or similar.

node['nginx']['upstart']['foreground'] - Set this to true if you want upstart to run nginx in the foreground, set to false if you want upstart to detach and track the process via pid.

node['nginx']['upstart']['runlevels'] - String of runlevels in the format '2345' which determines which runlevels nginx will start at when entering and stop at when leaving.

node['nginx']['upstart']['respawn_limit'] - Respawn limit in upstart stanza format, count followed by space followed by interval in seconds.

node['nginx']['pid'] - Location of the PID file.

node['nginx']['keepalive'] - Whether to use keepalive_timeout, any value besides "on" will leave that option out of the config.

node['nginx']['keepalive_requests'] - used for config value of keepalive_requests.

node['nginx']['keepalive_timeout'] - used for config value of keepalive_timeout.

node['nginx']['worker_processes'] - used for config value of worker_processes.

node['nginx']['worker_rlimit_nofile'] - used for config value of worker_rlimit_nofile. Can replace any "ulimit -n" command. The value depend on your usage (cache or not) but must always be superior than worker_connections.

node['nginx']['multi_accept'] - used for config value of events { multi_accept }. Try to accept() as many connections as possible. Disable by default.

node['nginx']['event'] - used for config value of events { use }. Set the event-model. By default nginx looks for the most suitable method for your OS.

node['nginx']['accept_mutex_delay'] - used for config value of accept_mutex_delay

node['nginx']['server_tokens'] - used for config value of server_tokens.

node['nginx']['server_names_hash_bucket_size'] - used for config value of server_names_hash_bucket_size.

node['nginx']['disable_access_log'] - set to true to disable the general access log, may be useful on high traffic sites.

node['nginx']['access_log_options'] - Set to a string of additional options to be appended to the access log directive

node['nginx']['error_log_options'] - Set to a string of additional options to be appended to the error log directive

node['nginx']['default_site_enabled'] - enable the default site

node['nginx']['sendfile'] - Whether to use sendfile. Defaults to "on".

node['nginx']['tcp_nopush'] - Whether to use tcp_nopush. Defaults to "on".

node['nginx']['tcp_nodelay'] - Whether to use tcp_nodelay. Defaults to "on".

node['nginx']['install_method'] - Whether nginx is installed from packages or from source.

node['nginx']['types_hash_max_size'] - Used for the types_hash_max_size configuration directive.

node['nginx']['types_hash_bucket_size'] - Used for the types_hash_bucket_size configuration directive.

node['nginx']['proxy_read_timeout'] - defines a timeout (between two successive read operations) for reading a response from the proxied server.

node['nginx']['client_body_buffer_size'] - used for config value of client_body_buffer_size.

node['nginx']['client_max_body_size'] - specifies the maximum accepted body size of a client request, as indicated by the request header Content-Length.

node['nginx']['repo_source'] - when installed from a package this attribute affects which yum repositories, if any, will be added before installing the nginx package. The default value of 'epel' will use the yum-epel cookbook, 'nginx' will use the chef_nginx::repo recipe, 'passenger' will use the 'chef_nginx::repo_passenger' recipe, and setting no value will not add any additional repositories.

node['nginx']['rate_limiting_backoff'] - sets the backoff time for limit_req_zone.

node['nginx']['rate_limit'] - set the rate limit amount for limit_req_zone.

gzip module

node['nginx']['gzip'] - Whether to use gzip, can be "on" or "off"

node['nginx']['gzip_http_version'] - used for config value of gzip_http_version.

node['nginx']['gzip_comp_level'] - used for config value of gzip_comp_level.

node['nginx']['gzip_proxied'] - used for config value of gzip_proxied.

node['nginx']['gzip_vary'] - used for config value of gzip_vary.

node['nginx']['gzip_buffers'] - used for config value of gzip_buffers.

node['nginx']['gzip_types'] - used for config value of gzip_types - must be an Array.

node['nginx']['gzip_min_length'] - used for config value of gzip_min_length.

node['nginx']['gzip_disable'] - used for config value of gzip_disable.

node['nginx']['gzip_static'] - used for config value of gzip_static (http_gzip_static_module must be enabled)

### Attributes set in recipes

chef_nginx::source

node['nginx']['daemon_disable'] - Whether the daemon should be disabled which can be true or false; disable the daemon (run in the foreground) when using a service supervisor such as runit for "init_style". This is automatically set in the chef_nginx::source recipe when the init style is not runit.

chef_nginx::http_realip_module

node['nginx']['realip']['header'] - Header to use for the RealIp Module; only accepts "X-Forwarded-For" or "X-Real-IP"

node['nginx']['realip']['addresses'] - Addresses to use for the http_realip configuration.

node['nginx']['realip']['real_ip_recursive'] - If recursive search is enabled, the original client address that matches one of the trusted addresses is replaced by the last non-trusted address sent in the request header field. Can be on "on" or "off" (default).

source

These attributes are used in the chef_nginx::source recipe. Some of them are dynamically modified during the run. See attributes/source.rb for default values.

node['nginx']['source']['url'] - (versioned) URL for the Nginx source code. By default this will use the version specified as node['nginx']['version'].

node['nginx']['source']['conf_path'] - location of the main config file, in node['nginx']['dir'] by default.

node['nginx']['source']['modules'] - Array of modules that should be compiled into Nginx by including their recipes in chef_nginx::source.

node['nginx']['source']['default_configure_flags'] - The default flags passed to the configure script when building Nginx.

node['nginx']['configure_flags'] - Preserved for compatibility and dynamically generated from the node['nginx']['source']['default_configure_flags'] in the chef_nginx::source recipe.

node['nginx']['source']['use_existing_user'] - set to true if you do not want chef_nginx::source recipe to create system user with name node['nginx']['user'].

geoip

These attributes are used in the chef_nginx::http_geoip_module recipe. Please note that the country_dat_checksum and city_dat_checksum are based on downloads from a datacenter in Fremont, CA, USA. You really should override these with checksums for the geo tarballs from your node location.

Note The upstream, maxmind.com, may block access for repeated downloads of the data files. It is recommended that you download and host the data files, and change the URLs in the attributes.

node['nginx']['geoip']['path'] - Location where to install the geoip libraries.

node['nginx']['socketproxy']['apps']['app_name']['prepend_slash'] - Prepend a slash to requests to app "app_name" before sending them to the socketproxy socket.

node['nginx']['socketproxy']['apps']['app_name']['context_name'] - URI (e.g. "app_name" in order to achieve "http://mydomain.com/app_name") at which to host the application "app_name"

node['nginx']['socketproxy']['apps']['app_name']['subdir'] - Directory (under node['nginx']['socketproxy']['root']) in which to find the application.

Recipes

This cookbook provides three main recipes for installing Nginx.

default.rb - Use this recipe if you have a native package for Nginx.

repo.rb - The developer of Nginx also maintain stable packages for several platforms.

source.rb - Use this recipe if you do not have a native package for Nginx, or if you want to install a newer version than is available, or if you have custom module compilation needs.

Several recipes are related to the source recipe specifically. See that recipe's section below for a description.

default

The default recipe will install Nginx as a native package for the system through the package manager and sets up the configuration according to the Debian site enable/disable style with sites-enabled using the nxensite and nxdissite scripts. The nginx service will be managed with the normal init scripts that are presumably included in the native package.

Includes the ohai_plugin recipe so the plugin is available.

socketproxy

This will add socketproxy support to your nginx proxy setup. Do not include this recipe directly. Instead, add it to the node['nginx']['default']['modules'] array (see below).

ohai_plugin

This recipe provides an Ohai plugin as a template. It is included by both the default and source recipes.

authorized_ips

Sets up configuration for the authorized_ip nginx module.

source

This recipe is responsible for building Nginx from source. It ensures that the required packages to build Nginx are installed (pcre, openssl, compile tools). The source will be downloaded from the node['nginx']['source']['url']. The node['nginx']['user'] will be created as a system user. If you want to use existing user set node['nginx']['source']['use_existing_user'] to true. The appropriate configuration and log directories and config files will be created as well according to the attributes node['nginx']['dir'] and node['nginx']['log_dir'].

The recipe attempts to detect whether additional modules should be added to the configure command through recipe inclusion (see below), and whether the version or configuration flags have changed and should trigger a recompile.

The nginx service will be set up according to node['nginx']['init_style']. Available options are:

runit: uses runit cookbook and sets up runit_service.

anything else (e.g., "init") will use the nginx init script template.

RHEL/CentOS This recipe should work on RHEL/CentOS with "init" as the init style.

The following recipes are used to build module support into Nginx. To use a module in the chef_nginx::source recipe, add its recipe name to the attribute node['nginx']['source']['modules'].

ipv6.rb - enables IPv6 support

http_echo_module.rb - downloads the http_echo_module module and enables it as a module when compiling nginx.

http_geoip_module.rb - installs the GeoIP libraries and data files and enables the module for compilation.

http_gzip_static_module.rb - enables the module for compilation. Be sure to set node['nginx']['gzip_static'] = 'yes'.

http_perl_module.rb - enables embedded Perl for compilation.

http_realip_module.rb - enables the module for compilation and creates the configuration.

Definitions

nginx_site

Enable or disable a Server Block in #{node['nginx']['dir']}/sites-available by calling nxensite or nxdissite (introduced by this cookbook) to manage the symbolic link in #{node['nginx']['dir']}/sites-enabled.

Parameters:

name - Name of the site.

enable - Default true, which uses nxensite to enable the site. If false, the site will be disabled with nxdissite.

template - (optional) Path to the source for the template resource.

variables - (optional) Variables to be used with the template resource

Adding New Modules

To add a new module to be compiled into nginx in the source recipe, the node's run state is manipulated in a recipe, and the module as a recipe should be added to node['nginx']['source']['modules']. For example:

The recipe will be included by recipe[chef_nginx::source] automatically, adding the configure flags. Add any other configuration templates or other resources as required. See the recipes described above for examples.

Ohai Plugin

The ohai_plugin recipe includes an Ohai plugin. It will be automatically installed and activated, providing the following attributes via ohai, no matter how nginx is installed (source or package):

node['nginx']['version'] - version of nginx

node['nginx']['configure_arguments'] - options passed to ./configure when nginx was built

node['nginx']['prefix'] - installation prefix

node['nginx']['conf_path'] - configuration file path

In the source recipe, it is used to determine whether control attributes for building nginx have changed.

Usage

Include the recipe on your node or role that fits how you wish to install Nginx on your system per the recipes section above. Modify the attributes as required in your role to change how various configuration is applied per the attributes section above. In general, override attributes in the role should be used when changing attributes.

There's some redundancy in that the config handling hasn't been separated from the installation method (yet), so use only one of the recipes, default or source.

Copyright 2008-2016, Chef Software, Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

nginx Cookbook CHANGELOG

This file is used to list changes made in each version of the nginx cookbook.

3.1.0 (2016-09-14)

Resolve FC023 warnings

FreeBSD fixes

Fail hard on unsupported platforms in the source recipe

Install 'ca-certificates' packages with passenger

Add passenger_show_version_in_header config

Remove chef 11 compatibility

Replace apt/yum deps with compat_resource

Fix specs for freebsd source installs

Remove apt recipe from the repo_passenger recipe

Switch to += operator as << also incorrectly replaces text in root.

3.0.0 (2016-08-18)

Breaking changes

Ideally we'd offer perfect backwards compatibility forever, but in order to maintain the cookbook going forward we've evaluated the current scope of the cookbook and removed lesser used functionality that added code complexity.

The minimum chef-client version is now 12.1 or later, which will enables support for Ohai 7+ plugins, the ohai_plugin custom resource, and automatic init system discovery.

Support for Gentoo has been removed. Gentoo lacks an official Chef package and there is no Bento image to use for Test Kitchen integration tests.

Support for the bluepill init system has been removed. Usage of this init system has declined, and supporting it added a cookbook dependency as well as code complexity.

Ubuntu source installs will no longer default to runit, and will instead use either Upstart or Systemd depending on the release of Ubuntu. You can still force the use of runit by setting default['nginx']['init_style'] to 'runit'. Runit was used historically before reliable init systems were shipped with Ubuntu. Both Upstart and Systemd have the concept of restarting on failure, which was the main reason for choosing Runit over sys-v init.

Other changes

Don't setup the YUM EPEL repo on Fedora as it's not needed

Systemd based platforms will now use systemd by default for source installs

Retry downloads of the nginx source file as the mirror sometimes fails to load

Add testing in Travis with Kitchen Dokken for full integration testing of each PR

Add integration test on Chef 12.1 as well as the latest Chef to ensure compatibility with the oldest release we support

Remove installation of apt-transport-https and instead increase the apt dependency to >= 2.9.1 which includes the installation of apt-transport-https

Don't try to setup the nginx.org repo on Fedora as this will fail

Better log when trying to setup repositories on unsupported platforms

Fixed source_url and issue_url in the metadata to point to the correct URLs

Removed Chef 10 compatibility code

Chefspec platform updates and minor fixes

Replace all usage of node.set with node.normal to avoid deprecation notices

Remove the suse init script that isn't used anymore

Speed up the specs with caching

Move test attributes and runlists out the kitchen.yml files and into a test cookbook

2.9.0 (2016-08-12)

Add support for Suse Nginx.org packages

v2.8.0 (2016-08-12)

This is the first release of the nginx codebase under the chef_nginx namespace. We've chosen to bring this cookbook under the direction of the Community Cookbook Team, in order to ship a working 2.X release. The cookbook name has been changed, but all attributes are the same and compatibility has been maintained. After this 2.8.0 release we will release 3.0 as a Chef 12+ version of the cookbook and then work to add additional custom resources for managing nginx with wrapper cookbooks. Expect regular releases as we march towards a resource driven model.

Removed the restrictive version constraints for cookbook dependencies that prevented users from utilizing new functionality. Ohai has been pinned to < 4.0 to allow for Chef 11 compatibility, but other cookbooks have no upper limit

Updated all modules in the source install to their latest releases

Removed the GeoIP database checksums as these files are constantly updates and this causes Chef run failures

v2.7.6 (2015-03-17)

v2.7.5 (2015-03-17)

NOTE As of this release, this cookbook in its current format is deprecated, and only critical bugs and fixes will be added. A complete rewrite is in progress, so we appreciate your patience while we sort things out. The amount of change included here

v2.3.0 (2014-02-25)

v2.2.2 (2014-01-23)

[COOK-3672] - Add gzip_static option

v2.2.0

No changes. Version bump for toolchain

v2.1.0

[COOK-3923] - Enable the list of packages installed by nginx::passenger to be configurable [COOK-3672] - Nginx should support the gzip_static option Updating for yum ~> 3.0 Fixing up style for rubocop Updating test-kitchen harness

v2.0.8

fixing metadata version error. locking to 3.0

v2.0.6

Locking yum dependency to '< 3'

v2.0.4

Bug

COOK-3808 - nginx::passenger run fails because of broken installation of package dependencies