cookbook 'nxredirect-cookbook', '= 1.1.0'
nxredirect-cookbook (4) Versions 1.1.0 Follow0
Install and Configure NXRedirect as a Systemd Service
cookbook 'nxredirect-cookbook', '= 1.1.0', :supermarket
knife supermarket install nxredirect-cookbook
knife supermarket download nxredirect-cookbook
NXRedirect Cookbook
Description
NXRedirect acts as a DNS Proxy which redirects NXDomain
responses from a primary DNS server to a fallback. It is primary used to
create split-view architecture where the primary server is internal and the
fallback is public.
This cookbook installs and configures NXRedirect as a Systemd
Service. It can (by default) also install Erlang, a required dependency.
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
Note: it should work quite fine on Debian 8 (with some attributes tuning) but
the official docker image does not allow Systemd to work easily, so it could
not be tested.
Usage
Quick Setup
Configure node['nxredirect-cookbook']['config']
following your needs and
add recipe[nxredirect-cookbook]
to your run_list.
A common setup is to collocate NXRedirect and a DNS server like
Bind. An example of this setup is presented in [.kitchen.yml](.kitchen.yml) as
the first suite.
Test
This cookbook is fully tested through test-kitchen and docker.
For more information, see [.kitchen.yml](.kitchen.yml) and [test](test)
directory.
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
Execute the following recipes on a node if
node['nxredirect-cookbook']['servers']
is empty or contains its hostname.
erlang
Install Erlang from Erlang Solutions repository.
install
Install NXRedirect in node['nxredirect-cookbook']['bin']
.
service
Add and configure Systemd service for NXRedirect.
Resources/Providers
None.
Changelog
Available in [CHANGELOG.md](CHANGELOG.md).
Contributing
Please read carefully [CONTRIBUTING.md](CONTRIBUTING.md) before making a merge
request.
License and Author
- Author:: Samuel Bernard (samuel.bernard@gmail.com)
Copyright (c) 2016 Sam4Mobile, 2017 Make.org 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
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
1.1.0
Main:
- Handover maintenance to Make.org
Tests:
- Add a nsupdate use case to strengthen tests
- Set always_update_cookbooks: true in provisioner
- Use latest template for .gitlab-ci.yml [20170405]
- Remove the need of docker network kitchen
- Fix test on noop (change of systemd output format)
Misc:
- Fix rubocop and foodcritic offenses
1.0.0
- Initial version, use unreleased build 2967352.
Collaborator Number Metric
1.1.0 failed this metric
Failure: Cookbook has 1 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.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
1.1.0 failed this metric
FC069: Ensure standardized license defined in metadata: nxredirect-cookbook/metadata.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
License Metric
1.1.0 passed this metric
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.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
1.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
1.1.0 failed this metric
1.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
1.1.0 failed this metric
FC069: Ensure standardized license defined in metadata: nxredirect-cookbook/metadata.rb:1
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
License Metric
1.1.0 passed this metric
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.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
1.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
1.1.0 failed this metric
Run with Foodcritic Version 11.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
1.1.0 passed this metric
No Binaries Metric
1.1.0 passed this metric
Testing File Metric
1.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
1.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
1.1.0 passed this metric
1.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
1.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
1.1.0 failed this metric