Doc updates for London
[dcaegen2.git] / docs / sections / services / dfc / configuration.rst
index 1f2b6a4..69375c7 100644 (file)
@@ -22,226 +22,71 @@ By default, DFC handles the "PM_MEAS_FILES" change identifier and publishes thes
 But it can also be configured to handle more/other change identifiers and publish them to more/other feeds. The\r
 configuration of DFC is controlled via a blueprint.\r
 \r
-Blueprint Configuration Explained\r
-"""""""""""""""""""""""""""""""""\r
-\r
-For the communication with the Message Router, the user must provide the **host name**, **port**, and **protocol** of\r
-the DMaaP Message router.\r
-\r
-.. code-block:: yaml\r
-  :emphasize-lines: 2,6,10\r
-\r
-    inputs:\r
-      dmaap_mr_host:\r
-        type: string\r
-        description: dmaap messagerouter host\r
-        default: message-router.onap.svc.cluster.local\r
-      dmaap_mr_port:\r
-        type: integer\r
-        description: dmaap messagerouter port\r
-        default: 3904\r
-      dmaap_mr_protocol:\r
-        type: string\r
-        description: dmaap messagerouter protocol\r
-        default: "http"\r
 \r
 The user can also specify which version of DFC to use.\r
 \r
 .. code-block:: yaml\r
-  :emphasize-lines: 2\r
 \r
-    inputs:\r
-      tag_version:\r
-        type: string\r
-        description: DFC image tag/version\r
-        default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.0"\r
+    image: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.9.0\r
 \r
 The user can also enable secure communication with the DMaaP Message Router.\r
 \r
 .. code-block:: yaml\r
-  :emphasize-lines: 2\r
-\r
-    inputs:\r
-      secureEnableCert:\r
-        type: boolean\r
-        description: enable certificate based connection with DMaap\r
-        default: false\r
-\r
-DFC can handle multiple change identifiers. For each change identifier/feed combination the user must provide the\r
-**change identifier**, **feed name**, and **feed location**.\r
-\r
-**Note!** The **feed name** provided should be used by the consumer/s to set up the subscription to the feed.\r
-\r
-The **feed name** and **feed location** are defined as inputs for the user to provide.\r
-\r
-.. code-block:: yaml\r
-  :emphasize-lines: 2,6\r
-\r
-    inputs:\r
-      feed0_name:\r
-        type: string\r
-        description: The name of the feed the files will be published to. Should be used by the subscriber.\r
-        default: "bulk_pm_feed"\r
-      feed0_location:\r
-        type: string\r
-        description: The location of the feed.\r
-        default: "loc00"\r
 \r
-The **feed name** shall be used in the definition of the feed for the DMaaP plugin under the "**node_templates**"\r
-section under a tag for the  internal "**feed identifier**" for the feed (feed0 in the example).\r
+    dmaap.security.enableDmaapCertAuth: true\r
 \r
-.. code-block:: yaml\r
-  :emphasize-lines: 1,5\r
+DFC can handle multiple stream identifiers. For each stream identifier/feed combination the user must provide the\r
+** stream identifier**, **feed name**, and **feed location**.\r
 \r
-    feed0:\r
-      type: ccsdk.nodes.Feed\r
-      properties:\r
-        feed_name:\r
-          get_input: feed0_name\r
-        useExisting: true\r
+**Note!** The **feed name** provided should be used by the consumer/s to set up the subscription to the feed. \r
 \r
-The **feed location** shall be used under the **streams_publishes** section under a tag for the internal\r
-"**feed identifier**" for the feed.\r
+The **stream identifier** shall be defined as an item under the **streams_publishes** tag in the "**applicationConfig**"\r
+section. \r
 \r
 .. code-block:: yaml\r
-  :emphasize-lines: 2,4\r
-\r
-      streams_publishes:\r
-      - name: feed0\r
-        location:\r
-          get_input: feed0_location\r
-        type: data_router\r
 \r
-The **change identifier** shall be defined as an item under the **streams_publishes** tag in the "**application_config**"\r
-section. Under this tag the internal "**feed identifier**" for the feed shall also be added to get the\r
+  :emphasize-lines: 2,6\r
+      applicationConfig:\r
+                 streams_publishes:\r
+                   PM_MEAS_FILES:\r
+                     dmaap_info:\r
+                       publisher_id: ${DR_FILES_PUBLISHER_ID_0}\r
+                       location: loc00\r
+                       log_url: ${DR_LOG_URL_0}\r
+                       publish_url: ${DR_FILES_PUBLISHER_URL_0}\r
+                       username: ${DR_USERNAME}\r
+                       password: ${DR_PASSWORD}\r
+                     type: data_router\r
+                 streams_subscribes:\r
+                   dmaap_subscriber:\r
+                     dmaap_info:\r
+                       topic_url: "http://message-router:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT"\r
+                     type: message_router\r
+\r
+\r
+\r
+Under this tag the internal "**feed identifier**" for the feed shall also be added to get the\r
 info about the feed substituted in by CBS (that's what the <<>> tags are for).\r
 \r
-.. code-block:: yaml\r
-  :emphasize-lines: 4,5\r
-\r
-      application_config:\r
-        service_calls: []\r
-        streams_publishes:\r
-          PM_MEAS_FILES:\r
-            dmaap_info: <<feed0>>\r
-            type: data_router\r
-\r
-And, lastly, to set up the publication relationship for the feed, the "**feed identifier**" must be added to the\r
-"**relationships**" section of the blueprint.\r
-\r
-.. code-block:: yaml\r
-  :emphasize-lines: 3\r
-\r
-   relationships:\r
-    - type: ccsdk.relationships.publish_files\r
-      target: feed0\r
-\r
-Sample blueprint configuration\r
-""""""""""""""""""""""""""""""\r
-\r
-The format of the blueprint configuration that drives all behavior of DFC is probably best described using an example.\r
-The blueprint below configures DFC to handle the two feeds shown in the picture above.\r
+The **feed name** and **feed location** are defined as inputs for the user to provide in helm chart values.yaml. An example snapshot on default configuration is provided below. \r
 \r
 .. code-block:: yaml\r
\r
+       # DataRouter Feed Configuration\r
+       drFeedConfig:\r
+         - feedName: bulk_pm_feed\r
+           owner: dcaecm\r
+           feedVersion: "0.0"\r
+           asprClassification: unclassified\r
+           feedDescription: DFC Feed Creation\r
+       \r
+       # DataRouter Publisher Configuration\r
+       drPubConfig:\r
+         - feedName: bulk_pm_feed\r
+           username: ${DR_USERNAME}\r
+           userpwd: ${DR_PASSWORD}\r
+           dcaeLocationName: loc00\r
 \r
-    inputs:\r
-      dmaap_mr_host:\r
-        type: string\r
-        description: dmaap messagerouter host\r
-        default: message-router.onap.svc.cluster.local\r
-      dmaap_mr_port:\r
-        type: integer\r
-        description: dmaap messagerouter port\r
-        default: 3904\r
-      dmaap_mr_protocol:\r
-        type: string\r
-        description: dmaap messagerouter protocol\r
-        default: "http"\r
-      tag_version:\r
-        type: string\r
-        description: DFC image tag/version\r
-        default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.0"\r
-      replicas:\r
-        type: integer\r
-        description: number of instances\r
-        default: 1\r
-      secureEnableCert:\r
-        type: boolean\r
-        description: enable certificate based connection with DMaap\r
-        default: false\r
-      envs:\r
-        default: {}\r
-      feed0_name:\r
-        type: string\r
-        description: The name of the feed the files will be published to. Should be used by the subscriber.\r
-        default: "bulk_pm_feed"\r
-      feed0_location:\r
-        type: string\r
-        description: The location of the feed.\r
-        default: "loc00"\r
-      feed1_name:\r
-        type: string\r
-        description: The name of the feed the files will be published to. Should be used by the subscriber.\r
-        default: "log_feed"\r
-      feed1_location:\r
-        type: string\r
-        description: The location of the feed.\r
-        default: "loc00"\r
-    node_templates:\r
-      datafile-collector:\r
-        type: dcae.nodes.ContainerizedServiceComponentUsingDmaap\r
-        interfaces:\r
-          cloudify.interfaces.lifecycle:\r
-            start:\r
-              inputs:\r
-            envs:\r
-              get_input: envs\r
-        properties:\r
-          application_config:\r
-            service_calls: []\r
-            dmaap.security.enableDmaapCertAuth: { get_input: secureEnableCert }\r
-            streams_subscribes:\r
-              dmaap_subscriber:\r
-                dmaap_info:\r
-                  topic_url:\r
-                    { concat: [{ get_input: dmaap_mr_protocol },"://",{ get_input: dmaap_mr_host },\r
-                               ":",{ get_input: dmaap_mr_port },"/events/unauthenticated.VES_NOTIFICATION_OUTPUT/OpenDcae-c12/C12"]}\r
-            streams_publishes:\r
-              PM_MEAS_FILES:\r
-                dmaap_info: <<feed0>>\r
-                type: data_router\r
-              LOG_FILES:\r
-                dmaap_info: <<feed1>>\r
-                type: data_router\r
-          image:\r
-            get_input: tag_version\r
-          service_component_type: datafile-collector\r
-          streams_publishes:\r
-          - name: feed0\r
-            location:\r
-              get_input: feed0_location\r
-            type: data_router\r
-          - name: feed1\r
-            location:\r
-              get_input: feed1_location\r
-            type: data_router\r
-        relationships:\r
-          - type: ccsdk.relationships.publish_files\r
-            target: feed0\r
-          - type: ccsdk.relationships.publish_files\r
-            target: feed1\r
-      feed0:\r
-        type: ccsdk.nodes.Feed\r
-        properties:\r
-          feed_name:\r
-            get_input: feed0_name\r
-          useExisting: true\r
-      feed1:\r
-        type: ccsdk.nodes.Feed\r
-        properties:\r
-          feed_name:\r
-            get_input: feed1_name\r
-          useExisting: true\r
 \r
 .. _strict_host_checking_config:\r
 \r