1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
\r
2 .. http://creativecommons.org/licenses/by/4.0
\r
4 =============================
\r
5 Configuration and Performance
\r
6 =============================
\r
7 The DataFile Collector (DFC) gets fileReady messages from the Message Router (MR) sent from xNFs, via the VES Collector.
\r
8 These messages contains data about files ready to get from the xNF. DFC then collects these files from the xNF and
\r
9 publishes them to the DataRouter (DR) on a feed. Consumers can subscribe to the feed from DR and process the file for
\r
10 its specific purpose. The connection between a file type and the feed it will be published to is the
\r
11 **changeIdentifier**. DFC can handle multiple **changeIdentifier**/feed combinations, see picture below.
\r
13 .. image:: ../../images/DFC_config.png
\r
19 By default, DFC handles the "PM_MEAS_FILES" change identifier and publishes these files on the "bulk_pm_feed" feed.
\r
20 But it can also be configured to handle more/other change identifiers and publish them to more/other feeds. The
\r
21 configuration of DFC is controlled via a blueprint.
\r
23 Blueprint Configuration Explained
\r
24 """""""""""""""""""""""""""""""""
\r
26 For the communication with the Message Router, the user must provide the **host name**, **port**, and **protocol** of
\r
27 the DMaaP Message router.
\r
29 .. code-block:: yaml
\r
30 :emphasize-lines: 2,6,10
\r
35 description: dmaap messagerouter host
\r
36 default: message-router.onap.svc.cluster.local
\r
39 description: dmaap messagerouter port
\r
43 description: dmaap messagerouter protocol
\r
46 The user can also specify which version of DFC to use.
\r
48 .. code-block:: yaml
\r
54 description: DFC image tag/version
\r
55 default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.0"
\r
57 The user can also enable secure communication with the DMaaP Message Router.
\r
59 .. code-block:: yaml
\r
65 description: enable certificate based connection with DMaap
\r
68 DFC can handle multiple change identifiers. For each change identifier/feed combination the user must provide the
\r
69 **change identifier**, **feed name**, and **feed location**.
\r
71 **Note!** The **feed name** provided should be used by the consumer/s to set up the subscription to the feed.
\r
73 The **feed name** and **feed location** are defined as inputs for the user to provide.
\r
75 .. code-block:: yaml
\r
76 :emphasize-lines: 2,6
\r
81 description: The name of the feed the files will be published to. Should be used by the subscriber.
\r
82 default: "bulk_pm_feed"
\r
85 description: The location of the feed.
\r
88 The **feed name** shall be used in the definition of the feed for the DMaaP plugin under the "**node_templates**"
\r
89 section under a tag for the internal "**feed identifier**" for the feed (feed0 in the example).
\r
91 .. code-block:: yaml
\r
92 :emphasize-lines: 1,5
\r
95 type: ccsdk.nodes.Feed
\r
98 get_input: feed0_name
\r
101 The **feed location** shall be used under the **streams_publishes** section under a tag for the internal
\r
102 "**feed identifier**" for the feed.
\r
104 .. code-block:: yaml
\r
105 :emphasize-lines: 2,4
\r
110 get_input: feed0_location
\r
113 The **change identifier** shall be defined as an item under the **streams_publishes** tag in the "**application_config**"
\r
114 section. Under this tag the internal "**feed identifier**" for the feed shall also be added to get the
\r
115 info about the feed substituted in by CBS (that's what the <<>> tags are for).
\r
117 .. code-block:: yaml
\r
118 :emphasize-lines: 4,5
\r
120 application_config:
\r
124 dmaap_info: <<feed0>>
\r
127 And, lastly, to set up the publication relationship for the feed, the "**feed identifier**" must be added to the
\r
128 "**relationships**" section of the blueprint.
\r
130 .. code-block:: yaml
\r
131 :emphasize-lines: 3
\r
134 - type: ccsdk.relationships.publish_files
\r
137 Sample blueprint configuration
\r
138 """"""""""""""""""""""""""""""
\r
140 The format of the blueprint configuration that drives all behavior of DFC is probably best described using an example.
\r
141 The blueprint below configures DFC to handle the two feeds shown in the picture above.
\r
143 .. code-block:: yaml
\r
148 description: dmaap messagerouter host
\r
149 default: message-router.onap.svc.cluster.local
\r
152 description: dmaap messagerouter port
\r
156 description: dmaap messagerouter protocol
\r
160 description: DFC image tag/version
\r
161 default: "nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.0"
\r
164 description: number of instances
\r
168 description: enable certificate based connection with DMaap
\r
174 description: The name of the feed the files will be published to. Should be used by the subscriber.
\r
175 default: "bulk_pm_feed"
\r
178 description: The location of the feed.
\r
182 description: The name of the feed the files will be published to. Should be used by the subscriber.
\r
183 default: "log_feed"
\r
186 description: The location of the feed.
\r
189 datafile-collector:
\r
190 type: dcae.nodes.ContainerizedServiceComponentUsingDmaap
\r
192 cloudify.interfaces.lifecycle:
\r
198 application_config:
\r
200 dmaap.security.enableDmaapCertAuth: { get_input: secureEnableCert }
\r
201 streams_subscribes:
\r
205 { concat: [{ get_input: dmaap_mr_protocol },"://",{ get_input: dmaap_mr_host },
\r
206 ":",{ get_input: dmaap_mr_port },"/events/unauthenticated.VES_NOTIFICATION_OUTPUT/OpenDcae-c12/C12"]}
\r
209 dmaap_info: <<feed0>>
\r
212 dmaap_info: <<feed1>>
\r
215 get_input: tag_version
\r
216 service_component_type: datafile-collector
\r
220 get_input: feed0_location
\r
224 get_input: feed1_location
\r
227 - type: ccsdk.relationships.publish_files
\r
229 - type: ccsdk.relationships.publish_files
\r
232 type: ccsdk.nodes.Feed
\r
235 get_input: feed0_name
\r
238 type: ccsdk.nodes.Feed
\r
241 get_input: feed1_name
\r
247 To see the performance of DFC, see "`Datafile Collector (DFC) performance baseline results`_".
\r
249 .. _Datafile Collector (DFC) performance baseline results: https://wiki.onap.org/display/DW/Datafile+Collector+%28DFC%29+performance+baseline+results
\r