Skip to content

Commit fdcd7d9

Browse files
author
Gabriel Monroy
committed
more doc updates
1 parent f3ac491 commit fdcd7d9

6 files changed

Lines changed: 44 additions & 45 deletions

File tree

docs/gettingstarted/concepts.rst

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Concepts
88
========
99

1010
Deis is an application platform that deploys and scales `Twelve Factor`_ apps
11-
using a formation of `Chef`_ nodes, `Docker`_ containers and `Nginx`_ proxies.
11+
using formations of `Chef`_ nodes, `Docker`_ containers and `Nginx`_ proxies.
1212

1313
Formations
1414
----------
@@ -25,31 +25,28 @@ easily. Formations have two primary types of layers.
2525

2626
Runtime Layers
2727
^^^^^^^^^^^^^^
28-
Runtime layers service requests and run background tasks for the formation.
29-
Nodes in a runtime layer use a `Chef Databag`_ to deploy
30-
:ref:`Containers <container>` running a specific :ref:`Release`.
28+
Runtime layers host :ref:`Containers <container>` for a formation.
29+
Nodes in a runtime layer use a `Chef Databag`_ to deploy containers for
30+
each :ref:`application` in the formation.
3131

3232
Proxy Layers
3333
^^^^^^^^^^^^
34-
Proxy layers expose the formation to the outside world.
34+
Proxy layers expose :ref:`Applications <application>` to the outside world.
3535
Nodes in a proxy layer use a `Chef Databag`_ to configure routing of
3636
inbound requests to :ref:`Containers <container>` hosted on runtime layers.
3737

3838
Applications
3939
------------
40-
41-
An :ref:`application` lives on a :ref:`formation` where it services requests
42-
and runs background jobs for a deployed git repository. Each application includes
43-
:ref:`Containers <container>` used to run isolated processes, and a
44-
:ref:`Release` that defines the current :ref:`Build` and :ref:`config`
45-
deployed by containers.
46-
47-
Developers can use :ref:`Applications <application>` to push builds, change config
48-
and scale containers without worrying about the formation's underlying infrastructure.
40+
An :ref:`application` lives on a :ref:`formation` where it uses
41+
:ref:`Containers <container>` to process requests and run background jobs
42+
for a deployed git repository.
43+
Developers use :ref:`Applications <application>` to push code, change config,
44+
scale containers, view logs, or run admin commands --
45+
regardless of the formation's underlying infrastructure.
4946

5047
Build, Release, Run
5148
-------------------
52-
Deis enforces strict separation between Build, Release and Run stages
49+
Deis enforces strict separation between Build and Run stages
5350
following the `Twelve Factor model`_.
5451

5552
Build Stage
@@ -72,19 +69,20 @@ config is changed, making it easy to rollback code and configuration.
7269
Run Stage
7370
^^^^^^^^^
7471
The run stage updates Chef databags and `converges`_ all nodes in the formation.
75-
The databag specifies the current release, the placement of containers across
76-
the runtime layer, and the configuration of the proxy layer.
77-
SSH is used to converge all of the nodes in the runtime layer followed
78-
by all of the nodes in the proxy layer, making zero downtime deployment possible.
72+
The databag specifies the current application releases,
73+
the placement of containers across the runtime layer,
74+
and the configuration of the proxy layer.
75+
SSH is used to converge nodes in runtime layers followed
76+
by nodes in proxy layers, making zero downtime deployment possible.
7977

8078
Backing Services
8179
----------------
8280
In keeping with `Twelve Factor`_ methodology, `backing services`_ like
8381
databases, queues and storage are decoupled and attached using `environment
84-
variables`_. This allows formations to use backing services provided via
85-
different formations (through their proxy layer), or external/third-party
86-
services accessible over the network. The use of environment variables
87-
also allows formations to easily swap backing services when necessary.
82+
variables`_. This allows applications to use backing services provided by
83+
other applications, or external/third-party services accessible over the network.
84+
The use of environment variables makes it easy to swap backing services
85+
when necessary.
8886

8987
See Also
9088
--------

docs/gettingstarted/installation.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:title: Installation
2-
:description: Install your own Deis platform on EC2. Configure the Chef server, provision a Deis controller, install the Deis Client and create & scale a formation.
2+
:description: Install your own Deis platform on EC2. Provision a Deis controller, Install the Deis Client, Create & Scale a Formation, Deploy & Scale an Application.
33

44
.. _installation:
55

@@ -89,6 +89,7 @@ Registration will discover SSH keys automatically and use the
8989
$ deis register http://my-deis-controller.fqdn
9090
username: myuser
9191
password:
92+
password (confirm):
9293
email: myuser@example.com
9394
Registered myuser
9495
Logged in as myuser
@@ -109,13 +110,12 @@ Registration will discover SSH keys automatically and use the
109110
Use the Deis client to create a new formation named "dev" that
110111
has a default layer that serves as both runtime (hosts containers)
111112
and proxy (routes traffic to containers). Scale the default layer
112-
up to two nodes.
113+
up to one node.
113114

114115
.. code-block:: console
115116
116117
$ deis formations:create dev --flavor=ec2-us-west-2
117118
Creating formation... done, created dev
118-
119119
Creating runtime layer... done in 1s
120120
121121
Use `deis nodes:scale dev runtime=1` to scale a basic formation
@@ -138,9 +138,9 @@ To deploy the application, use ``git push deis master``.
138138
Deis will automatically deploy Docker containers and configure Nginx proxies
139139
to route requests to your application.
140140

141-
Once your application is deployed, you use ``deis scale web=4`` to
141+
Once your application is deployed, use ``deis scale web=4`` to
142142
scale up web containers. You can also use ``deis logs`` to view
143-
aggregated application logs, or ``deis run`` to run one-off admin
143+
aggregated application logs, or ``deis run`` to run admin
144144
commands inside your application.
145145

146146
To learn more, use ``deis help`` or browse `the documentation`_.
@@ -150,6 +150,7 @@ To learn more, use ``deis help`` or browse `the documentation`_.
150150
$ deis create --formation=dev
151151
Creating application... done, created peachy-waxworks
152152
Git remote deis added
153+
153154
$ git push deis master
154155
Counting objects: 146, done.
155156
Delta compression using up to 8 threads.
@@ -169,9 +170,9 @@ To learn more, use ``deis help`` or browse `the documentation`_.
169170
Launching... done, v2
170171
171172
-----> peachy-waxworks deployed to Deis
172-
http://ec2-54-214-143-104.us-west-2.compute.amazonaws.com ...
173+
http://peachy-waxworks.deisapp.com ...
173174
174-
$ curl -s http://ec2-54-214-143-104.us-west-2.compute.amazonaws.com
175+
$ curl -s http://peachy-waxworks.deisapp.com
175176
Powered by Deis!
176177
177178
$ deis scale web=4
@@ -181,10 +182,10 @@ To learn more, use ``deis help`` or browse `the documentation`_.
181182
=== peachy-waxworks Containers
182183
183184
--- web: `node server.js`
184-
web.1 up 2013-09-23T19:02:30.745Z (dev-runtime-2)
185+
web.1 up 2013-09-23T19:02:30.745Z (dev-runtime-1)
185186
web.2 up 2013-09-23T19:36:48.741Z (dev-runtime-1)
186187
web.3 up 2013-09-23T19:36:48.758Z (dev-runtime-1)
187-
web.4 up 2013-09-23T19:36:48.771Z (dev-runtime-2)
188+
web.4 up 2013-09-23T19:36:48.771Z (dev-runtime-1)
188189
189190
190191
.. _`Git`: http://git-scm.com

docs/terms/build.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
:title: Build
2-
:description: A Deis build refers to the output of a specific application build. Deis builds are created automatically using git push.
2+
:description: Deis builds are created automatically on the controller when a developer uses git push.
33
:keywords: build, release, git, git push, deis
44

55
.. _build:
66

77
Build
88
=====
9-
A Deis build refers to the output of a specific application build.
109
Deis builds are created automatically on the controller when a
1110
developer uses ``git push deis master``.
1211

docs/terms/controller.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ the application platform. A single controller manages multiple
1313
container formations.
1414

1515
Controllers are tied to a configuration management backend (typically a
16-
Chef Server) where data about users, applications and formations
17-
is stored and updated.
16+
Chef Server) where data about users, applications and formations is stored.
1817

1918
The controller is in charge of:
2019

docs/terms/formation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
:title: Formation
2-
:description: A Deis formation is a set of infrastructure used to host applications and services
2+
:description: A Deis formation is a set of infrastructure used to host applications.
33
:keywords: formation, deis
44

55
.. _formation:
66

77
Formation
88
=========
9-
A :ref:`formation` is a set of infrastructure used to host :ref:`Applications <application>`
10-
and services. Each formation includes :ref:`Layers <layer>` of :ref:`Nodes <node>`,
11-
and is managed by a single :ref:`Controller`.
9+
A :ref:`formation` is a set of infrastructure used to host :ref:`Applications <application>`.
10+
Each formation includes :ref:`Layers <layer>` of :ref:`Nodes <node>`
11+
that provide different services to the formation.

docs/terms/layer.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ easily.
1313

1414
Runtime Layers
1515
^^^^^^^^^^^^^^
16-
Runtime layers service requests and run background tasks for the formation.
17-
Nodes in a runtime layer use a configuration management system (e.g. Chef Server)
18-
to deploy :ref:`Containers <container>` running a specific :ref:`Release`.
16+
Runtime layers host :ref:`Containers <container>` for a formation.
17+
Nodes in a runtime layer use a `Chef Databag`_ to deploy containers for
18+
each :ref:`application` in the formation.
1919

2020
Proxy Layers
2121
^^^^^^^^^^^^
22-
Proxy layers expose the formation to the outside world.
23-
Nodes in a proxy layer use configuration management to configure routing of
22+
Proxy layers expose :ref:`Applications <application>` to the outside world.
23+
Nodes in a proxy layer use a `Chef Databag`_ to configure routing of
2424
inbound requests to :ref:`Containers <container>` hosted on runtime layers.
2525

2626
Dual Layers
@@ -34,3 +34,5 @@ Custom Layers
3434
It is also possible to create custom layers that don't provide runtime or proxy
3535
services to the formation. This is useful for scaling and managing backing
3636
services built with Chef that need to be managed alongside a formation.
37+
38+
.. _`Chef Databag`: http://docs.opscode.com/essentials_data_bags.html

0 commit comments

Comments
 (0)