Skip to content

Commit 1c739fd

Browse files
committed
Rewrote README.
1 parent 9f91d94 commit 1c739fd

1 file changed

Lines changed: 33 additions & 15 deletions

File tree

‎README.textile‎

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,63 @@ A utility for arming (creating) many bees (micro EC2 in stances) to attack (load
66

77
h2. Dependencies
88

9-
Required:
10-
9+
* Python 2.6
1110
* boto
12-
* fabric
1311
* paramiko
1412

15-
Recommended:
13+
h2. Installation for users
14+
15+
<pre>
16+
% easy_install beeswithmachineguns
17+
</pre>
1618

17-
* virtualenv
18-
* virtualenvwrapper
19+
<pre>
20+
% pip install beeswithmachineguns
21+
</pre>
1922

20-
h2. Installation w/ virtualenvwrapper
23+
h2. Installation for developers (w/ virtualenv + virtualenvwrapper)
2124

2225
<pre>
26+
% git clone git://github.com/newsapps/beeswithmachineguns.git
2327
% cd beeswithmachineguns
2428
% mkvirtualenv --no-site-packages bees
2529
% easy_install pip
2630
% pip install -r requirements.txt
2731
</pre>
2832

33+
h2. EC2 credentials
34+
35+
Bees uses boto to communicate with EC2 and thus supports all the methods of vstoring credentials that it does. These include: declaring environment variables, machine-global configuration files, and per-user configuration files. You can read more about these options on "boto's configuration page":http://code.google.com/p/boto/wiki/BotoConfig
36+
2937
h2. Usage
3038

39+
A type bees session looks something like this:
40+
3141
<pre>
32-
fab -f bees.py up:5,staging,us-east-1d
33-
fab -f bees.py attack:http://YOUR-DOMAIN.com/,1000,100
34-
fab -f bees.py down
42+
bees up -s 4 -g public -k frakkingtoasters
43+
bees attack -n 10000 -c 250 -u http://www.ournewwebbyhotness.com/
44+
bees down
3545
</pre>
3646

37-
h2. Quirks
47+
This spins up 4 servers in security group 'public' using the EC2 key 'frakkingtoasters', which is expected to reside in ~/.ssh/.
3848

39-
The AMI to clone and SSH key to use are currently hard-coded into the up() function, expect this to be fixed shortly. In the meantime, its open-source, fork it!
49+
It then uses those 4 servers to send 10,000 requests, 250 at a time, to attack OurNewWebbyHotness.com.
4050

41-
h2. Tested with
51+
Lastly, it spins down the 4 servers. Please remember to do this--we aren't responsible for your EC2 bills.
4252

43-
* Python 2.6
53+
For complete options type:
54+
55+
<pre>
56+
bees -h
57+
</pre>
58+
59+
h2. Bugs
60+
61+
Please log your bugs on the "Github issues tracker":http://github.com/newsapps/beeswithmachineguns/issues
4462

4563
h2. Credits
4664

47-
A creation of the News Applications team at the Chicago Tribune--visit "our blog":http://apps.chicagotribune.com/ and read "our post about the project":http://blog.apps.chicagotribune.com/2010/07/%2008/bees-with-machine-guns/
65+
The bees are a creation of the News Applications team at the Chicago Tribune--visit "our blog":http://apps.chicagotribune.com/ and read "our original post about the project":http://blog.apps.chicagotribune.com/2010/07/%2008/bees-with-machine-guns/
4866

4967
Initial refactoring code and inspiration from "Jeff Larson":http://github.com/thejefflarson
5068

0 commit comments

Comments
 (0)