Skip to content

Commit 41645ee

Browse files
Gabriel MonroyMatthew Fisher
authored andcommitted
doc(readme): update README instructions for dev setup
1 parent 18d1626 commit 41645ee

1 file changed

Lines changed: 33 additions & 37 deletions

File tree

README.md

Lines changed: 33 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,62 @@ Deis is an open source PaaS that makes it easy to deploy, scale and manage Docke
99

1010
# Installation
1111

12-
Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation. You will need Docker and a CoreOS cluster to get started.
12+
Deis is a set of Docker containers that can be deployed anywhere including public cloud, private cloud, bare metal or your workstation. You will need Docker and Vagrant to get started.
1313

14-
## Run Deis
14+
## Boot CoreOS
15+
16+
Start a CoreOS virtual machine on VirtualBox.
17+
18+
```
19+
vagrant up
20+
```
1521

16-
Build Deis and run the `deis/deis` Docker image.
22+
Export some environment variables so you can connect to the VM using the `docker` and `fleetctl` clients on your workstation.
23+
24+
```
25+
export DOCKER_HOST=tcp://172.17.8.100:4243
26+
export FLEETCTL_TUNNEL=172.17.8.100
27+
```
28+
29+
## Build Deis
30+
31+
Use `make build` to assemble all of the Deis components from Dockerfiles. Grab some coffee while it builds the images on the CoreOS VM (it can take a while).
1732

1833
```
1934
make build
35+
```
36+
37+
## Run Deis
38+
39+
Use `make run` to start all Deis containers and attach to their log output.
40+
41+
```
2042
make run
2143
```
2244

2345
## Install the Deis Client
24-
Use `pip` to install the latest Deis Client, or download pre-compiled binares.
46+
Use `pip` to install the latest Deis Client, download pre-compiled binares, or symlink `client/deis.py` to use the latest version.
2547

2648
```
27-
pip install deis
49+
ln -fs $(pwd)/client/deis.py /usr/local/bin/deis
2850
```
2951

3052
## Register a User
3153
Use the Deis Client to register a new user.
3254

3355
```
34-
deis register http://localhost:8000
56+
deis register http://local.deisapp.com:8000
57+
deis keys:add
3558
```
3659

60+
Use `deis keys:add` to add your SSH public key for `git push` access.
61+
3762
## Initalize a Cluster
3863

3964
Initalize a `dev` cluster with a list of CoreOS hosts and your CoreOS private key.
4065

4166
```
42-
deis clusters:create dev deisapp.com --hosts=coreos-host1,coreos-host2,coreos-host3 --auth=~/.ssh/coreos
67+
deis clusters:create dev local.deisapp.com --hosts=local.deisapp.com --auth=~/.vagrant.d/insecure_private_key
4368
```
4469

4570
The `dev` cluster will be used as the default cluster for future `deis` commands.
@@ -66,23 +91,6 @@ git push deis master
6691
```
6792
This will use the Deis builder to package your application as a Docker Image and deploy it on your application's cluster.
6893

69-
#### From a Docker Registry
70-
71-
You can also push builds directly from the Docker Index or a private Docker registry. First, build and push the Docker images as you normally do:
72-
73-
```
74-
docker build -t gabrtv/example
75-
docker push gabrtv/example
76-
```
77-
78-
Then use `deis push` to deploy.
79-
80-
```
81-
deis push gabrtv/example
82-
```
83-
84-
Use the fully qualfied image path to push from a private registry: `deis push registry.local:5000/gabrtv/example`
85-
8694
## Configure
8795
Configure your application with environment variables. Each config change also creates a new release.
8896

@@ -105,21 +113,9 @@ To integrate with your CI system, check the return code.
105113
Scale containers horizontally with ease.
106114

107115
```
108-
deis scale 8
109-
```
110-
111-
To scale by process type, use `deis scale web=8 worker=2` . Just make sure the process types can be run via `/start web`.
112-
113-
## Publish
114-
Publish your application via each cluster's integrated router.
115-
116-
```
117-
deis publish 8080/http
118-
deis domain myapp.example.com
116+
deis scale web=8
119117
```
120118

121-
Use `deis open` to pop into a browser pointed at your application. Use `--sslCert=cert.pem --sslKey=key.pem` to secure the connection with SSL/TLS.
122-
123119
## Debug
124120
Access to aggregated logs makes it easy to troubleshoot problems with your application.
125121

0 commit comments

Comments
 (0)