+++ /dev/null
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
-.. http://creativecommons.org/licenses/by/4.0\r
-.. _ves-installation:\r
-\r
-\r
-VES Collector Cloudify Installation\r
-===================================\r
-\r
-VESCollector is installed via cloudify blueprint by DCAE bootstrap process on typical ONAP installation.\r
-As the service is containerized, it can be started on stand-alone mode also.\r
-\r
-\r
-To run VES Collector container on standalone mode, following parameters are required\r
-\r
- ``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``\r
-\r
-\r
-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\r
-\r
-\r
-- COLLECTOR_IP\r
-- DMAAPHOST - should contain an address to DMaaP, so that event publishing can work\r
-- CONFIG_BINDING_SERVICE - should be a name of CBS\r
-- CONFIG_BINDING_SERVICE_SERVICE_PORT - should be a http port of CBS\r
-- HOSTNAME - should be a name of VESCollector application as it is registered in CBS catalog\r
-\r
-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\r
-\r
-\r
-Authentication Support\r
-----------------------\r
-\r
-VES Collector support following authentication types\r
-\r
- * *auth.method=noAuth* default option - no security (http)\r
- * *auth.method=certBasicAuth* is used to enable mutual TLS authentication or/and basic HTTPs authentication\r
-\r
-The blueprint is same for both deployments - based on the input configuration, VESCollector can be set for required authentication type.\r
-Default ONAP deployed VESCollector is configured for "certBasicAuth".\r
-\r
-If VESCollector instance need to be deployed with authentication disabled, follow below setup\r
-\r
-\r
-- Execute into Bootstrap POD using kubectl command\r
- .. note::\r
- For doing this, follow the below steps\r
-\r
- * First get the bootstrap pod name by running this: kubectl get pods -n onap | grep bootstrap\r
- * Then login to bootstrap pod by running this: kubectl exec -it <bootstrap pod> -n onap -- bash\r
-\r
-- 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\r
-\r
-- Deploy blueprint\r
- .. code-block:: bash\r
-\r
- cfy install -b ves-http -d ves-http -i /inputs/k8s-ves-inputs.yaml /blueprints/k8s-ves.yaml\r
-\r
-To undeploy ves-http, steps are noted below\r
-\r
-- Uninstall running ves-http and delete deployment\r
- .. code-block:: bash\r
-\r
- cfy uninstall ves-http\r
-\r
-The deployment uninstall will also delete the blueprint. In some case you might notice 400 error reported indicating active deployment exist such as below\r
-** An error occurred on the server: 400: Can't delete blueprint ves-http - There exist deployments for this blueprint; Deployments ids: ves-http**\r
-\r
-In this case blueprint can be deleted explicitly using this command.\r
-\r
- .. code-block:: bash\r
-\r
- cfy blueprint delete ves-http\r
-\r
-External repo schema files from OOM connection to VES collector\r
--------------------------------------------------------------------\r
-In order to not use schema files bundled in VES Collector image but schema files defined in `OOM <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2/resources/external>`_ repository and installed with dcaegen2 module, follow below setup.\r
-\r
-- Execute into Bootstrap POD using kubectl command\r
- .. note::\r
- For doing this, follow the below steps\r
-\r
- * First get the bootstrap pod name by running this: kubectl get pods -n onap | grep bootstrap\r
- * Then login to bootstrap pod by running this: kubectl exec -it <bootstrap pod> -n onap -- bash\r
-\r
-- 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\r
-\r
-- Edit ``k8s-ves.yaml`` blueprint by adding section below ``docker_config:`` tag:\r
- .. code-block:: bash\r
-\r
- volumes:\r
- - container:\r
- bind: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI\r
- config_volume:\r
- name: dcae-external-repo-configmap-sa88-rel16\r
- - container:\r
- bind: /opt/app/VESCollector/etc/externalRepo/\r
- config_volume:\r
- name: dcae-external-repo-configmap-schema-map\r
-\r
-- After all ``docker_config:`` section in blueprint should looks like:\r
- .. code-block:: bash\r
-\r
- docker_config:\r
- healthcheck:\r
- endpoint: /healthcheck\r
- interval: 15s\r
- timeout: 1s\r
- type: http\r
- volumes:\r
- - container:\r
- bind: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI\r
- config_volume:\r
- name: dcae-external-repo-configmap-sa88-rel16\r
- - container:\r
- bind: /opt/app/VESCollector/etc/externalRepo/\r
- config_volume:\r
- name: dcae-external-repo-configmap-schema-map\r
-\r
-.. note::\r
-\r
- To undeploy ves-http if it is deployed, steps are noted below\r
-\r
- Uninstall running ves-http and delete deployment\r
- .. code-block:: bash\r
-\r
- cfy uninstall ves-http\r
-\r
- The deployment uninstall will also delete the blueprint. In some case you might notice 400 error reported indicating active deployment exist such as below\r
- ** An error occurred on the server: 400: Can't delete blueprint ves-http - There exist deployments for this blueprint; Deployments ids: ves-http**\r
-\r
- In this case blueprint can be deleted explicitly using this command.\r
-\r
- .. code-block:: bash\r
-\r
- cfy blueprint delete ves-http\r
-\r
-To deploy modified ves-http, steps are noted below\r
-\r
-- Load blueprint:\r
- .. code-block:: bash\r
-\r
- cfy blueprints upload -b ves-http /blueprints/k8s-ves.yaml\r
-\r
-- Deploy blueprint\r
- .. code-block:: bash\r
-\r
- cfy install -b ves-http -d ves-http -i /inputs/k8s-ves-inputs.yaml /blueprints/k8s-ves.yaml\r
-\r
-Using external TLS certificates obtained using CMP v2 protocol\r
---------------------------------------------------------------\r
-\r
-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
-\r
-.. toctree::\r
- :maxdepth: 1\r
-\r
- Enabling TLS with external x.509 certificates <../../tls_enablement>\r
Code Review / dcaegen2.git / blobdiff