Update component-specification documentation

[dcaegen2.git] / docs / sections / design-components / component-specification / docker-specification.rst

diff --git a/docs/sections/design-components/component-specification/docker-specification.rst b/docs/sections/design-components/component-specification/docker-specification.rst
index e40af02..eeac1ef 100755 (executable)
--- a/docs/sections/design-components/component-specification/docker-specification.rst
+++ b/docs/sections/design-components/component-specification/docker-specification.rst
@@ -36,10 +36,10 @@ mapping, volume mapping and policy reconfiguration script details.
 |                                |         | host port. See example    |\r
 |                                |         | below.                    |\r
 +--------------------------------+---------+---------------------------+\r
-| volume                         | JSON    | each array item contains  |\r
-|                                | array   | a host and container      |\r
-|                                |         | object. See example       |\r
-|                                |         | below.                    |\r
+| volumes                        | JSON    | each array item contains  |\r
+|                                | array   | volume definition of eith\|\r
+|                                |         | er: host path or config m\|\r
+|                                |         | ap volume.                |\r
 +--------------------------------+---------+---------------------------+\r
 | policy                         | JSON    | *Required*. Policy        |\r
 |                                | array   | reconfiguration script    |\r
@@ -171,6 +171,15 @@ Volume Mapping
                 "host": {\r
                     "path": "/var/run/docker.sock"\r
                 }\r
+            },\r
+            {\r
+               "container": {\r
+                   "bind": "/tmp/mount_path"\r
+                   "mode": "ro"\r
+                },\r
+                "config_volume": {\r
+                    "name": "config_map_name"\r
+                }\r
             }\r
         ]\r
     }\r
@@ -180,7 +189,8 @@ At the top-level:
 +---------------+-------+-------------------------------------+\r
 | Property Name | Type  | Description                         |\r
 +===============+=======+=====================================+\r
-| volumes       | array | Contains container and host objects |\r
+| volumes       | array | Contains container with host/config\|\r
+|               |       | _volume objects                     |\r
 +---------------+-------+-------------------------------------+\r
 \r
 The ``container`` object contains:\r
@@ -208,7 +218,15 @@ The ``host`` object contains:
 | path          | string | path to the host volume |\r
 +---------------+--------+-------------------------+\r
 \r
-Here’s an example of the minimal JSON that must be provided as an input:\r
+The ``config_volume`` object contains:\r
+\r
++---------------+--------+-------------------------+\r
+| Property Name | Type   | Description             |\r
++===============+========+=========================+\r
+| name          | string | name of config map      |\r
++---------------+--------+-------------------------+\r
+\r
+Here is an example of the minimal JSON with host path volume that must be provided as an input:\r
 \r
 .. code:: json\r
 \r
@@ -228,6 +246,24 @@ Here’s an example of the minimal JSON that must be provided as an input:
 In the example above, the container volume “/tmp/docker.sock” maps to\r
 host volume “/var/run/docker.sock”.\r
 \r
+Here is an example of the minimal JSON with config map volume that must be provided as an input:\r
+\r
+.. code:: json\r
+\r
+    "auxilary": {\r
+        "volumes": [\r
+            {\r
+               "container": {\r
+                   "bind": "/tmp/mount_path"\r
+                },\r
+                "config_volume": {\r
+                    "name": "config_map_name"\r
+                }\r
+            }\r
+        ]\r
+    }\r
+\r
+In the example above, config map named "config_map_name" is mounted at "/tmp/mount_path".\r
 \r
 Policy \r
 ~~~~~~~\r