cookbook 'dnsmasq-local', '= 0.2.0'
The dnsmasq-local cookbook has been deprecated
Author provided reason for deprecation:
The dnsmasq-local cookbook has been deprecated and is no longer being maintained by its authors. Use of the dnsmasq-local cookbook is no longer recommended.
dnsmasq-local (12) Versions 0.2.0 Follow0
Configures a local-only dnsmasq
cookbook 'dnsmasq-local', '= 0.2.0', :supermarket
knife supermarket install dnsmasq-local
knife supermarket download dnsmasq-local
Dnsmasq Local Cookbook
Installs Dnsmasq with an opinionated default configuration geared toward
localhost-only improved DNS reliability.
Requirements
This cookbook currently supports Ubuntu only.
At least for the time being, it supports Chef 11+, at the expense of some
additional complexity to maintain backwards compatibility.
Usage
Set the attributes you wish and add the default recipe to your run list, or
create a recipe of your own that implements the included Chef resources.
Recipes
default
Installs and configures Dnsmasq in an attribute-driven fashion.
Attributes
default
default['dnsmasq_local']['config'] = {}
Any key+value can be set under this namespace and it will be merged into the
default Dnsmasq config.
Any config key that contains a hyphen (e.g. cache-size
) should be set in
attributes with an underscore (e.g. cache_size
).
Any Dnsmasq setting that is a boolean key with no value (e.g. proxy_dnssec
)
can be set to true or false to be enabled or disabled, respectively.
Resources
dnsmasq_local
A parent resource that combines an app + config + service resource.
Syntax:
dnsmasq_local 'default' do
config { cache_size: 0 }
action :create
end
Actions:
Action | Description |
---|---|
:create |
Install, configure, and enable+start Dnsmasq |
:remove |
Stop+disable and remove Dnsmasq |
Attributes:
Attribute | Default | Description |
---|---|---|
config | nil |
A Dnsmasq configuration hash |
action | :create |
Action(s) to perform |
dnsmasq_local_app
A resource for installation and removal of the Dnsmasq app packages.
Syntax:
dnsmasq_local_app 'default' do
action :install
end
Actions:
Action | Description |
---|---|
:install |
Install the Dnsmasq package |
:remove |
Uninstall the Dnsmasq package |
Attributes:
Attribute | Default | Description |
---|---|---|
action | :install |
Action(s) to perform |
dnsmasq_local_config
A resource for generating Dnsmasq configurations.
Syntax:
dnsmasq_local_config 'default' do
config { cache_size: 100 }
no_hosts false
action :create
end
Actions:
Action | Description |
---|---|
:create |
Write out the Dnsmasq config file |
:remove |
Delete the Dnsmasq config file |
Attributes:
Attribute | Default | Description |
---|---|---|
config | See below | A complete config hash * |
interface | '' | Listen only on the loopback interface |
cache_size | 0 | Disable caching |
no_hosts | true | Do not DNSify /etc/hosts
|
bind_interfaces | true | Bind only to listening interfaces |
proxy_dnssec | true | Proxy DNSSEC, when available |
query_port | 0 | Use a static, ephemeral return port |
** | nil |
Varies |
action | :create |
Action(s) to perform |
* A config attribute that is passed in will override the entirety of the
default config, whereas individual attributes passed in will be merged with
it.
** Any unrecognized attribute that is passed in will be assumed to be a
correct Dnsmasq setting and rendered out to its config.
dnsmasq_local_service
A resource for the managing the Dnsmasq service.
Syntax:
dnsmasq_local_service 'default' do
action [:enable, :start]
end
Actions:
Action | Description |
---|---|
:enable |
Enable the service |
:disable |
Disable the service |
:start |
Start the service |
:stop |
Stop the service |
:restart |
Restart the service |
Attributes:
Attribute | Default | Description |
---|---|---|
action | [:enable, :start] |
Action(s) to perform |
Providers
Chef::Provider::DnsmasqLocal
Provider that wraps each of the Dnsmasq component resources.
Chef::Provider::DnsmasqLocalApp
Provider for managing the Dnsmasq app packages.
Chef::Provider::DnsmasqLocalService
Provider for managing Dnsmasq config files.
Chef::Provider::DnsmasqLocalService
Provider for managing the Dnsmasq service.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Add tests for the new feature; ensure they pass (
rake
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
License & Authors
- Author: Jonathan Hartman jonathan.hartman@socrata.com
Copyright 2016, Socrata, Inc.
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.
Dnsmasq Local Cookbook CHANGELOG
v0.2.0 (2016-05-18)
- Ensure the APT cache is up to date before installing
- Refactor config merging to avoid attribute collision warnings
v0.1.0 (2016-05-06)
- Initial release!
v0.0.1 (2016-04-25)
- Development started
Foodcritic Metric
0.2.0 passed this metric
0.2.0 passed this metric