From: Andy Allan Date: Wed, 20 Jul 2016 10:48:31 +0000 (+0100) Subject: Add more cookbook readmes. X-Git-Url: https://git.openstreetmap.org/chef.git/commitdiff_plain/753fd4b1be9da70a6f5c596c839ecbdbf43afc9b?hp=e2e7455fbda41bef4885a81d67f9cf45f127638c Add more cookbook readmes. --- diff --git a/cookbooks/switch2osm/README.md b/cookbooks/switch2osm/README.md index 205739199..7275bd44d 100644 --- a/cookbooks/switch2osm/README.md +++ b/cookbooks/switch2osm/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# switch2osm cookbook -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 +This cookbook installs and configures the wordpress website that powers +[www.switch2osm.org](http://www.switch2osm.org) diff --git a/cookbooks/sysctl/README.md b/cookbooks/sysctl/README.md index 205739199..c154b579f 100644 --- a/cookbooks/sysctl/README.md +++ b/cookbooks/sysctl/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# sysctl cookbook -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 +This cookbook allows various sysctl settings to be controlled via attributes. +Settings can be added to node[:sysctl] attribute, and these are both updated +via `/proc/sys` and added to a template in `/etc/sysctl.d/` diff --git a/cookbooks/sysfs/README.md b/cookbooks/sysfs/README.md index 205739199..f7a221b22 100644 --- a/cookbooks/sysfs/README.md +++ b/cookbooks/sysfs/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# sysfs cookbook -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 +This cookbook installs and configures sysfs, which allows various kernel +configuration parameters to be tuned via node attributes. diff --git a/cookbooks/taginfo/README.md b/cookbooks/taginfo/README.md index 205739199..d116c60e0 100644 --- a/cookbooks/taginfo/README.md +++ b/cookbooks/taginfo/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# taginfo cookbook -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 +This cookbook installs and configures taginfo websites. The OSMF use this +cookbook to manage a global taginfo instance at +[taginfo.openstreetmap.org](http://taginfo.openstreetmap.org) diff --git a/cookbooks/thinkup/README.md b/cookbooks/thinkup/README.md index 205739199..0fc9b1f7a 100644 --- a/cookbooks/thinkup/README.md +++ b/cookbooks/thinkup/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# thinkup cookbook -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 +This cookbook installs and configures the +[thinkup.openstreetmap.org](http://thinkup.openstreetmap.org) social media +tracking website. diff --git a/cookbooks/tile/README.md b/cookbooks/tile/README.md index 205739199..c439d2fb4 100644 --- a/cookbooks/tile/README.md +++ b/cookbooks/tile/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# tile cookbook -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 +This cookbook installs and configures the mod_tile+renderd based tileservers +that power tile.openstreetmap.org diff --git a/cookbooks/tilecache/README.md b/cookbooks/tilecache/README.md index 205739199..496674686 100644 --- a/cookbooks/tilecache/README.md +++ b/cookbooks/tilecache/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# tilecache cookbook -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 +This cookbook installs and configures the tile caches for the +tile.openstreetmap.org tileservers. diff --git a/cookbooks/tools/README.md b/cookbooks/tools/README.md index 205739199..9e7255e02 100644 --- a/cookbooks/tools/README.md +++ b/cookbooks/tools/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# tools cookbook -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 +This cookbook installs a variety of system administration tools, and removes +a few unnecessary ones. diff --git a/cookbooks/trac/README.md b/cookbooks/trac/README.md index 205739199..ccd6f1337 100644 --- a/cookbooks/trac/README.md +++ b/cookbooks/trac/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# trac cookbook -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 +This cookbook installs and configures the trac project management website found +at [trac.openstreetmap.org](trac.openstreetmap.org). diff --git a/cookbooks/web/README.md b/cookbooks/web/README.md index 205739199..2d881fc3e 100644 --- a/cookbooks/web/README.md +++ b/cookbooks/web/README.md @@ -1,34 +1,13 @@ -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 +# web cookbook + +This cookbook installs and configures the web frontend machines that power +[www.openstreetmap.org](http://www.openstreetmap.org). There are several recipes + +* `web::backend` - sets up the backend servers, used for processing longer-running requests +* `web::base` - sets up common storage configuration between all the machines +* `web::cgimap` - builds and configures [cgimap](https://github.com/openstreetmap/cgimap) +* `web::cleanup` - configures a cleanup script to be run daily +* `web::frontend` - sets up the frontend servers, that handle all inbound requests +* `web::gpx` - sets up the GPX importer +* `web::rails` - installs and configures the [openstreetmap-website](https://github.com/openstreetmap/openstreetmap-website) rails app +* `web::statistics` - sets up the scripts for generating the [statistics page](http://www.openstreetmap.org/stats/data_stats.html) for OSM contributions diff --git a/cookbooks/wiki/README.md b/cookbooks/wiki/README.md index 205739199..faa672347 100644 --- a/cookbooks/wiki/README.md +++ b/cookbooks/wiki/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# wiki cookbook -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 +This cookbook installs and configures the mediawiki instance that powers +[wiki.openstreetmap.org](https://wiki.openstreetmap.org) diff --git a/cookbooks/wordpress/README.md b/cookbooks/wordpress/README.md index 205739199..e3ab3250a 100644 --- a/cookbooks/wordpress/README.md +++ b/cookbooks/wordpress/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# wordpress cookbook -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 +This cookbook contains recipes, providers and libraries to install and configure +wordpress. It is used as a base cookbook by other wordpress site-specific cookbooks. diff --git a/cookbooks/xinetd/README.md b/cookbooks/xinetd/README.md index 205739199..f2dfdc58c 100644 --- a/cookbooks/xinetd/README.md +++ b/cookbooks/xinetd/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# xinetd cookbook -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 +This cookbook installs and manages the +[xinetd](https://en.wikipedia.org/wiki/Xinetd) service, which acts as +an internet daemon. diff --git a/cookbooks/yournavigation/README.md b/cookbooks/yournavigation/README.md index 205739199..e5755e671 100644 --- a/cookbooks/yournavigation/README.md +++ b/cookbooks/yournavigation/README.md @@ -1,34 +1,6 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# yournavigation cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook builds and environment suitable for running gosmore as part of the +[YOURS](http://wiki.openstreetmap.org/wiki/YOURS) routing service. -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 +Note that the installation and configuration of gosmore itself is not covered by the cookbook.