added container inventory
Change-Id: Iaab4aa37454083aaa13063c6f8cc3a636624c61e
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index dcd11fd..30258b7 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -3,6 +3,7 @@
* [Introduction](README.md)
* [Installing XOS](install.md)
* [Download Source Code](repo.md)
+ * [XOS Containers](xos_internals.md)
* [Using XOS](use.md)
* [XOS Modeling Framework](dev/xproto.md)
* [XOS Tool Chain (Internals)](dev/xosgenx.md)
diff --git a/docs/xos_internals.md b/docs/xos_internals.md
index 5f80812..8293ace 100644
--- a/docs/xos_internals.md
+++ b/docs/xos_internals.md
@@ -1,23 +1,27 @@
# XOS Containers
-XOS is made up of a set of Docker containers that cooperate to provide platform
-controller functionaly, including the data model, synchronizers, and northbound
+When deployed, XOS runs as a set of Docker containers that cooperate to provide platform
+controller functionality, including the data model, synchronizers, and northbound
APIs. The following is an inventory of those containers:
| Name | Description | Internal Ports |
| ---- | ----------- | ----- |
-| xos-core | The core of the platform, contains the model definition and the xProto toolchain | 50051, 500515 |
-| xos-db | The Postgres instance that persists the data-model | 5432 |
-| xos-redis | A Redis instance, used as pub/sub channel for internal notifications | 5432 |
-| xos-tosca | Northbound TOSCA interface, accessible via REST | 9102|
-| xos-gui | Northbound GUI interface| 4000|
-| xos-ws | Listens to `redis` events and propagates them over web-sockets for notifications| 3000|
-| xos-chameleon | Northbound REST interface, accessible at `/xosapi/v1/..` (`swagger` is published at `/apidocs/`| 3000|
-| kafka | Event bus shared between all the CORD components that needs it | 9092|
-
-> The dotted lines identify optional components that are required only in certain configurations
+| xos-core | The core of the platform; responsible for maintaining the data model | 50051, 500515 |
+| xos-db | A Postgres instance; used to persist the data model | 5432 |
+| xos-redis | A Redis instance; used as pub/sub channel for internal notifications | 5432 |
+| xos-tosca | Northbound TOSCA interface; accessible via REST | 9102|
+| xos-gui | Northbound GUI dashboard| 4000|
+| xos-ws | Listens to `redis` events and propagates them over web-sockets | 3000|
+| xos-chameleon | Northbound REST interface; accessible at `/xosapi/v1/..` (`swagger` is published at `/apidocs/`| 3000|
+| kafka | A Kafka bus; used by some backend components to send event notifications | 9092|
All the communication between containers happen over `gRPC` except for
-`xos-gui` where it is a combination of REST and web-socket.
+`xos-gui`, which uses a combination of REST and web-socket.
+
+> **Note:** The dotted lines identify optional components that are
+> required only in certain configurations.
![xos-containers](./static/xos_components.jpg)
+
+
+