From 8c4a8b46bb88380fd6ce54b2e913665438f79f9c Mon Sep 17 00:00:00 2001 From: Andy Allan Date: Wed, 6 Jan 2016 10:55:18 +0000 Subject: [PATCH 1/1] Add more cookbook READMEs. --- cookbooks/clamav/README.md | 35 ++------------------------- cookbooks/db/README.md | 39 +++++++------------------------ cookbooks/dev/README.md | 37 ++++------------------------- cookbooks/devices/README.md | 36 +++------------------------- cookbooks/dhcpd/README.md | 35 ++------------------------- cookbooks/dns/README.md | 35 ++------------------------- cookbooks/elasticsearch/README.md | 35 ++------------------------- cookbooks/exim/README.md | 36 +++------------------------- cookbooks/fail2ban/README.md | 36 ++++------------------------ cookbooks/forum/README.md | 36 +++------------------------- cookbooks/foundation/README.md | 36 ++++------------------------ cookbooks/geodns/README.md | 37 ++++------------------------- 12 files changed, 42 insertions(+), 391 deletions(-) diff --git a/cookbooks/clamav/README.md b/cookbooks/clamav/README.md index 205739199..96dd01c83 100644 --- a/cookbooks/clamav/README.md +++ b/cookbooks/clamav/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# ClamAV 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 Clam AntiVirus (ClamAV). diff --git a/cookbooks/db/README.md b/cookbooks/db/README.md index 205739199..30fd81fd1 100644 --- a/cookbooks/db/README.md +++ b/cookbooks/db/README.md @@ -1,34 +1,11 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# db Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook installs and configures the PostgreSQL database required by the +openstreetmap-website (aka Rails Port) codebase. -Requirements ------------- -TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc. +There are four recipes available: -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 +* backup: configures the pg_dump-based backups and rsyncing to the backup server. +* base: installs the database and rails port codebase. +* master: configuration of user accounts etc that happen on the master server. +* slave: placeholder for slave database configuration. diff --git a/cookbooks/dev/README.md b/cookbooks/dev/README.md index 205739199..0253da49b 100644 --- a/cookbooks/dev/README.md +++ b/cookbooks/dev/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Dev Server 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 configures development servers, such as dev.openstreetmap.org. It +installs packages required by the users and configures apache for the various +user and api developement sites. diff --git a/cookbooks/devices/README.md b/cookbooks/devices/README.md index 205739199..10648ecbf 100644 --- a/cookbooks/devices/README.md +++ b/cookbooks/devices/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Devices 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 sets up udev rules for disk device configuration and tuning parameters. +It uses attributes that can be set on individual machine roles. diff --git a/cookbooks/dhcpd/README.md b/cookbooks/dhcpd/README.md index 205739199..3d2a00c7c 100644 --- a/cookbooks/dhcpd/README.md +++ b/cookbooks/dhcpd/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# dhcpd 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 +Configures the dhcpd service, which used for the internal network at UCL. diff --git a/cookbooks/dns/README.md b/cookbooks/dns/README.md index 205739199..08799ea5f 100644 --- a/cookbooks/dns/README.md +++ b/cookbooks/dns/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# DNS 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 configures the tilecache geodns map available at http://dns.openstreetmap.org diff --git a/cookbooks/elasticsearch/README.md b/cookbooks/elasticsearch/README.md index 205739199..8d751f559 100644 --- a/cookbooks/elasticsearch/README.md +++ b/cookbooks/elasticsearch/README.md @@ -1,34 +1,3 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Elasticsearch 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 an Elasticsearch server. diff --git a/cookbooks/exim/README.md b/cookbooks/exim/README.md index 205739199..9855987cd 100644 --- a/cookbooks/exim/README.md +++ b/cookbooks/exim/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Exim 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 exim Mail Transfer Agent (MTA). It is +used by many different email handling services and is configured using attributes. diff --git a/cookbooks/fail2ban/README.md b/cookbooks/fail2ban/README.md index 205739199..eebfb25e7 100644 --- a/cookbooks/fail2ban/README.md +++ b/cookbooks/fail2ban/README.md @@ -1,34 +1,8 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# fail2ban Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook installs and configures the fail2ban intrusion prevention software. -Requirements ------------- -TODO: List your cookbook requirements. Be sure to include any requirements this cookbook has on platforms, libraries, other cookbooks, packages, operating systems, etc. +It also provides two resources that can be used by other cookbooks: -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 +* fail2ban_filter +* fail2ban_jail diff --git a/cookbooks/forum/README.md b/cookbooks/forum/README.md index 205739199..6691b9bbf 100644 --- a/cookbooks/forum/README.md +++ b/cookbooks/forum/README.md @@ -1,34 +1,4 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Forum 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 fluxbb forums software used at +http://forum.openstreetmap.org diff --git a/cookbooks/foundation/README.md b/cookbooks/foundation/README.md index 205739199..574f441ee 100644 --- a/cookbooks/foundation/README.md +++ b/cookbooks/foundation/README.md @@ -1,34 +1,6 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# Foundation Cookbook -e.g. -This cookbook makes your favorite breakfast sandwich. +This cookbook contains two recipes for OpenStreetMap Foundation services: -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 +* board: sets up the private OSMF Board Wiki +* wiki: sets up the public mediawiki instance that powers www.osmfoundation.org diff --git a/cookbooks/geodns/README.md b/cookbooks/geodns/README.md index 205739199..16f79a407 100644 --- a/cookbooks/geodns/README.md +++ b/cookbooks/geodns/README.md @@ -1,34 +1,5 @@ -Cookbook -======== -TODO: Enter the cookbook description here. +# geodns 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 gdnsd, a geographic DNS server for providing +DNS responses based on request location. It is used for sending tile requests to +the appropriate local tile caches. -- 2.43.2