Skip to content
Newer
Older
100644 91 lines (62 sloc) 1.67 KB
b9fc1d6 @substack added readme
authored Feb 28, 2012
1 fleet
2 =====
3
4 Command an armada of processes in a cluster.
5
e65c839 @substack documented all the commands
authored Feb 29, 2012
6 This module integrates with git using
b9fc1d6 @substack added readme
authored Feb 28, 2012
7 [propagit](https://github.com/substack/propagit),
e65c839 @substack documented all the commands
authored Mar 1, 2012
8 to make rolling out new code to a bunch of worker drones super simple!
9
827e9ea @substack using travis
authored Apr 12, 2012
10 [![build status](https://secure.travis-ci.org/substack/fleet.png)](http://travis-ci.org/substack/fleet)
11
f0ac71d @substack readme art
authored Mar 29, 2012
12 ![fleet](http://substack.net/images/fleet.png)
13
e65c839 @substack documented all the commands
authored Mar 1, 2012
14 install
15 =======
16
17 With [npm](http://npmjs.org) do:
18
19 ```
20 npm install -g fleet
21 ```
b9fc1d6 @substack added readme
authored Feb 28, 2012
22
23 example
24 =======
25
26 In a fresh directory, start a fleet hub:
27
28 ```
29 $ fleet hub --port=7000 --secret=beepboop
30 ```
31
e65c839 @substack documented all the commands
authored Mar 1, 2012
32 in another fresh directory start a drone:
b9fc1d6 @substack added readme
authored Feb 28, 2012
33
34 ```
35 $ fleet drone --hub=localhost:7000 --secret=beepboop
36 ```
37
e65c839 @substack documented all the commands
authored Mar 1, 2012
38 You can start as many drones as you want in fresh directories.
39
40 Now from a git repo, set a remote:
41
42 ```
43 $ fleet remote add default --hub=localhost:7000 --secret=beepboop
44 ```
45
46 Now deploy your code to all the drones:
b9fc1d6 @substack added readme
authored Feb 28, 2012
47
48 ```
e65c839 @substack documented all the commands
authored Mar 1, 2012
49 $ fleet deploy
b9fc1d6 @substack added readme
authored Feb 28, 2012
50 ```
51
e65c839 @substack documented all the commands
authored Mar 1, 2012
52 Deploying just checks out your commit to a fresh directory on every drone.
53
54 To run a process on the latest commit do:
b9fc1d6 @substack added readme
authored Feb 28, 2012
55
56 ```
e65c839 @substack documented all the commands
authored Mar 1, 2012
57 $ fleet spawn -- node beep.js 8080
58 ```
59
60 To see the process list across all your drones do:
61
62 ```
63 $ fleet ps
b9fc1d6 @substack added readme
authored Feb 28, 2012
64 ```
65
66 commands
67 ========
68
0554051 @substack updated readme with example output for commands
authored Mar 7, 2012
69 ```
4c6bbb5 @substack pared down the readme since all the docs are available with `fleet help`
authored Apr 12, 2012
70 Usage: fleet <command> [<args>]
e65c839 @substack documented all the commands
authored Mar 1, 2012
71
4c6bbb5 @substack pared down the readme since all the docs are available with `fleet help`
authored Apr 12, 2012
72 The commands are:
73 deploy Push code to drones.
74 drone Connect to a hub as a worker.
75 exec Run commands on drones.
76 hub Create a hub for drones to connect.
77 monitor Show service events system-wide.
78 ps List the running processes on the drones.
79 remote Manage the set of remote hubs.
80 spawn Run services on drones.
81 stop Stop processes running on drones.
75b85d7 @sent1nel Ugh, more crap about usage
sent1nel authored Jul 9, 2012
82 version Print fleet's version
e65c839 @substack documented all the commands
authored Mar 1, 2012
83
4c6bbb5 @substack pared down the readme since all the docs are available with `fleet help`
authored Apr 12, 2012
84 For help about a command, try `fleet help <command>`.
0554051 @substack updated readme with example output for commands
authored Mar 7, 2012
85 ```
86
4c6bbb5 @substack pared down the readme since all the docs are available with `fleet help`
authored Apr 12, 2012
87 license
88 =======
0554051 @substack updated readme with example output for commands
authored Mar 7, 2012
89
4c6bbb5 @substack pared down the readme since all the docs are available with `fleet help`
authored Apr 12, 2012
90 MIT
Something went wrong with that request. Please try again.