Skip to content

Commit ca46506

Browse files
author
Gabriel Monroy
committed
update terms post application object model changes
1 parent a254564 commit ca46506

13 files changed

Lines changed: 72 additions & 57 deletions

‎docs/terms/application.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
:title: Application
2+
:description: A Deis application services requests and background jobs from a deployed git repository.
3+
:keywords: application, app, deis
4+
5+
.. _application:
6+
7+
Application
8+
===========
9+
An application services requests and background jobs for a deployed git repository.
10+
Each application is includes a set of :ref:`Containers <container>`
11+
used to run isolated processes, and a :ref:`Release` that defines the current
12+
:ref:`Build` and :ref:`config` deployed by containers.

‎docs/terms/build.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
:title: Build
2-
:description: A Deis build refers to the output of a specific application build. Deis builds can be created automatically using git push or manually using the client.
3-
:keywords: build, release, git push, deis
2+
:description: A Deis build refers to the output of a specific application build. Deis builds are created automatically using git push.
3+
:keywords: build, release, git, git push, deis
44

55
.. _build:
66

77
Build
88
=====
99
A Deis build refers to the output of a specific application build.
10-
Deis builds can be created automatically using git push,
11-
or manually using the client.
10+
Deis builds are created automatically on the controller when a
11+
developer uses ``git push deis master``.
1212

1313
When a new build is created, a new :ref:`release` is created automatically.

‎docs/terms/config.rst‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
:title: Config
2-
:description: Deis config refers to a set of environment variables used by containers in a formation's runtime layer.
2+
:description: Deis config refers to a set of environment variables used by an application
33
:keywords: config, release, envvar, envvars, environment, variables, deis
44

55
.. _config:
66

77
Config
88
======
99
Config refers to a set of environment variables used by
10-
:ref:`Containers <container>` in a :ref:`Formation's <formation>`
11-
runtime :ref:`layer`.
10+
:ref:`Containers <container>` in a :ref:`application`.
1211

1312
When Config is changed, a new :ref:`release` is created automatically.

‎docs/terms/container.rst‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
:title: Container
2-
:description: Deis containers are instances of Docker containers.
2+
:description: Deis containers are instances of Docker containers used to run applications.
33
:keywords: lxc container, lxc, container, docker, deis
44

55
.. _container:
66

77
Container
88
=========
9-
Deis containers are instances of `Docker`_ containers.
10-
Containers perform the actual work of a :ref:`Formation` by
11-
servicing requests or running background tasks as
12-
part of the runtime :ref:`Layer`.
9+
Deis containers are instances of `Docker`_ containers used to run :ref:`Applications <application>`.
10+
Containers perform the actual work of an :ref:`application` by servicing requests or running
11+
background tasks as part of the :ref:`Formation's <formation>` runtime :ref:`Layer`.
1312

1413
.. _`Docker`: http://docker.io/

‎docs/terms/controller.rst‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,22 @@
77
Controller
88
==========
99
The controller is the "brains" of the Deis platform.
10-
Each controller is tied to a single Chef organization.
10+
The controller manages container :ref:`Formations <formation>`,
11+
comprised of clusters of nodes providing proxy and runtime services for
12+
the application platform. A single controller manages multiple
13+
container formations.
14+
15+
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.
18+
1119
The controller is in charge of:
1220

13-
* Processing Client API calls
14-
* Managing Chef Nodes
15-
* Managing Docker Containers
16-
* Configuring Nginx proxies
21+
* Processing client API calls
22+
* Managing nodes that provide services to a formation
23+
* Managing containers that perform work for applications
24+
* Managing proxies that route traffic to containers
25+
* Managing users, providers, flavors, keys and other base configuration
1726

1827
The controller stack includes:
1928

‎docs/terms/flavor.rst‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:title: Flavor
2-
:description: A Deis flavor defines the configuration for nodes in a layer, including their provider type, launch parameters and initial configuration.
3-
:keywords: flavor, deis
2+
:description: A Deis flavor defines the configuration for nodes in a layer, including their provider type and launch parameters.
3+
:keywords: flavor, deis, nodes, configuration
44

55
.. _flavor:
66

@@ -11,9 +11,6 @@ A flavor defines the configuration for :ref:`Nodes <node>` in a
1111

1212
* Provider Type (e.g. EC2)
1313
* Launch Parameters (region, zone, etc)
14-
* Initial Configuration using `cloud-config`_
1514

16-
The :ref:`Controller` comes pre-seeded with default flavors for EC2
17-
that use 64-bit Deis-optimized AMIs with an m1.medium instance size.
18-
19-
.. _`cloud-config`: http://cloudinit.readthedocs.org/en/latest/topics/examples.html#install-and-run-chef-recipes
15+
The :ref:`Controller` comes pre-seeded with default flavors for supported providers.
16+
The default flavors typically use Deis-optimized images for faster provisioning.

‎docs/terms/formation.rst‎

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

55
.. _formation:
66

77
Formation
88
=========
9-
A :ref:`formation` is a set of infrastructure used to host a single application
10-
or service backed by a single git repository. Each formation includes
11-
:ref:`Layers <layer>` of :ref:`Nodes <node>` used to host services, a set of
12-
:ref:`Containers <container>` used to run isolated processes, and a
13-
:ref:`Release` that defines the current :ref:`Build` and :ref:`config`
14-
deployed by containers.
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`.

‎docs/terms/index.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ Terms
1616
formation
1717
layer
1818
node
19-
container
2019

21-
build
20+
application
21+
container
2222
config
23+
build
2324
release
2425

25-
flavor
2626
provider
27+
flavor
2728
key
2829

‎docs/terms/key.rst‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,4 @@
77
Key
88
===
99
Deis keys are SSH Keys used during the git push process. Each user
10-
can use the client to manage a list of keys on the :ref:`Controller`.
11-
12-
A user's keys are automatically added to every launched :ref:`Node`,
13-
allowing easy SSH access via:
14-
15-
.. code-block:: console
16-
17-
$ ssh ubuntu@<node-fqdn>
10+
can use the client to manage a list of keys on the :ref:`Controller`.

‎docs/terms/layer.rst‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,36 @@
11
:title: Layer
22
:description: Deis layers are homogeneous groups of nodes that perform work on behalf of a formation. Details on runtime layers, proxy layers and custom layers.
3-
:keywords: layer, layers, deis
3+
:keywords: layer, nodes, deis
44

55
.. _layer:
66

77
Layer
88
=====
9-
:ref:`Layers <layer>` are homogeneous groups of :ref:`Nodes <node>` that
9+
Layers are homogeneous groups of :ref:`Nodes <node>` that
1010
perform work on behalf of a formation. Each node in a layer has
11-
the same :ref:`Flavor` and Chef configuration, allowing them to be scaled
11+
the same :ref:`Flavor` and configuration, allowing them to be scaled
1212
easily.
1313

1414
Runtime Layers
1515
^^^^^^^^^^^^^^
1616
Runtime layers service requests and run background tasks for the formation.
17-
Nodes in a runtime layer use a Chef databag to deploy
18-
:ref:`Containers <container>` running a specific :ref:`Release`.
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`.
1919

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

26+
Dual Layers
27+
^^^^^^^^^^^
28+
A layer can be serve as both a proxy and a runtime. By default, most
29+
formations are created with an initial "runtime" layer that is dual proxy/runtime,
30+
allowing an entire formation to live on one :ref:`node`.
31+
2632
Custom Layers
2733
^^^^^^^^^^^^^
28-
It is also possible to create custom layers that contain custom run-lists.
34+
It is also possible to create custom layers that don't provide runtime or proxy
35+
services to the formation. This is useful for scaling and managing backing
36+
services built with Chef that need to be managed alongside a formation.

0 commit comments

Comments
 (0)