1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
11 - `Types of Users and Usage
12 Instructions: <#DCAEMODUserGuide(draft)-TypesofUsersand>`__
14 - `1. Deployment of DCAE MOD components via Helm
15 charts <#DCAEMODUserGuide(draft)-1.DeploymentofD>`__
17 - `Using DCAE MOD without an Ingress
18 Controller <#DCAEMODUserGuide(draft)-UsingDCAEMODwit>`__
20 - `2. Configuring DCAE
21 mod <#DCAEMODUserGuide(draft)-2.ConfiguringDC>`__
23 - `3. Design & Distribution
24 Flow <#DCAEMODUserGuide(draft)-3.Design&Distri>`__
27 Types of Users and Usage Instructions:
28 ======================================
30 +-------+-----------------------------+-----------------------------+
31 | Sr.No | User | Usage Instructions |
32 +=======+=============================+=============================+
33 | 1. | Developers who are looking | - Access the Nifi |
34 | | to onboard their mS | Web UI url provided to you |
36 | | | - Follow steps 2.c |
39 | | | - You should be able |
40 | | | to see your microservices |
41 | | | in the Nifi Web UI by |
42 | | | clicking and dragging |
43 | | | ‘Processor’ on the canvas, |
44 | | | and searching for the name |
47 | | | ervice/component/processor. |
48 +-------+-----------------------------+-----------------------------+
49 | 2. | Designers who are building | - Access the Nifi |
50 | | the flows through UI and | Web UI url provided to you |
51 | | triggering distribution | |
52 | | | - Follow steps 3 to |
53 | | | the end of the document |
54 +-------+-----------------------------+-----------------------------+
55 | 3. | Infrastructure/ Admins who | - Follow start to |
56 | | want to stand up DCAE Mod | the end |
57 | | and validate it | |
58 +-------+-----------------------------+-----------------------------+
61 1. Deployment of DCAE MOD components via Helm charts
62 =======================================================
64 The DCAE MOD components are deployed using the standard ONAP OOM
65 deployment process. When deploying ONAP using the helm deploy command,
66 DCAE MOD components are deployed when the dcaemod.enabled flag is set to
67 true, either via a --set option on the command line or by an entry in an
68 overrides file. In this respect, DCAE MOD is no different from any
71 The default DCAE MOD deployment relies on an nginx ingress controller
72 being available in the Kubernetes cluster where DCAE MOD is being
73 deployed. The Rancher RKE installation process sets up a suitable
74 ingress controller. In order to enable the use of the ingress
75 controller, it is necessary to override the OOM default global settings
76 for ingress configuration. Specifically, the installation needs to set
77 the following configuration in an override file::
82 baseurl: "simpledemo.onap.org"
84 When DCAE MOD is deployed with an ingress controller, several endpoints
85 are exposed outside the cluster at the ingress controller's external IP
86 address and port. (In the case of a Rancher RKE installation, there is
87 an ingress controller on every worker node, listening at the the
88 standard HTTP port (80).) These exposed endpoints are needed by users
89 using machines outside the Kubernetes cluster.
91 +--------------+--------------------------------------------------+--------------------------+
92 | **Endpoint** | ** Routes to (cluster | **Description** |
93 | | internal address)** | |
94 +==============+==================================================+==========================+
95 | /nifi | http://dcaemod-designtool:8080/nifi | Design tool Web UI |
97 +--------------+--------------------------------------------------+--------------------------+
98 | /nifi-api | http://dcaemod-designtool:8080/nifi-api | Design tool API |
100 +--------------+--------------------------------------------------+--------------------------+
101 | /nifi-jars | http://dcaemod-nifi-registry:18080/nifi-jars | Flow registry listing of |
102 | | | JAR files built from |
103 | | | component specs |
104 +--------------+--------------------------------------------------+--------------------------+
105 | /onboarding | http://dcaemod-onboarding-api:8080/onboarding | Onboarding API |
107 +--------------+--------------------------------------------------+--------------------------+
108 | /distributor | http://dcaemod-distributor-api:8080/distributor | Distributor API |
110 +--------------+--------------------------------------------------+--------------------------+
112 | To access the design Web UI, for example, a user would use the URL :
113 http://*ingress_controller_address:ingress_controller_port*/nifi.
114 | *ingress_controller_address* is the the IP address or DNS FQDN of the
115 ingress controller and
116 | *ingress_controller_port* is the port on which the ingress controller
117 is listening for HTTP requests. (If the port is 80, the HTTP default,
118 then there is no need to specify a port.)
120 There are two additional *internal* endpoints that users need to know,
121 in order to configure a registry client and a distribution target in the
122 design tool's controller settings.
124 +------------------------+--------------------------------------------+
125 | **Configuration Item** | **Endpoint URL** |
126 +========================+============================================+
127 | Registry client | http://dcaemod-nifi-registry:18080 |
128 +------------------------+--------------------------------------------+
129 | Distribution target | http://dcaemod-runtime-api:9090 |
130 +------------------------+--------------------------------------------+
132 With Guilin release, OOM/ingress template has been updated to enable virtual host by default.
133 All MOD API's and UI access via ingress should use dcaemod.api.simpledemo.onap.org.
135 In order to access Design UI from local, add an entry for dcaemod.api.simpledemo.onap.org in /etc/hosts with the correct IP (any K8S node IP can be specified).
138 Using DCAE MOD without an Ingress Controller
141 Not currently supported
144 2. Configuring DCAE mod
145 ==========================
147 **a. Configure Nifi Registry url**
149 Next check Nifi settings by selecting the Hamburger button in the Nifi
150 UI. It should lead you to the Nifi Settings screen
156 Add a registry client. The Registry client url will be
157 http://dcaemod-nifi-registry:18080
162 **b. Add distribution target which will be the runtime api url**
164 Set the distribution target in the controller settings
168 Distribution target URL will be
169 `http://dcaemod-runtime-api:9090 <http://dcaemod-runtime-api:9090/>`__
173 Now let’s access the Nifi (DCAE designer) UI - http://dcaemod.api.simpledemo.onap.org/nifi
175 IPAddress is the host address or the DNS FQDN, if there is one, for one of the Kubernetes nodes.
180 **c. Get the artifacts to test and onboard.**
182 Let's fetch the artifacts/ spec files
184 **Sample Component DCAE-VES-Collector :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/spec/vescollector-componentspec.json
186 **Sample Data Format :** https://git.onap.org/dcaegen2/collectors/ves/tree/dpo/data-formats/VES-5.28.4-dataformat.json
188 For the purpose of onboarding, a Sample Request body should be of the type -::
190 { "owner": "<some value>", "spec": <some json object> }
192 where the json object inside the spec field can be a component spec json.
194 Request bodies of this type will be used in the onboarding requests you make using curl or the onboarding swagger interface.
196 **The prepared Sample Request body for a component dcae-ves-collector looks like
199 See :download:`VES Collector Spec <./Sample-Input-Files/Request-body-of-Sample-Component.json>`
201 **The prepared Sample request body for a sample data format looks like so -**
203 See :download:`VES data Format <./Sample-Input-Files/Request-body-of-Sample-Data-Format.json>`
207 **d. To onboard a data format and a component**
209 Each component has a description that tells what it does.
211 These requests would be of the type
213 curl -X POST http://<onboardingapi host>/onboarding/dataformats -H "Content-Type: application/json" -d
214 @<filepath to request>
216 curl -X POST http://<onboardingapi host>/onboarding/components -H "Content-Type: application/json" -d
217 @<filepath to request>
221 curl -X POST http://dcaemod.api.simpledemo.onap.org/onboarding/dataformats -H "Content-Type: application/json" -d @<filepath to request>
223 curl -X POST http://dcaemod.api.simpledemo.onap.org/onboarding/components -H "Content-Type: application/json" -d @<filepath to request>
228 **e. Verify the resources were created using**
230 curl -X GET http://<IPAddress>/onboarding/dataformats
232 curl -X GET http://<IPAddress>/onboarding/components
234 **f. Verify the genprocessor (which polls onboarding periodically to convert component specs to nifi processor), converted the component**
236 Open http://dcaemod.api.simpledemo.onap.org/nifi-jars in a browser.
238 These jars should now be available for you to use in the nifi UI as
243 3. Design & Distribution Flow
244 ================================
247 **a**. To start creating flows, we need to create a process group first. The
248 name of the process group will be the name of the flow. Drag and Drop on
249 the canvas, the ‘Processor Group’ icon from the DCAE Designer bar on the
255 Now enter the process group by double clicking it,
257 You can now drag and drop on the canvas ‘Processor’ icon from the top
258 DCAE Designer tab. You can search for a particular component in the
259 search box that appears when you attempt to drag the ‘Processor’ icon to
264 If the Nifi registry linking worked, you should see the “Import” button
265 when you try to add a Processor or Process group to the Nifi canvas,
270 By clicking on the import button, we can import already created saved
271 and version controlled flows from the Nifi registry, if they are
276 We can save created flows by version controlling them like so starting
277 with a 'right click' anywhere on the canvas-
281 Ideally you would name the flow and process group the same, because
282 functionally they are similar.
286 When the flow is checked in, the bar at the bottom shows a green
291 Note: Even if you move a component around on the canvas, and its
292 position on the canvas changes, it is recognized as a change, and it
293 will have to recommitted.
295 You can add additional components in your flow and connect them.
297 DcaeVesCollector connects to DockerTcagen2.
305 Along the way you need to also provide topic names in the settings
306 section. These can be arbitrary names.
310 To recap, see how DcaeVesCollector connects to DockerTcagen2. Look at
311 the connection relationships. Currently there is no way to validate
312 these relationships. Notice how it is required to name the topics by
315 The complete flow after joining our components looks like so
320 **b. Submit/ Distribute the flow:**
322 Once your flow is complete and saved in the Nifi registry, you can
323 choose to submit it for distribution.
327 If the flow was submitted successfully to the runtime api, you should
328 get a pop up a success message like so -
332 At this step, the design was packaged and sent to Runtime api.
334 The runtime is supposed to generate the blueprint out of the packaged
335 design/flow and push it to the DCAE inventory and the DCAE Dasboard.
337 **c. Checking the components in the DCAE Dashboard**
339 You should see the generated artifact/ blueprint in the DCAE Dashboard
340 dashboard at https://<IPAddress>:30418/ccsdk-app/login_external.htm in
341 our deployment. The name for each component will be appended by the flow
342 name followed by underscore followed by the component’s name.
344 The credentials to access the DCAE Dashboard
356 The generated Blueprint can be viewed.
360 Finally, the generated Blueprint can be deployed.
364 You can use/import the attached input configurations files to deploy. Drag and Drop these sample JSON files to fill in the configuration values.
365 See :download:`VES Collector Input Configuration <./Sample-Input-Files/ves-deploy.input.json>`
366 See :download:`Tcagen2 Input Configuration <./Sample-Input-Files/tca-deploy.input.json>`
372 .. |image0| image:: ../images/1.png
375 .. |image1| image:: ../images/2.png
378 .. |image2| image:: ../images/3.png
381 .. |image3| image:: ../images/4.png
384 .. |image4| image:: ../images/5.png
387 .. |image5| image:: ../images/6.png
390 .. |image6| image:: ../images/7.png
393 .. |image7| image:: ../images/8.png
396 .. |image8| image:: ../images/9.png
399 .. |image9| image:: ../images/10.png
402 .. |image10| image:: ../images/11.png
405 .. |image11| image:: ../images/12.png
408 .. |image12| image:: ../images/13.png
411 .. |image13| image:: ../images/14.png
414 .. |image14| image:: ../images/15.png
417 .. |image15| image:: ../images/16.png
420 .. |image16| image:: ../images/17.png
423 .. |image17| image:: ../images/18.png
426 .. |image18| image:: ../images/19.png
429 .. |image19| image:: ../images/20.png
432 .. |image20| image:: ../images/21.png
435 .. |image21| image:: ../images/22.png
438 .. |image22| image:: ../images/23.png
441 .. |image23| image:: ../images/24.png
444 .. |image24| image:: ../images/25.png
447 .. |image25| image:: ../images/26.png
448 .. |image26| image:: ../images/27.png