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 (file)
--- a/docs/sections/services/ves-http/installation-helm.rst
+++ b/docs/sections/services/ves-http/installation-helm.rst
@@ -18,12 +18,12 @@ Default ONAP deployed VESCollector is configured for "certBasicAuth".
 The default behavior can be changed by upgrading dcaegen2-services deployment with custom values:\r
     .. code-block:: bash\r
 \r
-        helm -n onap upgrade <DEPLOYMENT_PREFIX>-dcaegen2-services oom/kubernetes/dcaegen2-services --reuse-values --values <path to values>\r
+        helm -n <namespace> upgrade <DEPLOYMENT_PREFIX>-dcaegen2-services --reuse-values --values <path to values> <path to dcaegen2-services helm charts>\r
 \r
 For example:\r
     .. code-block:: bash\r
 \r
-        helm -n onap upgrade dev-dcaegen2-services oom/kubernetes/dcaegen2-services --reuse-values --values new-config.yaml\r
+        helm -n onap upgrade dev-dcaegen2-services --reuse-values --values new-config.yaml oom/kubernetes/dcaegen2-services\r
 \r
 Where the contents of ``new-config.yaml`` file is:\r
     .. code-block:: bash\r
@@ -35,7 +35,7 @@ Where the contents of ``new-config.yaml`` file is:
 For small changes like this, it is also possible to inline the new value:\r
     .. code-block:: bash\r
 \r
-        helm -n onap upgrade dev-dcaegen2-services oom/kubernetes/dcaegen2-services --reuse-values --set dcae-ves-collector.applicationConfig.auth.method="noAuth"\r
+        helm -n onap upgrade dev-dcaegen2-services --reuse-values --set dcae-ves-collector.applicationConfig.auth.method="noAuth" oom/kubernetes/dcaegen2-services\r
 \r
 After the upgrade, the new auth method value should be visible inside dev-dcae-ves-collector-application-config-configmap Config-Map.\r
 It can be verified by running:\r
@@ -48,6 +48,59 @@ For VES Collector:
 \r
         kubectl -n onap get cm dev-dcae-ves-collector-application-config-configmap -o yaml\r
 \r
+\r
+.. _external-repo-schema-via-helm:\r
+\r
+External repository schema files integration with VES Collector\r
+-------------------------------------------------------------------\r
+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.\r
+\r
+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.\r
+2. Create file with specific VES values-overrides:\r
+\r
+.. code-block:: yaml\r
+\r
+  dcae-ves-collector:\r
+    externalVolumes:\r
+      - name: '<config map name with schema mapping file>'\r
+        type: configmap\r
+        mountPath: <path on VES collector container where externalRepo schema-map is expected>\r
+        optional: true\r
+      - name: '<config map name contains schemas>'\r
+        type: configmap\r
+        mountPath: <path on VES collector container where externalRepo openAPI files are stored>\r
+        optional: true\r
+\r
+E.g:\r
+\r
+.. code-block:: yaml\r
+\r
+  dcae-ves-collector:\r
+    externalVolumes:\r
+      - name: 'dev-dcae-external-repo-configmap-schema-map'\r
+        type: configmap\r
+        mountPath: /opt/app/VESCollector/etc/externalRepo\r
+        optional: true\r
+      - name: 'dev-dcae-external-repo-configmap-sa91-rel16'\r
+        type: configmap\r
+        mountPath: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI\r
+        optional: true\r
+\r
+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.\r
+\r
+3. Upgrade release using following command:\r
+\r
+.. code-block:: bash\r
+\r
+  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>\r
+\r
+E.g:\r
+\r
+.. code-block:: bash\r
+\r
+  helm -n onap upgrade dev-dcaegen2-services --reuse-values -f values.yaml .\r
+\r
+\r
 Using external TLS certificates obtained using CMP v2 protocol\r
 --------------------------------------------------------------\r
 \r