cookbook 'hostsfile', '= 0.1.0', :supermarket
hostsfile
(22) Versions
0.1.0
-
Follow94
Provides an resource for managing the /etc/hosts file
cookbook 'hostsfile', '= 0.1.0'
knife supermarket install hostsfile
knife supermarket download hostsfile
hostsfile LWRP
hostsfile provides an LWRP for managing your hosts file using Chef.
Requirements
At this time, you must have a Unix-based machine. This could easily be adapted for Windows machines. Please submit a Pull Request if you wish to add Windows support.
Attributes
<table> <tr> <th>Attribute</th> <th>Description</th> <th>Example</th> <th>Default</th> </tr> <tr> <td>ip_address</td> <td>(name attribute) the IP address for the entry</td> <td><tt>1.2.3.4</tt></td> <td></td> </tr> <tr> <td>hostname</td> <td>(required) the hostname associated with the entry</td> <td><tt>example.com</tt></td> <td></td> </tr> <tr> <td>aliases</td> <td>array of aliases for the entry</td> <td><tt>['www.example.com']</tt></td> <td><tt>[]</tt></td> </tr> <tr> <td>comment</td> <td>a comment to append to the end of the entry</td> <td><tt>'interal DNS server'</tt></td> <td><tt>nil</tt></td> </tr> </table>
Actions
This LWRP comes equipped with 4 actions:
create
Creates a new hosts file entry. If an entry already exists, it will be overwritten by this one.
hostsfile_entry '1.2.3.4' do
hostname 'example.com'
action :create
end
This will create an entry like this:
1.2.3.4 example.com
create_if_missing
Create a new hosts file entry, only if one does not already exist for the given IP address. If one exists, this does nothing.
hostsfile_entry '1.2.3.4' do
hostname 'example.com'
action :create_if_missing
end
update
Updates the given hosts file entry. Does nothing if the entry does not exist.
hostsfile_entry '1.2.3.4' do
hostname 'example.com'
comment 'Update by Chef'
action :update
end
This will create an entry like this:
1.2.3.4 example # Updated by Chef
remove
Removes an entry from the hosts file. Does nothing if the entry does not exist.
hostsfile_entry '1.2.3.4' do
action :remove
end
This will remove the entry for 1.2.3.4.
Usage
Download or install this cookbook from the community site:
$ knife cookbook site install hostsfile
Then, simply include this recipe and you'll be granted access to this LWPR:
# your_recipe.rb
include_recipe 'hostsfile'
Contributing
- Fork the project
- Create a feature branch corresponding to you change
- Commit and test thoroughly
- Create a Pull Request on github
- ensure you add a detailed description of your changes
License and Authors
Authors: Seth Vargo (@sethvargo)
Copyright 2012, CustomInk, LLC
Dependent cookbooks
This cookbook has no specified dependencies.
