Update component-specification documentation

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

diff --git a/docs/sections/design-components/component-specification/component-type-docker.rst b/docs/sections/design-components/component-specification/component-type-docker.rst
index cf676c4..a685e34 100755 (executable)
--- a/docs/sections/design-components/component-specification/component-type-docker.rst
+++ b/docs/sections/design-components/component-specification/component-type-docker.rst
@@ -274,6 +274,8 @@ format of ``dcae.vnf.kpi`` version ``1.0.0``.
 |             |    | ``message_router`` |
 |             |    | ,                  |
 |             |    | ``data_router``    |
+|             |    | ,                  |
+|             |    | ``kafka``          |
 +-------------+----+--------------------+
 
 .. _message-router:
@@ -329,6 +331,27 @@ Example (not tied to the larger example):
     ...
     }
 
+.. _kafka:
+
+Kafka
+''''''''''''''
+
+Kafka subscribers are clients fetching data directly from kafka.
+
+``config_key``:
+
+.. code:: json
+
+    "streams": {
+        "subscribes": [{
+            "format": "dcae.some-format",
+            "version": "1.0.0",
+            "config_key": "some_format_handle",
+            "type": "kafka"
+        }],
+    ...
+    }
+
 Publishes
 ^^^^^^^^^
 
@@ -419,6 +442,8 @@ POST requests to streams that support the data format
 |             |    | ``message_router`` |
 |             |    | ,                  |
 |             |    | ``data_router``    |
+|             |    | ,                  |
+|             |    | ``kafka``          |
 +-------------+----+--------------------+
 
 .. message-router-1:
@@ -473,6 +498,27 @@ Example (not tied to the larger example):
         }]
     }
 
+.. kafka-1:
+
+Kafka
+''''''''''''''
+
+Kafka publishers are clients publishing data directly to kafka.
+
+``config_key``:
+
+.. code:: json
+
+    "streams": {
+        "publishes": [{
+            "format": "dcae.some-format",
+            "version": "1.0.0",
+            "config_key": "some_format_handle",
+            "type": "kafka"
+        }],
+    ...
+    }
+
 Quick Reference
 ^^^^^^^^^^^^^^^
 
@@ -1543,17 +1589,10 @@ Schema portion:
           "type": "array",
           "items": {
             "type": "object",
-            "properties": {
-              "host":{
-                "type":"object",
-                "path": {"type": "string"}
-              },
-              "container":{
-                "type":"object",
-                "bind": { "type": "string"},
-                "mode": { "type": "string"}
-              }
-            }
+            "oneOf": [
+              { "$ref": "#/definitions/host_path_volume" },
+              { "$ref": "#/definitions/config_map_volume" }
+            ]
           }
         }
       },