Merge "[SLICEMS] Docs for SliceMS Kohn"
[dcaegen2.git] / docs / sections / services / kpi-computation-ms / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. _kpi-installation:
4
5
6 Installation
7 ============
8
9 Kpi Computation MS can be deployed using cloudify blueprint using bootstrap container of an existing DCAE deployment.
10
11 Deployment Pre-requisites
12 ~~~~~~~~~~~~~~~~~~~~~~~~~
13 - DCAE and DMaaP pods should be up and running.
14
15 - PM mapper service should be running.
16
17 - Make sure that cfy is installed and configured to work with the Cloudify deployment.
18
19
20 Deployment steps
21 ~~~~~~~~~~~~~~~~
22 Execute bash on the bootstrap Kubernetes pod.
23
24    kubectl -n onap exec -it <dcaegen2-dcae-bootstrap> bash
25
26 Validate Blueprint
27 ------------------
28 Before the blueprints uploading to Cloudify manager, the blueprints shoule be validated first through the following command.
29   .. code-block :: bash
30
31     #cfy blueprint validate /bluerints/k8s-kpi-ms.yaml
32
33 Upload the Blueprint to Cloudify Manager.
34 -----------------------------------------
35 After validating, we can start to proceed blueprints uploading.
36   .. code-block :: bash
37
38      #cfy blueprint upload -b kpi-ms /bluerints/k8s-kpi-ms.yaml
39
40 Verify Uploaded Blueprints
41 --------------------------
42 Using "cfy blueprint list" to verify your work.
43   .. code-block :: bash
44
45      #cfy blueprint list
46
47 You can see the following returned message to show the blueprints have been correctly uploaded.
48   .. image :: ./blueprint-list.png
49
50
51 Verify Plugin Versions
52 ----------------------
53 If the version of the plugin used is different, update the blueprint import to match.
54   .. code-block :: bash
55
56      #cfy plugins list
57
58 Create Deployment
59 -----------------
60 Here we are going to create deployments for both feeder and admin UI.
61   .. code-block :: bash
62
63      #cfy deployments create -b kpi-ms kpi-ms
64
65 Launch Service
66 --------------
67 Next, we are going to launch the KPI-MS.
68   .. code-block :: bash
69
70      #cfy executions start -d kpi-ms install
71
72
73 Verify the Deployment Result
74 ----------------------------
75 The following command can be used to list the kpi-ms logs.
76
77   .. code-block :: bash
78
79      #kubectl logs <kpi-pod> -n onap
80
81 The output should looks like.
82     .. image :: ./kpi-log.PNG
83
84 Uninstall
85 ---------
86 Uninstall running component and delete deployment
87   .. code-block :: bash
88
89      #cfy uninstall kpi-ms
90
91 Delete Blueprint
92 ----------------
93   .. code-block :: bash
94
95      #cfy blueprints delete kpi-ms