blob: e50d035155d0f0211f528cf53d06d35769f26a7f [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
maximesson4ad68382019-06-05 17:51:29 +0200241. Execute bash on the cloudify manager kubernetes pod.
maximessone707b222019-05-09 14:27:34 +000025
maximesson4ad68382019-06-05 17:51:29 +020026 ``kubectl -n onap exec -it <dev-dcaegen2-dcae-cloudify-manager> bash``
maximessone707b222019-05-09 14:27:34 +000027
282. Download the dfc `blueprint`_.
maximessone707b222019-05-09 14:27:34 +000029
maximesson4ad68382019-06-05 17:51:29 +020030.. _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 +000031
323. Run Cloudify Install command to install dfc.
33
maximesson4ad68382019-06-05 17:51:29 +020034 ``cfy install <dfc-blueprint-path>``
maximessone707b222019-05-09 14:27:34 +000035
36Sample output:
37
maximesson4ad68382019-06-05 17:51:29 +020038 ``cfy install k8s-datafile.yaml``
maximessone707b222019-05-09 14:27:34 +000039
40Run '*cfy events list -e 37da3f5f-a06b-4ce8-84d3-8b64ccd81c33'* to retrieve the execution's events/logs.
41
42Validation
43^^^^^^^^^^
44
45curl <dcaegen2-dcae-healthcheck> and check if datafile-collector is in *'ready'* state.
46
47Standalone deployment of a container
48------------------------------------
49
50DFC is delivered as a docker container based on openjdk:8-jre-alpine. The
Chengkai Yan7f278e32018-11-06 16:32:03 +010051host or VM that will run this container must have the docker application
52loaded and available to the userID that will be running the DFC container.
53
maximessone707b222019-05-09 14:27:34 +000054Also required is a working DMAAP/MR and DMAAP/DR environment. DFC
Chengkai Yan7f278e32018-11-06 16:32:03 +010055subscribes to DMAAP/MR fileReady event as JSON messages and publishes the downloaded files to the DMAAP/DR.
56
57Installation
58^^^^^^^^^^^^
59
maximesson4ad68382019-06-05 17:51:29 +020060The following command will download the Dublin version of the datafile image from
Chengkai Yan7f278e32018-11-06 16:32:03 +010061nexus and launch it in the container named "datafile":
62
maximesson4ad68382019-06-05 17:51:29 +020063 ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3``
maximessone707b222019-05-09 14:27:34 +000064
maximesson4ad68382019-06-05 17:51:29 +020065For another version, it is possible to replace the tag '1.1.3' with any version that seems suitable (including latest).
maximessone707b222019-05-09 14:27:34 +000066Available images are visible following this `link`_.
67
maximesson4ad68382019-06-05 17:51:29 +020068.. _link: https://nexus3.onap.org/#browse/search=keyword%3D*datafile*
maximessone707b222019-05-09 14:27:34 +000069
maximesson4ad68382019-06-05 17:51:29 +020070Another option is to pull the image first, and then run the image's container with the image ID:
maximessone707b222019-05-09 14:27:34 +000071
72 ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest``
73
74 ``docker images | grep 'datafile'``
75
76 ``docker run -d -p 8100:8100 -p 8433:8433 <image ID>``
77
78The grep command will display the images corresponding to DFC. There can be several due to remotely or locally built
79image, and also to different tags, i.e. different versions.
ecaiyanlinux7b9db0f2019-08-21 08:38:04 +000080
81Certifcates
82^^^^^^^^^^^
83.. _page: ./certifcates.rst