camo cookbook

Description

Installs Camo - a small http proxy to simplify routing images through an SSL host

Requirements

The dependencies are assumed to be downloaded from the Chef Supermarket cookbook repository.

• nodejs cookbook
• git cookbook
• runit cookbook

Usage

Usually you would run this behind a web server proxy, such as apache2, nginx, varnish etc.

In a wrapper cookbook add this cookbook as a dependency and include the default recipe

include_recipe 'camo::default'

Then add any attributes below that you will want to change to the defaults you use internally. Specifically you should override camo.key at a minimum. Depending on your use case, you may want to add a recipe in your wrapper cookbook that deals with the web server proxy setup.

Attributes

General

• node['camo']['user'] = "camo" - user to run camo as, the cookbook will create the user if it does not exist.
• node['camo']['group'] = "users" - group used on directory creation.
• node['camo']['install_method'] = 'deploy_revision' - method for installing camo: either package or deploy_revision.
• node['camo']['init_style'] - attempts to pick the platform default, but otherwise can be defined as upstart, systemd or runit

Configuration

These are configuration parameters that will be passed directly to camo via the init scripts. Please see the camo documentation for more details on these attributes.

• node['camo']['port'] = 8081
• node['camo']['header_via'] = nil
• node['camo']['key'] = '0x24FEEDFACEDEADBEEFCAFE'
• node['camo']['logging'] = "disabled"
• node['camo']['length_limit'] = 5242880
• node['camo']['max_redirects'] = 4
• node['camo']['socket_timeout'] = 10
• node['camo']['timing_allow_origin'] = nil
• node['camo']['hostname'] = "unknown"
• node['camo']['keep_alive'] = false
• node['camo']['allowed_hosts'] = []
• node['camo']['endpoint_path'] = ''

Init Style: Systemd

• node['camo']['systemd']['env_path'] = '/etc/sysconfig'

Install Method: Deploy Revision

This install methods installs directly from source. It is highly recommended that if you use this method that you specify a particular camo.branch and your own fork via camo.repo. This will minimize impact of changes by upstream that you do not control.

• node['camo']['path'] = "/srv/camo" - location where to install camo
• node['camo']['deploy_user'] = "root" - user who will run git and own the deployed repo.
• node['camo']['deploy_group'] = "users" - group who will own the deployed repo.
• node['camo']['deploy_migrate'] = false - do not run deploy_revision migrations
• node['camo']['deploy_action'] = "deploy" - action to pass to the deploy_revision resource.
• node['camo']['repo'] = "git://github.com/atmos/camo.git" - location of the camo git repo.
• node['camo']['branch'] = "master" - the branch or tag to clone

Development

We have written unit tests using chefspec and integration tests in serverspec executed via test-kitchen. Much of the tooling around this cookbook is exposed via guard and test kitchen, so it is highly recommended to learn more about those tools. The easiest way to get started is to install the Chef Development Kit

Running tests

The following commands will run the tests:

chef exec bundle install
chef exec rubocop
chef exec foodcritic .
chef exec rspec
chef exec kitchen test default-ubuntu-1604
chef exec kitchen test default-centos-84

The above will do ruby style (rubocop) and cookbook style (foodcritic) checks followed by rspec unit tests ensuring proper cookbook operation. Integration tests will be run next on two separate linux platforms (Ubuntu 14.04 LTS Precise 64-bit and CentOS 7.2). Please run the tests on any pull requests that you are about to submit and write tests for defects or new features to ensure backwards compatibility and a stable cookbook that we can all rely upon.

Running tests continuously with guard

This cookbook is also setup to run the checks while you work via the guard gem.

bundle install
bundle exec guard start