document private registry support, fix whitespace

also add spaces between Docker and image [#86841562]
alfred-huangjian · Feb 5, 2015 · d00f0fc · d00f0fc
1 parent 33fd75e
commit d00f0fc
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 45 deletions.
diff --git a/doc/environment.md b/doc/environment.md
@@ -2,7 +2,7 @@
 
 Diego sets up a hierarchy of environment variables available to processes running in containers.  This hierarchy includes the following layers in order:
 
-- Environment variables baked into the Dockerimage (for Dockerimage based rootfses only)
+- Environment variables baked into the Docker image (for Docker image based containers only)
 - Container-level environment variables (defined on the [`Task`](tasks.md#env) and [`LRP`](lrps.md#env) objects)
 - Configuration environment variables (LRPs only, described below)
 - Process-level environment variables (defined on the [`RunAction`](actions.md#runaction) object)

diff --git a/doc/lrps.md b/doc/lrps.md
@@ -102,17 +102,21 @@ Diego can run and manage multiple instances (`ActualLRP`s) for each `DesiredLRP`
 
 By default, when provisioning a container Diego will mount a pre-configured root filesystem.  Currently, the default filesystem provided by [diego-release](https://github.com/cloudfoundry-incubator/diego-release) is based on lucid64 and is geared towards supporting the Cloud Foundry buildpacks.
 
-It is possible, however, to provide a custom root filesystem by specifying a Dockerimage for `root_fs`:
+It is possible, however, to provide a custom root filesystem by specifying a Docker image for `root_fs`:
 
 ```
 "root_fs": "docker:///docker-org/docker-image#docker-tag"
 ```
 
-Currently, only the public docker hub is supported.
+To pull the image from a different registry than the default (Docker Hub), specify it as the host in the URI string, e.g.:
 
-> You *must* specify the dockerimage `root_fs` uri as specified, including the leading `docker:///`!
+```
+"root_fs": "docker://index.myregistry.gov/docker-org/docker-image#docker-tag"
+```
+
+> You *must* specify the dockerimage `root_fs` uri as specified, including the leading `docker://`!
 
-> [Lattice](https://github.com/pivotal-cf-experimental/lattice) does not ship with a default rootfs. You must specify a docker-image when using Lattice. You can mount the filesystem provided by diego-release by specifying `"root_fs": "docker:///cloudfoundry/lucid64"` or `"root_fs": "docker:///cloudfoundry/trusty64"`.
+> [Lattice](https://github.com/pivotal-cf-experimental/lattice) does not ship with a default rootfs. You must specify a Docker image when using Lattice. You can mount the filesystem provided by diego-release by specifying `"root_fs": "docker:///cloudfoundry/lucid64"` or `"root_fs": "docker:///cloudfoundry/trusty64"`.
 
 #### `env` [optional]
 
@@ -228,42 +232,42 @@ Enable logging of the rule
 `ALL`
 ```
 {
-"protocol": "all",
-"destinations": ["1.2.3.4"],
-"log": true
+    "protocol": "all",
+    "destinations": ["1.2.3.4"],
+    "log": true
 }
 ```
 ***
 `TCP`
 ```
 {
-"protocol": "tcp",
-"destinations": ["1.2.3.4-2.3.4.5"],
-"ports": [80, 443],
-"log": true
+    "protocol": "tcp",
+    "destinations": ["1.2.3.4-2.3.4.5"],
+    "ports": [80, 443],
+    "log": true
 }
 ```
 ***
 `UDP`
 ```
 {
-"protocol": "udp",
-"destinations": ["1.2.3.4/4"],
-"port_range": {
-    "start": 8000,
-    "end": 8085
+    "protocol": "udp",
+    "destinations": ["1.2.3.4/4"],
+    "port_range": {
+        "start": 8000,
+        "end": 8085
     }
 }
 ```
 ***
 `ICMP`
 ```
 {
-"protocol": "icmp",
-"destinations": ["1.2.3.4", "2.3.4.5/6"],
-"icmp_info": {
-    "type": 1,
-    "code": 40
+    "protocol": "icmp",
+    "destinations": ["1.2.3.4", "2.3.4.5/6"],
+    "icmp_info": {
+        "type": 1,
+        "code": 40
     }
 }
 ```

diff --git a/doc/overview.md b/doc/overview.md
@@ -9,12 +9,12 @@ A Diego cluster is comprised of a series of VMs called Cells that can run two di
 - [**Tasks**](tasks.md) are one-off processes that Diego guarantees will run at most once.
 - [**Long-Running Processes**](lrps.md) (LRPs) are processes that Diego launches and monitors.  Diego can distribute, run, and monitor `N` instances of a given LRP.  When an LRP instance crashes, Diego restarts it automatically.
 
-Tasks and LRPs ultimately run in [Garden](http://github.com/cloudfoundry-incubator/garden) containers on Diego Cells.  The filesystem mounted into these containers can either be a generic rootfs that ships with Diego or an arbitrary Dockerimage.  Processes spawned in these containers are provided with a set of [environment variables](environment.md) to aid in configuration.
+Tasks and LRPs ultimately run in [Garden](http://github.com/cloudfoundry-incubator/garden) containers on Diego Cells.  The filesystem mounted into these containers can either be a generic rootfs that ships with Diego or an arbitrary Docker image.  Processes spawned in these containers are provided with a set of [environment variables](environment.md) to aid in configuration.
 
 In addition to launching and monitoring Tasks and LRPs, Diego can stream logs (via [doppler](http://github.com/cloudfoundry/loggregator)) out of the container processes to end users, and Diego can route (via the [router](http://github.com/cloudfoundry/gorouter)) incoming web traffic to container processes.
 
-Consumers of Diego communicate to Diego via an http API.  This API allows you to schedule Tasks and LRPs and to fetch information about running Tasks and LRPs.  While it is possible to run multi-tenant workload on Diego, the API does not provide strong abstractions and protections around managing such work (e.g. users, organizations, quotas, etc...).  Diego simply runs Tasks and LRPs and it is up to the consumer to provide these additional abstractions.  In the case of Cloud Foundry these responsiblities fall on the [Cloud Controller](http://github.com/cloudfoundry/cloud_controller_ng)
+Consumers of Diego communicate to Diego via an http API.  This API allows you to schedule Tasks and LRPs and to fetch information about running Tasks and LRPs.  While it is possible to run multi-tenant workload on Diego, the API does not provide strong abstractions and protections around managing such work (e.g. users, organizations, quotas, etc...).  Diego simply runs Tasks and LRPs and it is up to the consumer to provide these additional abstractions.  In the case of Cloud Foundry these responsibilities fall on the [Cloud Controller](http://github.com/cloudfoundry/cloud_controller_ng)
 
 The API is served by a component living on each Diego Cell called the [Receptor](http://github.com/cloudfoundry-incubator/receptor).  The [GitHub repository](http://github.com/cloudfoundry-incubator/receptor) includes a Golang client that consumers can use to interact with the Receptor.
 
-[back](README.md)
+[back](README.md)
diff --git a/doc/tasks.md b/doc/tasks.md
@@ -81,15 +81,19 @@ Diego can support different target platforms (linux, windows, etc.). `stack` all
 
 By default, when provisioning a container, Diego will mount a pre-configured root filesystem.  Currently, the default filesystem provided by [diego-release](https://github.com/cloudfoundry-incubator/diego-release) is based on lucid64 and is geared towards supporting the Cloud Foundry buildpacks.
 
-It is possible, however, to provide a custom root filesystem by specifying a Dockerimage for `root_fs`:
+It is possible, however, to provide a custom root filesystem by specifying a Docker image for `root_fs`:
 
 ```
 "root_fs": "docker:///docker-org/docker-image#docker-tag"
 ```
 
-Currently, only the public docker hub is supported.
+To pull the image from a different registry than the default (Docker Hub), specify it as the host in the URI string, e.g.:
 
-> You *must* specify the dockerimage `root_fs` uri as specified, including the leading `docker:///`!
+```
+"root_fs": "docker://index.myregistry.gov/docker-org/docker-image#docker-tag"
+```
+
+> You *must* specify the dockerimage `root_fs` uri as specified, including the leading `docker://`!
 
 > [Lattice](https://github.com/pivotal-cf-experimental/lattice) does not ship with a default rootfs. You must specify a docker-image when using Lattice. You can mount the filesystem provided by diego-release by specifying `"root_fs": "docker:///cloudfoundry/lucid64"` or `"root_fs": "docker:///cloudfoundry/trusty64"`.
 
@@ -202,42 +206,42 @@ Enable logging of the rule
 `ALL`
 ```
 {
-"protocol": "all",
-"destinations": ["1.2.3.4"],
-"log": true
+    "protocol": "all",
+    "destinations": ["1.2.3.4"],
+    "log": true
 }
 ```
 ***
 `TCP`
 ```
 {
-"protocol": "tcp",
-"destinations": ["1.2.3.4-2.3.4.5"],
-"ports": [80, 443],
-"log": true
+    "protocol": "tcp",
+    "destinations": ["1.2.3.4-2.3.4.5"],
+    "ports": [80, 443],
+    "log": true
 }
 ```
 ***
 `UDP`
 ```
 {
-"protocol": "udp",
-"destinations": ["1.2.3.4/4"],
-"port_range": {
-    "start": 8000,
-    "end": 8085
+    "protocol": "udp",
+    "destinations": ["1.2.3.4/4"],
+    "port_range": {
+        "start": 8000,
+        "end": 8085
     }
 }
 ```
 ***
 `ICMP`
 ```
 {
-"protocol": "icmp",
-"destinations": ["1.2.3.4", "2.3.4.5/6"],
-"icmp_info": {
-    "type": 1,
-    "code": 40
+    "protocol": "icmp",
+    "destinations": ["1.2.3.4", "2.3.4.5/6"],
+    "icmp_info": {
+        "type": 1,
+        "code": 40
     }
 }
 ```