blob: 27d1ac5a31f5d27599b40e41bf180fca0df3c525 [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
VENKATESH KUMAR7f3e4532020-11-18 16:30:36 -05003.. _dfc-installation:
4
Chengkai Yan7f278e32018-11-06 16:32:03 +01005
6Installation
7============
8
9An environment suitable for running docker containers is recommended.
10
maximessone707b222019-05-09 14:27:34 +000011Using Cloudify deployment
12-------------------------
Chengkai Yan7f278e32018-11-06 16:32:03 +010013
maximessone707b222019-05-09 14:27:34 +000014The first possibility is to use blueprints and cfy commands.
15
16Deployment Prerequisite/dependencies
17^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18
19Make sure that **cfy** is installed and configured to work with the Cloudify deployment.
20
21Make sure the Message Router and Data Router are running.
22
23Deployment steps
24^^^^^^^^^^^^^^^^
25
maximesson4ad68382019-06-05 17:51:29 +0200261. Execute bash on the cloudify manager kubernetes pod.
maximessone707b222019-05-09 14:27:34 +000027
maximesson4ad68382019-06-05 17:51:29 +020028 ``kubectl -n onap exec -it <dev-dcaegen2-dcae-cloudify-manager> bash``
maximessone707b222019-05-09 14:27:34 +000029
302. Download the dfc `blueprint`_.
maximessone707b222019-05-09 14:27:34 +000031
maximesson4ad68382019-06-05 17:51:29 +020032.. _blueprint: 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
maximessone707b222019-05-09 14:27:34 +000033
343. Run Cloudify Install command to install dfc.
35
maximesson4ad68382019-06-05 17:51:29 +020036 ``cfy install <dfc-blueprint-path>``
maximessone707b222019-05-09 14:27:34 +000037
38Sample output:
39
maximesson4ad68382019-06-05 17:51:29 +020040 ``cfy install k8s-datafile.yaml``
maximessone707b222019-05-09 14:27:34 +000041
42Run '*cfy events list -e 37da3f5f-a06b-4ce8-84d3-8b64ccd81c33'* to retrieve the execution's events/logs.
43
44Validation
45^^^^^^^^^^
46
47curl <dcaegen2-dcae-healthcheck> and check if datafile-collector is in *'ready'* state.
48
49Standalone deployment of a container
50------------------------------------
51
52DFC is delivered as a docker container based on openjdk:8-jre-alpine. The
Chengkai Yan7f278e32018-11-06 16:32:03 +010053host or VM that will run this container must have the docker application
54loaded and available to the userID that will be running the DFC container.
55
maximessone707b222019-05-09 14:27:34 +000056Also required is a working DMAAP/MR and DMAAP/DR environment. DFC
Chengkai Yan7f278e32018-11-06 16:32:03 +010057subscribes to DMAAP/MR fileReady event as JSON messages and publishes the downloaded files to the DMAAP/DR.
58
59Installation
60^^^^^^^^^^^^
61
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -040062The following command will download the Frankfurt version of the datafile image from
Chengkai Yan7f278e32018-11-06 16:32:03 +010063nexus and launch it in the container named "datafile":
64
VENKATESH KUMAR7cfaea22020-04-22 17:31:32 -040065 ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0``
maximessone707b222019-05-09 14:27:34 +000066
Vijay VK09589ca2019-10-08 04:47:17 +010067For another version, it is possible to replace the tag '1.2.3' with any version that seems suitable (including latest).
maximessone707b222019-05-09 14:27:34 +000068Available images are visible following this `link`_.
69
maximesson4ad68382019-06-05 17:51:29 +020070.. _link: https://nexus3.onap.org/#browse/search=keyword%3D*datafile*
maximessone707b222019-05-09 14:27:34 +000071
maximesson4ad68382019-06-05 17:51:29 +020072Another option is to pull the image first, and then run the image's container with the image ID:
maximessone707b222019-05-09 14:27:34 +000073
74 ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest``
75
76 ``docker images | grep 'datafile'``
77
78 ``docker run -d -p 8100:8100 -p 8433:8433 <image ID>``
79
80The grep command will display the images corresponding to DFC. There can be several due to remotely or locally built
81image, and also to different tags, i.e. different versions.
ecaiyanlinux7b9db0f2019-08-21 08:38:04 +000082
83Certifcates
84^^^^^^^^^^^
85.. _page: ./certifcates.rst