Description

orch_web is a simple cookbook for setting up nginx as a reverse proxy for one or more upstream rails/rack servers. It uses the 'nginx::source' recipes from the nginx cookbook for configuration.

The goal is to provide a simple way to set up a reverse proxy server by just setting a few node attributes. No custom cookbook or use of LWRPs required.

Requirements

Chef 10.10.0+

Assumptions

You are proxying rails/rack apps via unicorn, puma, or some other server. Passenger is not supported.
Your deploy process will place all static assets in the app's root path on the node that includes the orch_web recipe

Platform

Ubuntu

Tested on:

Ubuntu 12.04

Cookbooks

This cookbook depends on the following external cookbook:

nginx

Attributes

apps

A list of hashes describing the set of virtual hosts for each app. Each hash accepts the following:

name - the name of the rails/rack app (required)
root_path - the path of the app's public directory. It's assumed the app static assets are deployed here (required)
servers - a list of upstream server addresses (IP4/6 or unix socket)
port - the virtual host's listening port (default: 80)
hostname - the virtual host's hostname (default: _)
ssl - ssl options hash (optional)
- port - the ssl port (default: 443)
- key - the ssl certificate key
- cert - the ssl certificate
- key_file - the name of the key file to use (default: /etc/nginx/ssl/appname.key)
- cert_file - the name of the cert file to use (default: /etc/nginx/ssl/appname.crt)

asset_location

The regex used to specify static assets that are cached indefinitely. Default is '(images|assets|javascripts|stylesheets)' for both Rails 2 and 3 apps

SSL Certificates

The presence of the app's ssl['key'] and ssl['cert'] node attributes will enable SSL and install the key and certificate. For situations where it's not secure to pass certificate information as node attributes, you can explictly specify the key and cert files instead. The cookbook will assume the files already exist on the server and will use them in the nginx vhost configuration.

External attribute changes

This cookpage makes opinionated changes to the nginx default attributes. You can still change orch_web's decisions by setting the nginx attributes at either the node or override levels.

default_site_enabled (nginx)

This is set to false

Usage

Add recipe[orch_web] to the run list for the node and set the the apps attribute.

License and Author

Author:: Jeff Siegel

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.

jdsiegel / chef-orch_web