[VES-OPENAPI] Update docs with kafka
[dcaegen2.git] / docs / sections / services / ves-hv / 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
4 .. _installation:
5
6 HV-VES Cloudify Installation
7 ============================
8
9 Starting from ONAP/Honolulu release, HV-VES is installed with a DCAEGEN2-Services Helm charts.
10 This installation mechanism is convenient, but it doesn`t support all HV-VES features (e.g. CMP v2 certificates, and IPv4/IPv6 dual stack networking). This description demonstrates, how to deploy HV-VES collector using Cloudify orchestrator.
11
12 Setting insecure mode for testing
13 ---------------------------------
14
15 HV-VES application is configured by default to use TLS/SSL encryption on TCP connection. 
16
17 Accessing bootstrap container with Kubernetes command line tool
18 ---------------------------------------------------------------
19
20 To find bootstrap pod, execute the following command:
21
22 ::
23
24     kubectl -n <onap namespace> get pods | grep bootstrap
25
26 To run command line in bootstrap pod, execute:
27
28 ::
29
30     kubectl -n <onap namespace> exec -it <bootstrap-pod-name> bash
31
32
33 Install HV-VES collector using Cloudify blueprint inputs
34 ---------------------------------------------------------
35
36 1. If You have a running HV-VES instance, uninstall HV-VES and delete current deployment:
37
38 :: 
39
40     cfy executions start -d hv-ves uninstall
41     cfy deployments delete hv-ves 
42
43 2. Create new deployment with inputs from yaml file (available by default in bootstrap container):
44
45 :: 
46
47     cfy deployments create -b hv-ves -i inputs/k8s-hv_ves-inputs.yaml hv-ves
48
49 In order to disable the TLS security, override the 'secuirty_ssl_disable' value in the deloyment:
50
51 ::
52
53     cfy deployments create -b hv-ves -i inputs/k8s-hv_ves-inputs.yaml -i security_ssl_disable=True hv-ves
54
55 To verify inputs, You can execute: 
56
57 :: 
58
59     cfy deployments inputs hv-ves
60
61 3. Install HV-VES deployment:
62
63 :: 
64
65     cfy executions start -d hv-ves install
66
67
68 Using external TLS certificates obtained using CMP v2 protocol
69 --------------------------------------------------------------
70
71 In order to use the X.509 certificates obtained from the CMP v2 server (so called "operator`s certificates"), refer to the following description:
72
73 .. toctree::
74     :maxdepth: 1
75
76      Enabling TLS with external x.509 certificates <../../tls_enablement>