[VES-OPENAPI] Update docs with kafka

[dcaegen2.git] / docs / sections / services / ves-hv / installation.rst

diff --git a/docs/sections/services/ves-hv/installation.rst b/docs/sections/services/ves-hv/installation.rst
index 7dafeae..4b7eb23 100644 (file)
--- a/docs/sections/services/ves-hv/installation.rst
+++ b/docs/sections/services/ves-hv/installation.rst
@@ -1,27 +1,76 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 
-Installation
-============
+.. _installation:
 
-To run HV-VES Collector container you need to specify required parameters:
+HV-VES Cloudify Installation
+============================
 
-- listen-port - the port on which HV-VES will listen internally
-- config-url - URL of HV-VES configuration on consul
+Starting from ONAP/Honolulu release, HV-VES is installed with a DCAEGEN2-Services Helm charts.
+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.
 
-There are also optional configuration parameters:
+Setting insecure mode for testing
+---------------------------------
 
-- health-check-api-port - Health check rest api listen port
-- first-request-delay - Delay of first request to consul in seconds
-- request-interval - Interval of consul configuration requests in seconds
-- ssl-disable - Disable SSL encryption
-- key-store - Key store in PKCS12 format path
-- key-store-password - Key store password
-- trust-store - File with trusted certificate bundle in PKCS12 format path
-- trust-store-password - Trust store password
-- idle-timeout-sec - Idle timeout for remote hosts. After given time without any data exchange the connection might be closed
+HV-VES application is configured by default to use TLS/SSL encryption on TCP connection. 
 
+Accessing bootstrap container with Kubernetes command line tool
+---------------------------------------------------------------
 
-These parameters can be configured either by passing command line option during `docker run` call or
-by specifying environment variables named after command line option name
-rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix e.g. `VESHV_LISTEN_PORT`.
\ No newline at end of file
+To find bootstrap pod, execute the following command:
+
+::
+
+    kubectl -n <onap namespace> get pods | grep bootstrap
+
+To run command line in bootstrap pod, execute:
+
+::
+
+    kubectl -n <onap namespace> exec -it <bootstrap-pod-name> bash
+
+
+Install HV-VES collector using Cloudify blueprint inputs
+---------------------------------------------------------
+
+1. If You have a running HV-VES instance, uninstall HV-VES and delete current deployment:
+
+:: 
+
+    cfy executions start -d hv-ves uninstall
+    cfy deployments delete hv-ves 
+
+2. Create new deployment with inputs from yaml file (available by default in bootstrap container):
+
+:: 
+
+    cfy deployments create -b hv-ves -i inputs/k8s-hv_ves-inputs.yaml hv-ves
+
+In order to disable the TLS security, override the 'secuirty_ssl_disable' value in the deloyment:
+
+::
+
+    cfy deployments create -b hv-ves -i inputs/k8s-hv_ves-inputs.yaml -i security_ssl_disable=True hv-ves
+
+To verify inputs, You can execute: 
+
+:: 
+
+    cfy deployments inputs hv-ves
+
+3. Install HV-VES deployment:
+
+:: 
+
+    cfy executions start -d hv-ves install
+
+
+Using external TLS certificates obtained using CMP v2 protocol
+--------------------------------------------------------------
+
+In order to use the X.509 certificates obtained from the CMP v2 server (so called "operator`s certificates"), refer to the following description:
+
+.. toctree::
+    :maxdepth: 1
+
+     Enabling TLS with external x.509 certificates <../../tls_enablement>