cookbook 'nginx-wrapper', '~> 1.0.0'
nginx-wrapper (1) Versions 1.0.0 Follow0
Install and configure nginx
cookbook 'nginx-wrapper', '~> 1.0.0', :supermarket
knife supermarket install nginx-wrapper
knife supermarket download nginx-wrapper
Nginx wrapper
Description
Cookbook used to install and configure Nginx.
This cookbook wrap chef_nginx, certificates and nginx_conf cookbooks.
Requirements
Cookbooks and gems
Declared in [metadata.rb](metadata.rb) and in [Gemfile](Gemfile).
Platforms
A systemd managed distribution:
- RHEL Family 7, tested on Centos
Usage
Include the default recipe in your run_list.
Resources from chef_nginx, certificates and nginx_conf cookbooks are
wrapped.
For example if you need to deploy a simple config to listen on port 443 for
test.local as server name and using ssl certs stored in an encrypted data_bag:
"nginx_conf": {
"confs": [
"test.local config": {
"listen": "80",
"root": "/usr/share/nginx/html"
"server_name": "test.local"
}
]
},
"nginx-wrapper": {
"ssl_configs": {
"data_bag": "nginx-certs",
"data_bag_type": "encrypted",
"cert_path": "/etc/nginx/ssl",
"nginx_cert": true,
"create_subfolders": false
}
}
Attributes
Configuration is done by overriding default attributes. All configuration keys
have a default defined in [attributes/default.rb](attributes/default.rb).
Please read it to have a comprehensive view of what and how you can configure
this cookbook behavior.
Recipes
default
Include chef_nginx::default
, nginx-wrapper::ssl_certs
and
nginx_conf::default
recipes
ssl_certs
Create ssl directory for nginx and deploy certs.
This directory is defined using the following attribute:
node['nginx-wrapper']['ssl_certs_dir']
SSL certificates are deployed through an encrypted data_bag.
Changelog
Available in [CHANGELOG.md](CHANGELOG.md).
Contributing
Please read carefully [CONTRIBUTING.md](CONTRIBUTING.md) before making a merge
request.
License and Author
- Author:: Florian Philippon (florian.philippon@s4m.io)
Copyright (c) 2016 Sam4Mobile 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.
Dependent cookbooks
chef_nginx >= 0.0.0 |
nginx_conf >= 0.0.0 |
certificate >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
1.0.0
- Initial version
Collaborator Number Metric
1.0.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.0.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
1.0.0 failed this metric
FC066: Ensure chef_version is set in metadata: nginx-wrapper/metadata.rb:1
FC069: Ensure standardized license defined in metadata: nginx-wrapper/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.0 passed this metric
Testing File Metric
1.0.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
1.0.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
1.0.0 failed this metric
1.0.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
1.0.0 failed this metric
FC066: Ensure chef_version is set in metadata: nginx-wrapper/metadata.rb:1
FC069: Ensure standardized license defined in metadata: nginx-wrapper/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
1.0.0 passed this metric
Testing File Metric
1.0.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
1.0.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
1.0.0 failed this metric
FC069: Ensure standardized license defined in metadata: nginx-wrapper/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
1.0.0 passed this metric
Testing File Metric
1.0.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
1.0.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
1.0.0 failed this metric
1.0.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