clean up some sphinx warnings
[dcaegen2.git] / docs / sections / services / ves-hv / installation-helm.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 .. _hv-ves-installation-helm:\r
4 \r
5 HV-VES Helm Installation\r
6 ========================\r
7 Starting from ONAP/Honolulu release, HV-VES is installed with a DCAEGEN2-Services Helm charts.\r
8 HV-VES application is configured by default to use TLS/SSL encryption on TCP connection.\r
9 \r
10 Disable TLS security - Helm based deployment\r
11 --------------------------------------------\r
12 \r
13 \r
14 The default behavior can be changed by upgrading dcaegen2-services deployment with custom values:\r
15     .. code-block:: bash\r
16 \r
17         helm -n <namespace> upgrade <DEPLOYMENT_PREFIX>-dcaegen2-services --reuse-values --values <path to values> <path to dcaegen2-services helm charts>\r
18 \r
19 For example:\r
20     .. code-block:: bash\r
21 \r
22         helm -n onap upgrade dev-dcaegen2-services --reuse-values --values new-config.yaml oom/kubernetes/dcaegen2-services\r
23 \r
24 Where the contents of ``new-config.yaml`` file is:\r
25     .. code-block:: yaml\r
26 \r
27         dcae-hv-ves-collector:\r
28           applicationConfig:\r
29             security.sslDisable: true\r
30 \r
31 For small changes like this, it is also possible to inline the new value:\r
32     .. code-block:: bash\r
33 \r
34         helm -n onap upgrade dev-dcaegen2-services --reuse-values --set dcae-hv-ves-collector.applicationConfig.security.sslDisable="true" oom/kubernetes/dcaegen2-services\r
35 \r
36 After the upgrade, the security.sslDisable property should be changed and visible inside dev-dcae-ves-collector-application-config-configmap Config-Map.\r
37 It can be verified by running:\r
38 \r
39     .. code-block:: bash\r
40 \r
41         kubectl -n onap get cm <config map name> -o yaml\r
42 \r
43 For HV-VES Collector:\r
44 \r
45     .. code-block:: bash\r
46 \r
47         kubectl -n onap get cm dev-dcae-hv-ves-collector-application-config-configmap -o yaml\r
48 \r
49 \r
50 For apply new configuration by HV-VES Collector the application restart might be necessary. It could be done by HV-VES helm reinstallation:\r
51 \r
52     .. code-block:: bash\r
53 \r
54         helm -n onap upgrade dev-dcaegen2-services --reuse-values --set dcae-hv-ves-collector.enabled="false" oom/kubernetes/dcaegen2-services\r
55         helm -n onap upgrade dev-dcaegen2-services --reuse-values --set dcae-hv-ves-collector.enabled="true" oom/kubernetes/dcaegen2-services\r
56 \r
57 \r
58 Using external TLS certificates obtained using CMP v2 protocol\r
59 --------------------------------------------------------------\r
60 \r
61 In order to use the X.509 certificates obtained from the CMP v2 server (so called "operator`s certificates"), refer to the following description:\r
62 \r
63 :ref:`Enabling TLS with external x.509 certificates <tls_enablement>`\r
64 \r
65 Example values for HV-VES Collector:\r
66 \r
67     .. code-block:: yaml\r
68 \r
69         global:\r
70           cmpv2Enabled: true\r
71         dcae-ves-collector:\r
72           useCmpv2Certificates: true\r
73           certificates:\r
74           - mountPath: /etc/ves-hv/ssl/external\r
75             commonName: dcae-hv-ves-collector\r
76             dnsNames:\r
77               - dcae-hv-ves-collector\r
78               - hv-ves-collector\r
79               - hv-ves\r
80             keystore:\r
81               outputType:\r
82                 - jks\r
83               passwordSecretRef:\r
84                 name: hv-ves-cmpv2-keystore-password\r
85                 key: password\r
86                 create: true\r