Permalink
Browse files

Updated and improved READMEs

  • Loading branch information...
1 parent b062710 commit 34d932455b97d887199f2bab0a5102ababdc09da Ben Rockwood committed Sep 21, 2012
Showing with 56 additions and 16 deletions.
  1. +22 −2 README.md
  2. +3 −5 cookbooks/bart/README.rdoc
  3. +1 −4 cookbooks/logging/README.rdoc
  4. +22 −2 cookbooks/smartos/README.rdoc
  5. +8 −3 cookbooks/zabbix/README.rdoc
View
@@ -3,6 +3,24 @@ smartos_cookbooks
Chef Cookbooks and tools for use with SmartOS. This is intended for management of the Global Zone, not SmartMachines (NGZs).
+For details about how to use this repository, please refer to http://wiki.smartos.org/display/DOC/Using+Chef
+
+
+ABOUT THE TOOLS
+---------------
+
+cookbooks:: Indivial SmartOS cookbooks. The "smartos" cookbook itself is considered the primary cookbooks applied to all
+ nodes and should be the first one included in the run_list.
+
+knife_bootstrap:: Bootstrap templates for Knife.
+
+nodes:: Chef node attribute files.
+
+smf:: SmartOS SMF XML manifests for Chef Solo & Chef Client
+
+scripts:: Chef Solo bootstrap scripts to simplify deployment.
+
+For Chef Solo users, a *Makefile* is included to transfer the contents of the repsitory to a web server for distribution.
DISLAIMER
@@ -14,6 +32,8 @@ These cookbooks are unofficial and not supported by Joyent or its partners. Ple
TODO
----
-* Setting the hostname needs to work smoothly via both chef-solo and chef-client
-* Add solo script example
* Make fat client bootstrap more verbose (add echos), make pkgsrc bootstrap less verbose.
+* Sanitize and include LDAP Client cookbook
+* LWRP for managing images (_imgadm_)
+* LWRP improvements for user management
+* LWRP improvements for SMF management
@@ -1,8 +1,6 @@
= DESCRIPTION:
-= REQUIREMENTS:
-
-= ATTRIBUTES:
-
-= USAGE:
+Installs and configures BARTlog, a tool for running BART daily and outputting notifications via syslog.
+BART is the Basic Auditing & Reporting Tool; is is the SmartOS equivilent of Tripwire. For more information please refer to:
+http://www.cuddletech.com/blog/pivot/entry.php?id=1046
@@ -2,9 +2,6 @@
Joyent Logging configuration, including Syslog, SSH, /etc/default tunings, etc.
-= REQUIREMENTS:
-
= ATTRIBUTES:
-= USAGE:
-
+default[:syslog][:server]:: Remote Syslog server to send log messages to.
@@ -1,9 +1,29 @@
= DESCRIPTION:
-= REQUIREMENTS:
+The basic SmartOS cookbook responsible for applying changes which should be applied to _all_ nodes. This should always be the first cookbook/recipe in your run_list.
+= RECIPES:
+
+default::
+
+motd:: Uses an ERB template to create /etc/motd
+
+nicstat:: Install Tim Cook's _nicstat_ tool to /opt/custom/bin.
+
+ntp:: Configures NTP
+
+ssh:: Manage the Root SSH User Configuration
= ATTRIBUTES:
-= USAGE:
+default[:ntp][:servers]:: An array of NTP servers. _Defaults to NTP pool servers._
+
+default[:dns][:search]:: DNS resolver default search domain. _Defaults to smartos.org._
+
+default[:dns][:nameservers]:: An array of DNS servers used by the DNS resolver. _Defaults to OpenDNS servers._
+
+default[:ssh][:pubkey]:: If a URL to an SSH public key is present, it is added to the root users account (/root/.ssh/). _There is no default, if parameter is missing no action is taken._
+
+default[:ssh][:privkey]:: If a URL to an SSH private key is present, it is added to the root users account (/root/.ssh/). _There is no default, if parameter is missing no action is taken._
+default[:ssh][:authorized_keys]:: If an array of public keys are present, they are added to the root users /root/.ssh/authorized_keys file. _There is no default, if parameter is missing no action is taken._
@@ -1,10 +1,15 @@
= DESCRIPTION:
-Zabbix agent installation.
-
-= REQUIREMENTS:
+Zabbix agent installation. A staticly compiled Zabbix agent is included in this cookbook.
= ATTRIBUTES:
+
+default[:zabbix][:server]:: IP Address or FQDN of Zabbix Proxy or Server.
+
+default[:zabbix][:external_nic]:: Public NIC to monitor
+
= USAGE:
+Include zabbix::agent in your run_list
+

0 comments on commit 34d9324

Please sign in to comment.