blob: d782a5228a82ec803ebcf1b435a926afc7a4ea30 [file] [log] [blame]
Chengkai Yan7f278e32018-11-06 16:32:03 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Installation
5============
6
7An environment suitable for running docker containers is recommended.
8
maximessone707b222019-05-09 14:27:34 +00009Using Cloudify deployment
10-------------------------
Chengkai Yan7f278e32018-11-06 16:32:03 +010011
maximessone707b222019-05-09 14:27:34 +000012The first possibility is to use blueprints and cfy commands.
13
14Deployment Prerequisite/dependencies
15^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16
17Make sure that **cfy** is installed and configured to work with the Cloudify deployment.
18
19Make sure the Message Router and Data Router are running.
20
21Deployment steps
22^^^^^^^^^^^^^^^^
23
241. Execute bash on the cloudify manager kubernetes pod.
25
26.. code-block:: json
27 kubectl -n onap exec -it <dev-dcaegen2-dcae-cloudify-manager> bash
28
292. Download the dfc `blueprint`_.
30.. _blueprint
31
32 https://gerrit.onap.org/r/gitweb?p=dcaegen2/platform/blueprints.git;a=blob;f=blueprints/reference_templates/k8s-datafile-collector.yaml-template;h=17d2aedec131154b4f5f84a08a099b0364b1e627;hb=HEAD
33
343. Run Cloudify Install command to install dfc.
35
36.. code-block:: json
37 cfy install <dfc-blueprint-path>
38
39Sample output:
40
41..code-block:: json
42 cfy install k8s-datafile.yaml
43
44Run '*cfy events list -e 37da3f5f-a06b-4ce8-84d3-8b64ccd81c33'* to retrieve the execution's events/logs.
45
46Validation
47^^^^^^^^^^
48
49curl <dcaegen2-dcae-healthcheck> and check if datafile-collector is in *'ready'* state.
50
51Standalone deployment of a container
52------------------------------------
53
54DFC is delivered as a docker container based on openjdk:8-jre-alpine. The
Chengkai Yan7f278e32018-11-06 16:32:03 +010055host or VM that will run this container must have the docker application
56loaded and available to the userID that will be running the DFC container.
57
maximessone707b222019-05-09 14:27:34 +000058Also required is a working DMAAP/MR and DMAAP/DR environment. DFC
Chengkai Yan7f278e32018-11-06 16:32:03 +010059subscribes to DMAAP/MR fileReady event as JSON messages and publishes the downloaded files to the DMAAP/DR.
60
61Installation
62^^^^^^^^^^^^
63
maximessone707b222019-05-09 14:27:34 +000064The following command will download the Dublin version of the datafile container from
Chengkai Yan7f278e32018-11-06 16:32:03 +010065nexus and launch it in the container named "datafile":
66
maximessonc762eb12019-04-04 14:43:43 +000067 ``docker run -d -p 8100:8100 -p 8433:8433
maximessone707b222019-05-09 14:27:34 +000068 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.2``
69
70For another version, it is possible to replace the tag '1.1.2' with any version that seems suitable (including latest).
71Available images are visible following this `link`_.
72
73.. _link https://nexus3.onap.org/#browse/search=keyword%3D*datafile*
74
75Another option is to pull the container first, and then run it with the image ID:
76
77 ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest``
78
79 ``docker images | grep 'datafile'``
80
81 ``docker run -d -p 8100:8100 -p 8433:8433 <image ID>``
82
83The grep command will display the images corresponding to DFC. There can be several due to remotely or locally built
84image, and also to different tags, i.e. different versions.