Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

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

Select Status

RSS

apt-nginx (1) Versions 0.1.0

Installs/Configures apt NGINX Vendor-Specific Repository

Policyfile
Berkshelf
Knife
cookbook 'apt-nginx', '~> 0.1.0', :supermarket
cookbook 'apt-nginx', '~> 0.1.0'
knife supermarket install apt-nginx
knife supermarket download apt-nginx
README
Dependencies
Changelog
Quality 17%

apt-nginx Cookbook

Build Status
Chef Cookbook

Installs/Configures apt NGINX Vendor-Specific Repositories.

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

Requirements

  • Chef 11 or higher
  • Ruby 1.9 or higher (preferably from the Chef full-stack installer)
  • Network accessible package repositories
  • apt Cookbook

Attributes

apt-nginx::default

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

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.

  • ['apt-nginx']['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 Stable Repo

    • ['apt-nginx']['repos']['nginx-stable']['managed']
    • Type: Boolean
    • Description: Does this cookbook manage the install of the NGINX Stable Repo?
    • Default: true
    • ['apt-nginx']['repos']['nginx-stable']['uri']
    • Type: String
    • Description: URI of NGINX Stable Repo
    • Default: http://nginx.org/packages/#{node['platform']}
    • ['apt-nginx']['repos']['nginx-stable']['distribution']
    • Type: String
    • Description: Package distribution of NGINX Stable Repo
    • Default: node['lsb']['codename']
    • ['apt-nginx']['repos']['nginx-stable']['components']
    • Type: Array
    • Description: NGINX Stable Repo Package Groupings
    • Default: ['nginx']
    • ['apt-nginx']['repos']['nginx-stable']['key']
    • Type: String
    • Description: Cookbook File for NGINX Stable Repo Signing Key
    • Default: nginx_signing.key
    • ['apt-nginx']['repos']['nginx-stable']['deb-src']
    • Type: Boolean
    • Description: Whether or not to include the NGINX Stable Source Repo?
    • Default: false
  • NGINX Mainline Repo

    • ['apt-nginx']['repos']['nginx-mainline']['managed']
    • Type: Boolean
    • Description: Does this cookbook manage the install of the NGINX Mainline Repo?
    • Default: false
    • ['apt-nginx']['repos']['nginx-mainline']['uri']
    • Type: String
    • Description: URI of NGINX Mainline Repo
    • http://nginx.org/packages/mainline/#{node['platform']}
    • ['apt-nginx']['repos']['nginx-mainline']['distribution']
    • Type: String
    • Description: Package distribution of NGINX Mainline Repo
    • Default: node['lsb']['codename']
    • ['apt-nginx']['repos']['nginx-mainline']['components']
    • Type: Array
    • Description: NGINX Mainline Repo Package Groupings
    • Default: ['nginx']
    • ['apt-nginx']['repos']['nginx-mainline']['key']
    • Type: String
    • Description: Cookbook File for NGINX Mainline Repo Signing Key
    • Default: nginx_signing.key
    • ['apt-nginx']['repos']['nginx-mainline']['deb-src']
    • Type: Boolean
    • Description: Whether or not to include the NGINX Mainline Source Repo?
    • Default: false

Usage

apt-nginx::default

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

{
  "name":"my_node",
  "run_list": [
    "recipe[apt-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

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.

Dependent cookbooks

apt ~> 2.8

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

apt-nginx CHANGELOG

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

0.1.0

Collaborator Number Metric
            

0.1.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

0.1.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

0.1.0 passed this metric

No Binaries Metric
            

0.1.0 failed this metric

Failure: Cookbook should not contain binaries. Found:
apt-nginx/files/nginx_signing.key

Testing File Metric
            

0.1.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

0.1.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number