X-Git-Url: https://git.openstreetmap.org./chef.git/blobdiff_plain/faf8ae12e85eabb050b0f5eceb2cb67ad1de5261..4c86175022c9036999f9d8341e48cbd884448709:/cookbooks/networking/README.md diff --git a/cookbooks/networking/README.md b/cookbooks/networking/README.md index 6b087690a..205739199 100644 --- a/cookbooks/networking/README.md +++ b/cookbooks/networking/README.md @@ -1,57 +1,34 @@ -DESCRIPTION -=========== - -Configures networking. - -USAGE -===== - -Set the networking attributes in a role, for example from my base.rb: - - :networking => { - :nameservers => [ "10.13.37.120", "10.13.37.40" ], - :search => [ "int.example.org". "example.org" ] - } - -The resulting /etc/resolv.conf will look like: - - search int.example.org example.org - nameserver 10.13.37.120 - nameserver 10.13.37.40 - -LICENSE AND AUTHOR -================== - -Author:: OpenStreetMap Administrators () - -Copyright 2010, OpenStreetMap Foundation. - -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. - -Based on resolver cookbook: - -Author:: Joshua Timberman () - -Copyright 2009, Opscode, 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. +Cookbook +======== +TODO: Enter the cookbook description here. + +e.g. +This cookbook makes your favorite breakfast sandwich. + +Requirements +------------ +TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc. + +Attributes +---------- +TODO: List you cookbook attributes here. + +Usage +----- +TODO: Write usage instructions for each cookbook. + +Contributing +------------ +TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section. + +e.g. +1. Fork the repository on Github +2. Create a named feature branch (like `add_component_x`) +3. Write your change +4. Write tests for your change (if applicable) +5. Run the tests, ensuring they all pass +6. Submit a Pull Request using Github + +License and Authors +------------------- +Authors: TODO: List authors