Ensemble needed documentation
Ahmed Kamal
kim0 at ubuntu.com
Tue Apr 19 10:56:56 UTC 2011
Hi everyone,
I'd like to improve Ensemble docs on the short term (hopefully
before/during UDS-O). I've thought about it, and below is what I think
needs to be written asap. Comments are welcome ASAP :)
- Ensemble user tutorial: Explains and demos how and why ensemble is
useful and cool. This goes after the "Getting Started" section, and goes
through a usage cycle of:
* Deploying mysql/wordpress from examples, verifying operation,
showing and understanding "status"
* Deploying a separate ec2 instance (manually) for load testing (ab?)
* Stressing the system, recording how much pages it can generate
* Adding 2 more wordpress service units and a load balancer
* Stressing how everything "just works" auto-magically
* Stress testing again, noting the system has scaled. By now the user
should be interested enough :)
- Understanding Formula execution
* tracing through execution of wordpress/mysql formulas execution
* showing snapshots of hook code being executed at different events,
and commenting on that
* Perhaps showing some state diagram of some sort
* This should be a better commented version of
http://bazaar.launchpad.net/~kim0/ensemble/adding-hook-traces-to-readme-for-bashified-example/revision/186
- Documentation for Formula contributor:
* How to branch lp:principia
* Writing your own formula (need to pick a hello world example, any
ideas?)
* Pushing to LP, proposing for merge
* Getting Help, IRC rooms, mailing lists, joining Ensemble meeting
More information about the Ensemble
mailing list