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