cookbook 'new-yum-nginx', '~> 0.3.0'
new-yum-nginx (1) Versions 0.3.0 Follow0
Installs/Configures yum NGINX Vendor-Specific Repository
cookbook 'new-yum-nginx', '~> 0.3.0', :supermarket
knife supermarket install new-yum-nginx
knife supermarket download new-yum-nginx
yum-nginx Cookbook
*** Breaking Change ***
As of version 0.3.0, this cookbook was renamed new-yum-nginx
from a fork of the original version created by st-isidore-de-seville, who no longer maintains nor has a Github account. yum-nginx
is the original name, but it can no longer be updated in supermarket.chef.io. If you have included the orginal cookbook in any of your run lists or downstream cookbooks, please update them using the new name.
Installs/Configures yum NGINX Vendor-Specific Repositories.
This cookbook installs & configures yum NGINX repositories per
http://nginx.org/en/linux_packages.html.
Requirements
- Chef 12.14 or higher
- Ruby 2.3 or higher (preferably from the Chef omnibus installer)
- Network accessible package repositories
Attributes
new-yum-nginx::default
The default recipe is for installing & configuring the yum NGINX repostories.
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.
-
['yum-nginx']['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 versions 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 major version of the OS. If the hash value evaluates to
true, the OS/version is considered supported.
- Default:{ '5' => false, '6' => true, '7' => true }
-
NGINX Stable Repo
['yum-nginx']['repos']['nginx-stable']['managed']
- Type: Boolean
- Description: Does this cookbook manage the install of the NGINX Stable Repo?
-
Default:
true
['yum-nginx']['repos']['nginx-stable']['repositoryid']
- Type: String
- Description: Unique Name for NGINX Stable Repo
-
Default:
nginx-stable
['yum-nginx']['repos']['nginx-stable']['description']
- Type: String
- Description: Description of NGINX Stable Repo
-
Default:
nginx stable repo
['yum-nginx']['repos']['nginx-stable']['baseurl']
- Type: String
- Description: URL of NGINX Stable Repo
-
Default:
http://nginx.org/packages/#{node['platform']}/#{node['platform_version'].to_i}/$basearch/
['yum-nginx']['repos']['nginx-stable']['gpgcheck']
- Type: Boolean
- Description: Whether or not NGINX Stable Repo should perform GPG check of packages?
-
Default:
false
['yum-nginx']['repos']['nginx-stable']['sslverify']
- Type: Boolean
- Description: Whether or not yum will verify the NGINX Stable Repo SSL host?
-
Default:
false
['yum-nginx']['repos']['nginx-stable']['enabled']
- Type: Boolean
- Description: Whether or not the NGINX Stable Repo is enabled?
-
Default:
true
['yum-nginx']['repos']['nginx-stable']['make_cache']
- Type: Boolean
- Description: Whether or not the NGINX Stable Repo is stored in cache?
-
Default:
true
-
NGINX Stable Source Repo
['yum-nginx']['repos']['nginx-stable-source']['managed']
- Type: Boolean
- Description: Does this cookbook manage the install of the NGINX Stable Source Repo?
-
Default:
false
['yum-nginx']['repos']['nginx-stable-source']['repositoryid']
- Type: String
- Description: Unique Name for NGINX Stable Source Repo
-
Default:
nginx-stable-source
['yum-nginx']['repos']['nginx-stable-source']['description']
- Type: String
- Description: Description of NGINX Stable Source Repo
-
Default:
nginx stable source repo
['yum-nginx']['repos']['nginx-stable-source']['baseurl']
- Type: String
- Description: URL of NGINX Stable Source Repo
-
Default:
http://nginx.org/packages/#{node['platform']}/#{node['platform_version'].to_i}/SRPMS/
['yum-nginx']['repos']['nginx-stable-source']['gpgcheck']
- Type: Boolean
- Description: Whether or not NGINX Stable Source Repo should perform GPG check of packages?
-
Default:
false
['yum-nginx']['repos']['nginx-stable-source']['sslverify']
- Type: Boolean
- Description: Whether or not yum will verify the NGINX Stable Source Repo SSL host?
-
Default:
false
['yum-nginx']['repos']['nginx-stable-source']['enabled']
- Type: Boolean
- Description: Whether or not the NGINX Stable Source Repo is enabled?
-
Default:
true
['yum-nginx']['repos']['nginx-stable-source']['make_cache']
- Type: Boolean
- Description: Whether or not the NGINX Stable Source Repo is stored in cache?
-
Default:
true
-
NGINX Mainline Repo
['yum-nginx']['repos']['nginx-mainline']['managed']
- Type: Boolean
- Description: Does this cookbook manage the install of the NGINX Mainline Repo?
-
Default:
false
['yum-nginx']['repos']['nginx-mainline']['repositoryid']
- Type: String
- Description: Unique Name for NGINX Mainline Repo
-
Default:
nginx-mainline
['yum-nginx']['repos']['nginx-mainline']['description']
- Type: String
- Description: Description for NGINX Mainline Repo
-
Default:
nginx mainline repo
['yum-nginx']['repos']['nginx-mainline']['baseurl']
- Type: String
- Description: URL of NGINX Mainline Repo
-
Default:
http://nginx.org/packages/mainline/#{node['platform']}/#{node['platform_version'].to_i}/$basearch/
['yum-nginx']['repos']['nginx-mainline']['gpgcheck']
- Type: Boolean
- Description: Whether or not NGINX Mainline Repo should perform GPG check of packages?
-
Default:
false
['yum-nginx']['repos']['nginx-mainline']['sslverify']
- Type: Boolean
- Description: Whether or not yum will verify the NGINX Mainline Repo SSL host?
-
Default:
false
['yum-nginx']['repos']['nginx-mainline']['enabled']
- Type: Boolean
- Description: Whether or not the NGINX Mainline Repo is enabled?
-
Default:
true
['yum-nginx']['repos']['nginx-mainline']['make_cache']
- Type: Boolean
- Description: Whether or not the NGINX Mainline Repo is stored in cache?
-
Default:
true
-
NGINX Mainline Source Repo
['yum-nginx']['repos']['nginx-mainline-source']['managed']
- Type: Boolean
- Description: Does this cookbook manage the install of the NGINX Mainline Source Repo?
-
Default:
false
['yum-nginx']['repos']['nginx-mainline-source']['repositoryid']
- Type: String
- Description: Unique Name for NGINX Mainline Source Repo
-
Default:
nginx-mainline-source
['yum-nginx']['repos']['nginx-mainline-source']['description']
- Type: String
- Description: Description of NGINX Mainline Source Repo
-
Default:
nginx mainline source repo
['yum-nginx']['repos']['nginx-mainline-source']['baseurl']
- Type: String
- Description: URL of NGINX Mainline Source Repo
-
Default:
http://nginx.org/packages/mainline/#{node['platform']}/#{node['platform_version'].to_i}/SRPMS/
['yum-nginx']['repos']['nginx-mainline-source']['gpgcheck']
- Type: Boolean
- Description: Whether or not NGINX Mainline Source Repo should perform GPG check of packages?
-
Default:
false
['yum-nginx']['repos']['nginx-mainline-source']['sslverify']
- Type: Boolean
- Description: Whether or not yum will verify the NGINX Mainline Source Repo SSL host?
-
Default:
false
['yum-nginx']['repos']['nginx-mainline-source']['enabled']
- Type: Boolean
- Description: Whether or not the NGINX Mainline Source Repo is enabled?
-
Default:
true
['yum-nginx']['repos']['nginx-mainline-source']['make_cache']
- Type: Boolean
- Description: Whether or not the NGINX Mainline Source Repo is stored in cache?
-
Default:
true
Usage
new-yum-nginx::default
Just include new-yum-nginx
in your node's run_list
:
{ "name":"my_node", "run_list": [ "recipe[new-yum-nginx]" ] }
Contributing
- Fork the repository on GitHub
- Create a named feature branch (like
add_component_x
) - Write your change
- Write tests for your change (if applicable)
- Run the tests, ensuring they all pass
- 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:
vagrant up
vagrant ssh
cd /vagrant
Authors
- Author:: St. Isidore de Seville (st.isidore.de.seville@gmail.com)
- Forked by Dang H. Nguyen (haidangwa@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.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
yum-nginx CHANGELOG
This file is used to list changes made in each version of the yum-nginx
cookbook.
0.3.0
- Dang Nguyen (haidangwa@gmail.com)
- set default make_cache property of yum repository to true
- set explicit constraints in Gemfile
- updated rack,
~> 2.0.6
(CVE-2018-16470, CVE-2018-16471) - dropped centos 5 and centos 6 i386 support
- set chef_version to '> 12.14' in metadata
- no longer requires yum cookbook dependency (use chef 12.14's native yum_repository resource)
- install Chef 13 in Test Kitchen environment
- Fixed Issue #8 import GPG key when check GPG key property is enabled
- updated the nginx.org GPG key embedded in this cookbook
- enable sslverify on all repos by default
- Changed default
[baseurl_prefix]
to https://nginx.org
0.2.0
- St. Isidore de Seville (st.isidore.de.seville@gmail.com)
- fix Chef 13 deprecation warnings
- fix Chef 11 issues
0.1.0
- St. Isidore de Seville (st.isidore.de.seville@gmail.com)
- initial release of yum-nginx
Collaborator Number Metric
0.3.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.3.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.3.0 passed this metric
No Binaries Metric
0.3.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
new-yum-nginx/files/nginx_signing.key
Testing File Metric
0.3.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.3.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
0.3.0 failed this metric
0.3.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.3.0 passed this metric
No Binaries Metric
0.3.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
new-yum-nginx/files/nginx_signing.key
Testing File Metric
0.3.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.3.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
0.3.0 passed this metric
0.3.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
new-yum-nginx/files/nginx_signing.key
Testing File Metric
0.3.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.3.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
0.3.0 failed this metric
0.3.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