Permalink
Browse files

Actually add the readmes

  • Loading branch information...
1 parent 01c13c0 commit 181450a9fc0f04997077f6a8d9dbb6e942071e1a @jtimberman jtimberman committed Jun 26, 2010
Showing with 284 additions and 0 deletions.
  1. +23 −0 apparmor/README.md
  2. +44 −0 apt/README.md
  3. +23 −0 build-essential/README.md
  4. +53 −0 capistrano/README.md
  5. +61 −0 couchdb/README.md
  6. +80 −0 djbdns/README.md
View
@@ -0,0 +1,23 @@
+DESCRIPTION
+===========
+
+Stops and disables the apparmor service on Ubuntu.
+
+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,44 @@
+DESCRIPTION
+===========
+
+Configures various APT components on Debian-like systems.
+
+RECIPES
+=======
+
+default
+-------
+
+The default recipe runs apt-get update during the Compile Phase of the Chef run to ensure that the system's package cache is updated with the latest. It is recommended that this recipe appear first in a node's run list (directly or through a role) to ensure that when installing packages, Chef will be able to download the latest version available on the remote APT repository.
+
+This recipe also sets up a local cache directory for preseeding packages.
+
+cacher
+------
+
+Installs the apt-cacher package and service so the system can be an APT cache.
+
+proxy
+-----
+
+Installs the apt-proxy package and service so the system can be an APT proxy.
+
+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,23 @@
+DESCRIPTION
+===========
+
+Installs packages required for compiling C software from source.
+
+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,53 @@
+DESCRIPTION
+===========
+
+Installs capistrano RubyGem and provides a definition to set up directory structure to perform capistrano deployment.
+
+This cookbook is not necessary when using the Opscode application cookbook.
+
+RECIPES
+=======
+
+The default recipe merely installs the capistrano RubyGem.
+
+DEFINITIONS
+===========
+
+cap_setup
+---------
+
+The `cap_setup` definition will create the deployment directory structure for deploying applications with capistrano. For example to use the definition:
+
+ cap_setup "my_app" do
+ path "/srv/my_app"
+ owner "nobody"
+ group "nogroup"
+ appowner "nobody"
+ end
+
+This will create the following directory structure:
+
+ /srv/my_app
+ /srv/my_app/releases
+ /srv/my_app/shared
+ /srv/my_app/shared/log
+ /srv/my_app/shared/system
+
+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,61 @@
+DESCRIPTION
+===========
+
+REQUIREMENTS
+============
+
+Requires a platform that can install Erlang from distribution packages.
+
+Platform
+--------
+
+Works on Debian 5+, Ubuntu 8.10+, OpenBSD and FreeBSD.
+
+Also works on Red Hat, CentOS and Fedora, requires the EPEL yum repository.
+
+Cookbooks
+---------
+
+Requires the erlang cookbook so erlang can be installed.
+
+ATTRIBUTES
+==========
+
+Cookbook attributes are named under the `couch_db` keyspace. The attributes specified in the cookbook are used in the `couchdb::source` recipe only.
+
+* `node[:couch_db][:src_checksum]` - sha256sum of the default version of couchdb to download
+* `node[:couch_db][:src_version]` - default version of couchdb to download, used in the full URL to download.
+* `node[:couch_db][:src_mirror]` - full URL to download.
+
+RECIPES
+=======
+
+default
+-------
+
+Installs the couchdb package, creates the data directory and starts the couchdb service.
+
+source
+------
+
+Downloads the CouchDB source from the Apache project site, plus development dependencies. Then builds the binaries for installation, creates a user and directories, then sets up the couchdb service. Uses the init script provided in the cookbook.
+
+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,80 @@
+DESCRIPTION
+===========
+
+Installs and configures Dan Bernstein's DNS tinydns, aka djbdns. Services are configured to start up under runit.
+
+REQUIREMENTS
+============
+
+Platform
+--------
+
+Known to work on Debian, Ubuntu, Red Hat and CentOS.
+
+Cookbooks
+---------
+
+* build-essential - for compiling the source.
+* runit - for setting up the services.
+
+ATTRIBUTES
+==========
+
+* `node[:djbdns][:tinydns_ipaddress]` - listen address for public facing tinydns server
+* `node[:djbdns][:tinydns_internal_ipaddress]` - listen address for internal tinydns server
+* `node[:djbdns][:public_dnscache_ipaddress]` - listen address for public DNS cache
+* `node[:djbdns][:axfrdns_ipaddress]` - listen address for axfrdns
+* `node[:djbdns][:public_dnscache_allowed_networks]` - subnets that are allowed to talk to the dnscache.
+* `node[:djbdns][:tinydns_internal_resolved_domain]` - default domain this tinydns serves
+* `node[:djbdns][:bin_dir]` - default location where binaries will be stored.
+* `node[:djbdns][:axfrdns_uid]` - default uid for the axfrdns user
+* `node[:djbdns][:dnscache_uid]` - default uid for the dnscache user
+* `node[:djbdns][:dnslog_uid]` - default uid for the dnslog user
+* `node[:djbdns][:tinydns_uid]` - default uid for the tinydns user
+
+RECIPES
+=======
+
+default
+-------
+
+The default recipe installs djbdns software from package where available, otherwise installs from source. It also sets up the users that will run the djbdns services using the UID's specified by the attributes above.
+
+axfr
+----
+
+Creates the axfrdns user and sets up the axfrdns service.
+
+cache
+-----
+
+Sets up a local DNS caching server.
+
+internal_server
+---------------
+
+Sets up a server to be an internal nameserver. To modify resource records in the environment, modify the tinydns-internal-data.erb template.
+
+server
+------
+
+Sets up a server to be a public nameserver. To modify resource records in the environment, modify the tinydns-data.erb template.
+
+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.

0 comments on commit 181450a

Please sign in to comment.