Add documentation of adding external repo schema via helm installation
Issue-ID: DCAEGEN2-2630
Signed-off-by: Tomasz Wrobel <tomasz.wrobel@nokia.com>
Change-Id: I86907081085282416671d9c6289a8f6380ad66df
diff --git a/docs/sections/services/ves-http/installation-helm.rst b/docs/sections/services/ves-http/installation-helm.rst
index 0a4cd9a..9728e64 100644
--- a/docs/sections/services/ves-http/installation-helm.rst
+++ b/docs/sections/services/ves-http/installation-helm.rst
@@ -18,12 +18,12 @@
The default behavior can be changed by upgrading dcaegen2-services deployment with custom values:
.. code-block:: bash
- helm -n onap upgrade <DEPLOYMENT_PREFIX>-dcaegen2-services oom/kubernetes/dcaegen2-services --reuse-values --values <path to values>
+ helm -n <namespace> upgrade <DEPLOYMENT_PREFIX>-dcaegen2-services --reuse-values --values <path to values> <path to dcaegen2-services helm charts>
For example:
.. code-block:: bash
- helm -n onap upgrade dev-dcaegen2-services oom/kubernetes/dcaegen2-services --reuse-values --values new-config.yaml
+ helm -n onap upgrade dev-dcaegen2-services --reuse-values --values new-config.yaml oom/kubernetes/dcaegen2-services
Where the contents of ``new-config.yaml`` file is:
.. code-block:: bash
@@ -35,7 +35,7 @@
For small changes like this, it is also possible to inline the new value:
.. code-block:: bash
- helm -n onap upgrade dev-dcaegen2-services oom/kubernetes/dcaegen2-services --reuse-values --set dcae-ves-collector.applicationConfig.auth.method="noAuth"
+ helm -n onap upgrade dev-dcaegen2-services --reuse-values --set dcae-ves-collector.applicationConfig.auth.method="noAuth" oom/kubernetes/dcaegen2-services
After the upgrade, the new auth method value should be visible inside dev-dcae-ves-collector-application-config-configmap Config-Map.
It can be verified by running:
@@ -48,6 +48,59 @@
kubectl -n onap get cm dev-dcae-ves-collector-application-config-configmap -o yaml
+
+.. _external-repo-schema-via-helm:
+
+External repository schema files integration with VES Collector
+-------------------------------------------------------------------
+In order to utilize the externalRepo openAPI schema files defined in `OOM <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2-services/resources/external>`_ repository and installed with dcaegen2 module, follow below steps.
+
+1. Go to directory with dcaegen2-services helm charts (oom/kubernetes/dcaegen2-services). These charts should be located on RKE deployer node or server which is used to deploy and manage ONAP installation by Helm charts.
+2. Create file with specific VES values-overrides:
+
+.. code-block:: yaml
+
+ dcae-ves-collector:
+ externalVolumes:
+ - name: '<config map name with schema mapping file>'
+ type: configmap
+ mountPath: <path on VES collector container where externalRepo schema-map is expected>
+ optional: true
+ - name: '<config map name contains schemas>'
+ type: configmap
+ mountPath: <path on VES collector container where externalRepo openAPI files are stored>
+ optional: true
+
+E.g:
+
+.. code-block:: yaml
+
+ dcae-ves-collector:
+ externalVolumes:
+ - name: 'dev-dcae-external-repo-configmap-schema-map'
+ type: configmap
+ mountPath: /opt/app/VESCollector/etc/externalRepo
+ optional: true
+ - name: 'dev-dcae-external-repo-configmap-sa91-rel16'
+ type: configmap
+ mountPath: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI
+ optional: true
+
+If more than a single external schema is required add new config map to object 'externalVolumes' like in above example. Make sure that all external schemas (all openAPI files) are reflected in the schema-map file.
+
+3. Upgrade release using following command:
+
+.. code-block:: bash
+
+ helm -n <namespace> upgrade <dcaegen2-services release name> --reuse-values -f <path to values.yaml file created in previous step> <path to dcaegen2-services helm chart>
+
+E.g:
+
+.. code-block:: bash
+
+ helm -n onap upgrade dev-dcaegen2-services --reuse-values -f values.yaml .
+
+
Using external TLS certificates obtained using CMP v2 protocol
--------------------------------------------------------------