Add more cookbook READMEs.
authorAndy Allan <andy@gravitystorm.co.uk>
Wed, 6 Jan 2016 10:55:18 +0000 (10:55 +0000)
committerAndy Allan <andy@gravitystorm.co.uk>
Wed, 6 Jan 2016 10:55:18 +0000 (10:55 +0000)
12 files changed:
cookbooks/clamav/README.md
cookbooks/db/README.md
cookbooks/dev/README.md
cookbooks/devices/README.md
cookbooks/dhcpd/README.md
cookbooks/dns/README.md
cookbooks/elasticsearch/README.md
cookbooks/exim/README.md
cookbooks/fail2ban/README.md
cookbooks/forum/README.md
cookbooks/foundation/README.md
cookbooks/geodns/README.md

index 205739199955017d846700bb599100dae9f89479..96dd01c832186ff13098489834d7aaf24a25f993 100644 (file)
@@ -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).
index 205739199955017d846700bb599100dae9f89479..30fd81fd184fefd7da17d33e3972f930282307d7 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..0253da49b2831c177a4847ee9aea6f063407fe45 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..10648ecbf9262512371b7d906cde09197681c516 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..3d2a00c7c733dd0b883ff726fa504bac97625a70 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..08799ea5f1674d98b75f59a8c9870fcb418d7d40 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..8d751f5593ddd2122c725b21fadde17e952599c3 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..9855987cd367846a6e39ce571cc4778cd4f2507d 100644 (file)
@@ -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.
index 205739199955017d846700bb599100dae9f89479..eebfb25e702cd0df453a6e8cb07aeea080d450f3 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..6691b9bbf6b7a0e46cf5e8ab3d75bbe0b1c9e400 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..574f441ee0a7e8db87e1298fcdb229c4ccab62da 100644 (file)
@@ -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
index 205739199955017d846700bb599100dae9f89479..16f79a40701da1f08ff6a48e8592ed3f354fba4c 100644 (file)
@@ -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.