docs/sections/services/ves-http/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
   7 VESCollector is installed via cloudify blueprint by DCAE bootstrap process on typical ONAP installation.
   8 As the service is containerized, it can be started on stand-alone mode also.
   9
  10
  11 To run VES Collector container on standalone mode, following parameters are required
  12
  13     ``docker run -d -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.0.11.1' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.7.9``
  14
  15
  16 DMAAPHOST is required for standalone; for normal platform installed instance the publish URL are obtained from Consul. Below parameters are exposed for DCAE platform (cloudify) deployed instance
  17
  18
  19 - COLLECTOR_IP
  20 - DMAAPHOST - should contain an address to DMaaP, so that event publishing can work
  21 - CONFIG_BINDING_SERVICE - should be a name of CBS
  22 - CONFIG_BINDING_SERVICE_SERVICE_PORT - should be a http port of CBS
  23 - HOSTNAME - should be a name of VESCollector application as it is registered in CBS catalog
  24
  25 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
  26
  27
  28 Authentication Support
  29 ----------------------
  30
  31 VES Collector support following authentication types
  32
  33     * *auth.method=noAuth* default option - no security (http)
  34     * *auth.method=certBasicAuth* is used to enable mutual TLS authentication or/and basic HTTPs authentication
  35
  36 The blueprint is same for both deployments - based on the input configuration, VESCollector can be set for required authentication type.
  37 Default ONAP deployed VESCollector is configured for "certBasicAuth".
  38
  39 If VESCollector instance need to be deployed with authentication disabled, follow below setup
  40
  41
  42 - Execute into Bootstrap POD using kubectl command
  43
  44 - VES blueprint is available under  /blueprints directory ``k8s-ves-tls.yaml``. A corresponding input files is also pre-loaded into bootstrap
  45 pod under /inputs/k8s-ves-inputs.yaml
  46
  47 - Deploy blueprint
  48     .. code-block:: bash
  49
  50         cfy install -b ves-http -d ves-http -i /inputs/k8s-ves-inputs.yaml /blueprints/k8s-ves-tls.yaml
  51
  52 To undeploy ves-http, steps are noted below
  53
  54 - Uninstall running ves-http and delete deployment
  55     .. code-block:: bash
  56
  57         cfy uninstall ves-http
  58
  59 The deployment uninstall will also delete the blueprint. In some case you might notice 400 error reported indicating active deployment exist such as below
  60 ** An error occurred on the server: 400: Can't delete blueprint ves-http - There exist deployments for this blueprint; Deployments ids: ves-http**
  61
  62 In this case blueprint can be deleted explicitly using this command.
  63
  64     .. code-block:: bash
  65
  66         cfy blueprint delete ves-http
  67