cookbook 'dhcp-wrapper', '~> 1.4.0'
dhcp-wrapper (5) Versions 1.4.0 Follow0
Wrapper around dhcp cookbook
cookbook 'dhcp-wrapper', '~> 1.4.0', :supermarket
knife supermarket install dhcp-wrapper
knife supermarket download dhcp-wrapper
DHCP Wrapper
Description
Install and configure ISC DHCP by
wrapping cookbook dhcp.
Can also configure network interfaces by the use of cookbook
network_interfaces_v2, for instance to
set a static address at the server and dhcp for the clients.
Requirements
Cookbooks
Declared in [metadata.rb](metadata.rb) and in [Gemfile](Gemfile).
Platforms
- RHEL Family 7, tested on Centos
Note: it should work fine on Debian 8 but the official docker image does not
allow systemd to work easily, so it could not be tested.
Usage
Easy Setup
Add recipe[dhcp-wrapper::server]
in your run-list to install and configure
DHCPD. Configuration will be fetched from attributes node['dhcp']
. See
cookbook dhcp documentation for more information.
Add recipe[dhcp-wrapper::client]
to install a dhcp client.
Add recipe[dhcp-wrapper::network_interface]
to configure your network
interfaces. Configuration is fetched from attributes
node['dhcp-wrapper']['network-interface']
which should match those of
provider network_interface.
To see an example, look at [.kitchen.yml](.kitchen.yml).
Test
This cookbook is fully tested through the installation of a server and a node
in docker hosts. This uses kitchen, docker and some monkey-patching.
If you run kitchen list, you will see 2 suites, Each corresponds to a different
server:
- server-centos-7: DHCPD server listening on eth1
- node-centos-7: generic node with eth1 configured in dhcp
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.
Specific configuration (client or server)
To allow clients and servers to share a same role, it is possible to define
specific configuration keys applicable to one of the status (client or server).
Specific configurations can be any of the attributes defined in
[attributes/default.rb](attributes/default.rb) but in either "client-config"
or "server-config" sub-tree.
A node is declared as server if its FQDN is included in attribute
node['dhcp-wrapper']['servers']
defined as an array. Else, it is considered
as a client.
Recipes
default
Call init and then, following the node status, call client or
server recipe.
init
Determine if the current machine is a server or a client. Write the result
in run_state['dhcp-wrapper']['status']
. Then merge default and specific
(client or server) configurations and store the result in
run_state['dhcp-wrapper']['config']
.
Note: init is included in all recipes.
client
Install dhclient package.
server
Proxy for dhcp::server recipe. Please look at [.kitchen.yml](.kitchen.yml)
and dhcp documentation for more information.
network_interface
Call network_interface_rhel provider based on
attributes node['dhcp-wrapper']['network-interface']
.
See [.kitchen.yml](.kitchen.yml) and cookbook
network_interface_v2 for more information.
Create static routes based on node['dhcp-wrapper']['routes']
attribute.
Resources/Providers
None.
Changelog
Available in [CHANGELOG](CHANGELOG).
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) 2015-2016 Sam4Mobile, 2018 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
dhcp >= 0.0.0 |
network_interfaces_v2 >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Changelog
1.4.0
Main:
- massive clean-up following chef-platform standards
- chore: handover maintenance to make.org
Tests:
- test: start Continuous Integration with gitlab-ci
- test: include .gitlab-ci.yml from test-cookbook
- test: add a correct Gemfile
- test: set seccomp (for systemd)
- test: use kitchen_command.rb from test-cookbook
- test: replace deprecated require_chef_omnibus
Misc:
- chore: set new contributing guide with karma style
- chore: add foodcritic & rubocop in Gemfile
- doc: fix markdown in changelog and rename to CHANGELOG.md
- style(rubocop): fix delimiter offenses
- style: use cookbook_name macro everywhere
1.3.0
Main:
- Allow clients and servers to share the same role with specific options
- Add an init recipe which initialize the configuration
- Modify default to choose between client and server recipe
- Call network_interface in client and server recipes
- client specific configurations should be in 'client-config' and servers in 'server-config'.
- the servers should be defined with 'servers' key
- Rename network-interface to network_interface: breaking change for users using it directly (very unlikely)
- Switch to docker_cli, use prepared docker image
- Switch kitchen driver from docker to docker_cli
- Use sbernard/centos-systemd-kitchen image instead of bare centos
- Remove many monkey patches
- No more need to have sudo access anymore: pipework is gone :)
- Remove privileged mode :), use --cap-add=NET_ADMIN instead
- create a docker network: kitchen-dhcp, which is to be controled by the dhcp server
Misc:
- Fix and improve tests
- Modify test cases to test specific option behavior
- Latest dhcp and strengthen ip check
- Improve doc, explain specific conf and update it
- Fix all rubocop offenses
1.2.0
- Fix idempotency by removing the block hack in network-interface recipe
- Reorganize README:
- Move changelog from README to CHANGELOG
- Move contribution guide to CONTRIBUTING.md
- Reorder README, fix Gemfile missing
- Add Apache 2 license file
1.1.0
- Add support for static routes
1.0.0
- Initial version with Centos 7 support
Collaborator Number Metric
1.4.0 passed this metric
Contributing File Metric
1.4.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.4.0 passed this metric
No Binaries Metric
1.4.0 passed this metric
Testing File Metric
1.4.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.4.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.4.0 passed this metric
1.4.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.4.0 passed this metric
No Binaries Metric
1.4.0 passed this metric
Testing File Metric
1.4.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.4.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.4.0 passed this metric
1.4.0 passed this metric
Testing File Metric
1.4.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.4.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.4.0 failed this metric
1.4.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