Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

changed the documentation section under index (committed without cont…

…ent before!)
  • Loading branch information...
commit bd4405d33b58427fd7057d673e09197c7e2b1dc3 1 parent 4ea23da
@sya sya authored
Showing with 34 additions and 0 deletions.
  1. +34 −0 README.md
View
34 README.md
@@ -0,0 +1,34 @@
+# Ironfan-Homebase: Master Plans for a Scalable Architecture
+
+Ironfan, the foundation of The Infochimps Platform, is an expressive toolset for constructing scalable, resilient architectures. It works in the cloud, in the data center, and on your laptop, and it makes your system diagram visible and inevitable. Inevitable systems coordinate automatically to interconnect, removing the hassle of manual configuration of connection points (and the associated danger of human error).
+For more information about how Ironfan and The Infochimps Platform work together, visit the [How it Works Infochimps Platform page](http://blog.infochimps.com/2012/02/22/infochimps-platform/).
+
+The Ironfan Homebase repository is the central home for orchestrating your architecture. It unifies:
+
+* Cookbooks, roles, and environments
+* Cluster descriptions
+* Your Chef and cloud credentials
+* Pantries (collections of cookbooks, roles and so forth)
+
+## Getting Started
+
+To jump right into using Ironfan, follow our [Installation Instructions](https://github.com/infochimps-labs/ironfan/wiki/INSTALL). For an explanatory tour, check out our [Hadoop Walkthrough](https://github.com/infochimps-labs/ironfan/wiki/INSTALL). Please file all issues on [Ironfan Issues](https://github.com/infochimps-labs/ironfan/issues).
+
+## Index
+
+ironfan-homebase works together with the full Ironfan toolset:
+
+###Core Tools:
+
+* [ironfan-homebase](https://github.com/infochimps-labs/ironfan-homebase): Centralizes the cookbooks, roles and clusters. A solid foundation for any Chef user.
+* [ironfan gem](https://github.com/infochimps-labs/ironfan): The core Ironfan models, and Knife plugins to orchestrate machines and coordinate truth among your homebase, cloud and chef server.
+* [ironfan-pantry](https://github.com/infochimps-labs/ironfan-pantry): Our collection of industrial-strength, cloud-ready recipes for Hadoop, HBase, Cassandra, Elasticsearch, Zabbix and more.
+* [silverware cookbook](https://github.com/infochimps-labs/ironfan-pantry/tree/master/cookbooks/silverware): Helps you coordinate discovery of services ("list all the machines for `awesome_webapp`, that I might load balance them") and aspects ("list all components that write logs, that I might logrotate them, or that I might monitor the free space on their volumes"). Found within the [ironfan-pantry](https://github.com/infochimps-labs/ironfan-pantry).
+
+###Core Documentation:
+
+* [index of wiki pages](https://github.com/infochimps-labs/ironfan/wiki/_pages)
+* [ironfan wiki](https://github.com/infochimps-labs/ironfan/wiki): High-level documentation and install instructions.
+* [ironfan issues](https://github.com/infochimps-labs/ironfan/issues): Bugs or questions and feature requests for *any* part of the Ironfan toolset.
+* [ironfan gem docs](http://rdoc.info/gems/ironfan): Rdoc docs for Ironfan.
+* [Ironfan Screen Cast](http://vimeo.com/37279372)-- build a Hadoop cluster from scratch in 20 minutes.
Please sign in to comment.
Something went wrong with that request. Please try again.