Merge "[SLICEMS] Docs for SliceMS Kohn"
[dcaegen2.git] / docs / sections / services / dfc / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
2 .. http://creativecommons.org/licenses/by/4.0\r
3 .. _dfc-installation:\r
4 \r
5 \r
6 Installation\r
7 ============\r
8 \r
9 An environment suitable for running docker containers is recommended.\r
10 \r
11 Using Cloudify deployment\r
12 -------------------------\r
13 \r
14 The first possibility is to use blueprints and cfy commands.\r
15 \r
16 Deployment Prerequisite/dependencies\r
17 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
18 \r
19 Make sure that **cfy** is installed and configured to work with the Cloudify deployment.\r
20 \r
21 Make sure the Message Router and Data Router are running.\r
22 \r
23 Deployment steps\r
24 ^^^^^^^^^^^^^^^^\r
25 \r
26 1. Execute bash on the cloudify manager kubernetes pod.\r
27 \r
28     ``kubectl -n onap exec -it <dev-dcaegen2-dcae-cloudify-manager> bash``\r
29 \r
30 2. Download the dfc `blueprint`_.\r
31 \r
32 .. _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\r
33 \r
34 3. Run Cloudify Install command to install dfc.\r
35 \r
36     ``cfy install <dfc-blueprint-path>``\r
37 \r
38 Sample output:\r
39 \r
40     ``cfy install k8s-datafile.yaml``\r
41 \r
42 Run '*cfy events list -e 37da3f5f-a06b-4ce8-84d3-8b64ccd81c33'* to retrieve the execution's events/logs.\r
43 \r
44 Validation\r
45 ^^^^^^^^^^\r
46 \r
47 curl <dcaegen2-dcae-healthcheck> and check if datafile-collector is in *'ready'* state.\r
48 \r
49 Standalone deployment of a container\r
50 ------------------------------------\r
51 \r
52 DFC is delivered as a docker container based on openjdk:8-jre-alpine.  The\r
53 host or VM that will run this container must have the docker application\r
54 loaded and available to the userID that will be running the DFC container.\r
55 \r
56 Also required is a working DMAAP/MR and DMAAP/DR environment. DFC\r
57 subscribes to DMAAP/MR fileReady event as JSON messages and publishes the downloaded files to the DMAAP/DR.\r
58 \r
59 Installation\r
60 ^^^^^^^^^^^^\r
61 \r
62 The following command will download the Frankfurt version of the datafile image from\r
63 nexus and launch it in the container named "datafile":\r
64 \r
65     ``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``\r
66 \r
67 For another version, it is possible to replace the tag '1.2.3' with any version that seems suitable (including latest).\r
68 Available images are visible following this `link`_.\r
69 \r
70 .. _link: https://nexus3.onap.org/#browse/search=keyword%3D*datafile*\r
71 \r
72 Another option is to pull the image first, and then run the image's container with the image ID:\r
73 \r
74     ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest``\r
75 \r
76     ``docker images | grep 'datafile'``\r
77 \r
78     ``docker run -d -p 8100:8100 -p 8433:8433 <image ID>``\r
79 \r
80 The grep command will display the images corresponding to DFC. There can be several due to remotely or locally built\r
81 image, and also to different tags, i.e. different versions.\r
82 \r
83 Certifcates\r
84 ^^^^^^^^^^^\r
85 .. _page: ./certifcates.rst\r