Skip to content

Commit 1c30515

Browse files
author
Matthew Fisher
committed
docs(README): update dev documentation
1 parent 684d800 commit 1c30515

1 file changed

Lines changed: 41 additions & 18 deletions

File tree

README.md

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
To install `deisctl` on Linux or Mac OS X, run this command:
88

99
```console
10-
curl -sSL http://deis.io/deisctl/install.sh | sudo sh
10+
$ curl -sSL http://deis.io/deisctl/install.sh | sudo sh
1111
```
1212

1313
The installer puts `deisctl` in */usr/local/bin* and downloads current Deis unit files
@@ -21,6 +21,17 @@ To change installation options, save the installer directly from one of these li
2121
Then run the downloaded file as a shell script. Append `--help` to see what options
2222
are available.
2323

24+
If you want to install from source, clone the repository and run
25+
26+
```console
27+
$ godep get .
28+
```
29+
30+
Then, export the `DEISCTL_UNITS` environment variable so deisctl can find the units:
31+
32+
```console
33+
$ export DEISCTL_UNITS="$PATH_TO_DEISCTL/units"
34+
```
2435

2536
## Remote Configuration
2637

@@ -42,23 +53,21 @@ $ export DEISCTL_TUNNEL=172.17.8.100
4253

4354
## Provision a Deis Platform
4455

45-
The `deisctl install platform` command will schedule and activate all of the Deis platform units.
56+
The `deisctl install platform` command will schedule all of the Deis platform
57+
units. `deisctl start platform` activates these units.
4658

4759
```console
4860
$ deisctl install platform
61+
● ▴ ■
62+
■ ● ▴ Installing Deis...
63+
▴ ■ ●
4964

5065
Scheduling data containers...
5166
deis-database-data.service: loaded
5267
deis-registry-data.service: loaded
5368
deis-logger-data.service: loaded
5469
deis-builder-data.service: loaded
55-
56-
Launching data containers...
57-
deis-database-data.service: launched
58-
deis-registry-data.service: launched
59-
deis-logger-data.service: launched
60-
deis-builder-data.service: launched
61-
70+
Data containers scheduled.
6271
Scheduling service containers...
6372
deis-database@1.service: loaded
6473
deis-cache@1.service: loaded
@@ -67,19 +76,33 @@ deis-registry@1.service: loaded
6776
deis-controller@1.service: loaded
6877
deis-builder@1.service: loaded
6978
deis-router@1.service: loaded
79+
Service containers scheduled.
80+
Deis installed.
81+
Please run `deisctl start platform` to boot up Deis.
7082

83+
$ deisctl start platform
84+
● ▴ ■
85+
■ ● ▴ Starting Deis...
86+
▴ ■ ●
87+
88+
Launching data containers...
89+
deis-database-data.service: exited
90+
deis-registry-data.service: exited
91+
deis-logger-data.service: exited
92+
deis-builder-data.service: exited
93+
Data containers launched.
7194
Launching service containers...
72-
deis-logger@1.service: launched
73-
deis-cache@1.service: launched
74-
deis-database@1.service: launched
75-
deis-registry@1.service: launched
76-
deis-controller@1.service: launched
77-
deis-builder@1.service: launched
78-
deis-router@1.service: launched
79-
Done.
95+
deis-logger@1.service: running
96+
deis-cache@1.service: running
97+
deis-router@1.service: running
98+
deis-database@1.service: running
99+
deis-controller@1.service: running
100+
deis-registry@1.service: running
101+
deis-builder@1.service: running
102+
Deis started.
80103
```
81104

82-
Note that the default install command activates 1 of each component.
105+
Note that the default start command activates 1 of each component.
83106
You can scale components with `deisctl scale router=3`, for example.
84107
The router is the only component that _currently_ scales beyond 1 unit.
85108

0 commit comments

Comments
 (0)