Add datalake deployment guide.
[dcaegen2.git] / docs / sections / services / datalake-handler / installation.rst
1 Deployment Steps
2 ################
3 DL-handler consists of two pods- the feeder and admin UI. It can be deployed by using cloudify blueprint. Datalake can be easily deployed through DCAE cloudify manager. The following steps guides you launch Datalake though cloudify manager.
4
5 Pre-requisite
6 ----------------
7 - Make sure mariadb-galera from OOM is properly deployed and functional.
8 - An external database, such as Elasticsearch and MongoDB is deployed.
9
10 After datalake getting deployed, the admin UI can be used to configure the sink database address and credentials.
11
12 Log-in to the DCAE Bootstrap POD
13 ---------------------------------------------------
14
15 First, we should find the bootstrap pod name through the following command and make sure that DCAE coudify manager is properly deployed.
16   .. image :: .images/bootstrap-pod.png
17
18 Login to the DCAE bootstrap pod through the following command.
19   .. code-block :: bash
20
21      #kubectl exec -it <DCAE bootstrap pod> /bin/bash -n onap
22
23 Validate Blueprint
24 -------------------
25 Before the blueprints uploading to Cloudify manager, the blueprints shoule be validated first throuhg the following command.
26   .. code-block :: bash
27
28     #cfy blueprint validate /bluerints/k8s-datalake-feeder.yaml
29     #cfy blueprint validate /blueprints/k8s-datalake-admin-ui.yaml
30
31 Upload the Blueprint to Cloudify Manager.
32 -----------------------------------------
33 After validating, we can start to proceed blueprints uploading.
34   .. code-block :: bash
35
36      #cfy blueprint upload -b datalake-feeder /bluerints/k8s-datalake-feeder.yaml
37      #cfy blueprint upload -b datalake-admin-ui /blueprints/k8s-datalake-admin-ui.yaml
38
39 Verify Uploaded Blueprints
40 --------------------------
41 Using "cft blueprint list" to varify your work.
42   .. code-block :: bash
43
44      #cfy blueprint list
45
46 You can see the following returned message to show the blueprints have been correctly uploaded.
47   .. image :: ./imagesblueprint-list.png
48
49
50 Verify Plugin Versions
51 ------------------------------------------------------------------------------
52 If the version of the plugin used is different, update the blueprint import to match.
53   .. code-block :: bash
54
55      #cfy plugins list
56
57 Create Deployment
58 -----------------
59 Here we are going to create deployments for both feeder and admin UI.
60   .. code-block :: bash
61
62      #cfy deployments create -b datalake-feeder feeder-deploy
63      #cfy deployments create -b datalake-admin-ui admin-ui-deploy
64
65 Launch Service
66 ---------------
67 Next, we are going to launch the datalake.
68   .. code-block :: bash
69
70      #cfy executions start -d feeder-deploy install
71      #cfy executions start -d admin-ui-deploy install
72
73
74 Verify the Deployment Result
75 -----------------------------
76 The following command can be used to list the datalake logs.
77   .. code-block :: bash
78      #kubectl logs <datalake-pod> -n onap
79
80 The output should looks like.
81     .. image :: ./feeder-log.png
82
83 If you find any Java exception from log, make sure that the external database and datalake configuration are properly configured.
84 Admin UI can be used to configure the external database configuration.
85
86
87 Uninstall
88 ----------
89 Uninstall running component and delete deployment
90   .. code-block :: bash
91
92      #cfy uninstall feeder-deploy
93      #cfy uninstall admin-ui-deploy
94
95 Delete Blueprint
96 ------------------
97   .. code-block :: bash
98
99      #cfy blueprints delete datalake-feeder
100      #cfy blueprints deltet datalake-admin-ui