X-Git-Url: https://git.openstreetmap.org/chef.git/blobdiff_plain/45c45894797c49b6fbcb9af5b6ad8b8292d96415..7720e35c56ebf155de90facca5a421e43974774b:/cookbooks/planet/README.md?ds=sidebyside diff --git a/cookbooks/planet/README.md b/cookbooks/planet/README.md index 205739199..926c20755 100644 --- a/cookbooks/planet/README.md +++ b/cookbooks/planet/README.md @@ -1,34 +1,11 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Planet Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook configures the various components of the planet service - used +for distributing OpenStreetMap data at +[planet.openstreetmap.org](http://planet.openstreetmap.org) -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 +It includes the following recipes: +* default: configures the website for serving the various planet files +* dump: installs and configures the planet-dump-ng software to create the dumps +* notes: configures the dump of the OpenStreetMap notes +* replication: configures the minutely, hourly and daily replication diffs