Permalink
Browse files

COOK-831 - add README.md where it was missing completely

  • Loading branch information...
1 parent 9af3f80 commit 39f696bda4faadf31c93b7dd91fa9fe6daf41d21 @jtimberman jtimberman committed Dec 6, 2011
View
@@ -0,0 +1,59 @@
+Description
+===========
+
+Installs the "emacs" package to install the worlds most flexible, customizable text editor.
+
+Changes
+=======
+
+## v0.7.0:
+
+* Initial public release
+
+Roadmap
+-------
+
+* [COOK-551] - FreeBSD Support
+* [COOK-839] - install non-X11 package by setting an attribute
+
+Requirements
+============
+
+A package named "emacs" must be available via the native package manager for the Platform.
+
+Attributes
+==========
+
+Does not use any attributes yet. See __Roadmap__.
+
+Recipes
+=======
+
+default
+-------
+
+Installs the emacs package.
+
+Usage
+=====
+
+Simply add `recipe[emacs]` to the run list of a base role that gets applied to all systems.
+
+License and Author
+==================
+
+Author:: Joshua Timberman <joshua@opscode.com>
+
+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.
View
@@ -0,0 +1,48 @@
+Description
+===========
+
+Installs and configures `fail2ban`, a utility that watches logs for failed login attempts and blocks repeat offenders with firewall rules.
+
+Changes
+=======
+
+## v1.0.0:
+
+* Current public release.
+
+Requirements
+============
+
+A package named "fail2ban" must be available via the native package manager for the Platform.
+
+Recipes
+=======
+
+default
+-------
+
+Installs the fail2ban package, manages 2 templates: `/etc/fail2ban/fail2ban.conf` and `/etc/fail2ban/jail.conf`, and manages the fail2ban service.
+
+Usage
+=====
+
+Typically, include `recipe[fail2ban]` in a base role applied to all nodes.
+
+License and Author
+==================
+
+Author:: Joshua Timberman
+
+Copyright:: 2009-2011, 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.
View
@@ -0,0 +1,65 @@
+Description
+===========
+
+Installs, but does not configure heartbeat.
+
+Changes
+=======
+
+## v0.7.1:
+
+* Current public release.
+
+Roadmap
+-------
+
+Add management of configuration files, possibly with Chef search().
+
+* /etc/ha.d/ha.cf
+* /etc/ha.d/haresources
+* /etc/ha.d/authkeys
+
+Requirements
+============
+
+## Platform:
+
+* Ubuntu 10.04+
+* Debian 6.0+
+
+Recipes
+=======
+
+default
+-------
+
+Installs the heartbeat and heartbeat-dev packages, and manages the
+heartbeat service. The recipe does not at this time manage any configuration.
+
+Usage
+=====
+
+On systems that need to be HA pairs, use this cookbook. Set up one to
+be the primary, and the other to be secondary with a clever role name,
+like "heartbeat-primary" and "heartbeat-secondary". To manage the
+heartbeat configuration files, modifications to the recipe to add
+template resources is required at this time. See __Roadmap__ above.
+
+License and Author
+==================
+
+Author:: Joshua Timberman <joshua@opscode.com>
+
+Copyright:: 2009-2011, 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.
View
@@ -0,0 +1,92 @@
+Description
+===========
+
+Sets up iptables to use a script to maintain firewall rules. However
+this cookbook may be deprecated or heavily modified in favor of the
+general firewall cookbook, see __Roadmap__.
+
+Changes
+=======
+
+## v0.9.3:
+
+* Current public release.
+
+Roadmap
+-------
+
+* [COOK-652] - create a firewall cookbook
+* [COOK-688] - create iptables providers for all resources
+
+Requirements
+============
+
+## Platform:
+
+* Ubuntu/Debian
+* RHEL/CentOS
+
+Recipes
+=======
+
+default
+-------
+
+The default recipe will install iptables and provides a perl script
+(installed in `/usr/sbin/rebuild-iptables`) to manage rebuilding
+firewall rules from files dropped off in `/etc/iptables.d`.
+
+Definitions
+===========
+
+See __Roadmap__ for plans to replace the definition with LWRPs.
+
+iptables\_rule
+--------------
+
+The definition drops off a template in `/etc/iptables.d` after the
+`name` parameter. The rule will get added to the local system firewall
+through notifying the `rebuild-iptables` script. See __Examples__ below.
+
+Usage
+=====
+
+Ensure that the system is set up to use the definition and rebuild
+script with `recipe[iptables]`. Then create templates with the
+firewall rules in the cookbook where the definition will be used. See
+__Examples__.
+
+Examples
+--------
+
+To enable port 80, e.g. in an `httpd` cookbook, create the following
+template:
+
+ # Port 80 for http
+ -A FWR -p tcp -m tcp --dport 80 -j ACCEPT
+
+This would go in the cookbook,
+`httpd/templates/default/port_http.erb`. Then to use it in
+`recipe[httpd]`:
+
+ iptables_rule "http"
+
+License and Author
+==================
+
+Author:: Adam Jacob <adam@opscode.com>
+Author:: Joshua Timberman <joshua@opscode.com>
+
+Copyright:: 2008-2011, 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.
View
@@ -0,0 +1,96 @@
+Description
+===========
+
+Installs and configures Jira and starts it as a service under runit.
+
+Changes
+=======
+
+## v0.8.2
+
+* Current public release
+
+Roadmap
+-------
+
+* [COOK-464] - Automate mysql portions
+
+Requirements
+============
+
+## Platform:
+
+* Ubuntu 10.04
+* Debian 6.0
+
+Requires a MySQL database server, but currently out of scope to run
+this on the same system, or even automatically set it up (see
+__Roadmap__ and __Usage__).
+
+## Cookbooks:
+
+* runit
+* java
+* apache2
+
+Attributes
+==========
+
+See `attributes/default.rb` for defaults.
+
+* `node['jira']['virtual_host_name']` - hostname to use in the virtualhost
+* `node['jira']['virtual_host_alias']` - server alias(es) to use in
+ the virtual host.
+* `node['jira']['version']` - version of jira to install
+* `node['jira']['install_path']` - location where jira should be installed
+* `node['jira']['run_user']` - user to run the jira service as
+* `node['jira']['database']` - the name of the database to connect to
+* `node['jira']['database_host']` - hostname of the database server
+* `node['jira']['database_user']` - user to connect to the database
+* `node['jira']['database_password']` - password to use for the
+ database connection.
+
+Recipes
+=======
+
+default
+-------
+
+The default recipe sets up runit, java and apache2 first, then
+downloads jira-standalone from atlassian of the specified version. It
+also downloads and installs the mysql connector.
+
+After writing the configuration and startup.sh script, jira will start
+under runit, and an apache vhost will be set up for it.
+
+Usage
+=====
+
+Until COOK-464 is released, the following manual steps are required to
+set up the database.
+
+Mysql queries:
+
+ create database jiradb character set utf8;
+ grant all privileges on jiradb.*
+ to '$jira_user'@'localhost' identified by '$jira_password';
+ flush privileges;
+
+License and Author
+==================
+
+Author:: Adam Jacob <adam@opscode.com>
+
+Copyright:: 2008-2011, 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.
Oops, something went wrong.

0 comments on commit 39f696b

Please sign in to comment.