summaryrefslogtreecommitdiffstats
path: root/docs/sections/services
diff options
context:
space:
mode:
authorVijay Venkatesh Kumar <vv770d@att.com>2021-10-21 16:10:57 -0400
committerVijay Venkatesh Kumar <vv770d@att.com>2021-10-21 17:42:02 -0400
commit860e0a85019304218f7e9993f280b62c78db703e (patch)
treea65d4b22cf1f0032604c3ce71ace0e75afcab4e0 /docs/sections/services
parent28cbc29d8cdcf7dbf530110360cc5f23fd7a2c73 (diff)
VES Schema references updated to SA88-Rel16
Change-Id: If8f4cb6f1923c6ffe9c03222e3c12da9abf5d071 Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Issue-ID: DCAEGEN2-2895 Issue-ID: DCAEGEN2-2893 Issue-ID: DCAEGEN2-2894 Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com>
Diffstat (limited to 'docs/sections/services')
-rw-r--r--docs/sections/services/ves-http/installation-helm.rst13
-rw-r--r--docs/sections/services/ves-http/stnd-defined-validation.rst18
2 files changed, 17 insertions, 14 deletions
diff --git a/docs/sections/services/ves-http/installation-helm.rst b/docs/sections/services/ves-http/installation-helm.rst
index d97cd1c6..d5f6bdd6 100644
--- a/docs/sections/services/ves-http/installation-helm.rst
+++ b/docs/sections/services/ves-http/installation-helm.rst
@@ -52,11 +52,14 @@ For VES Collector:
.. _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.
-.. note::
- For more information on generating schema files, see `External-schema-repo-generator (OOM Utils repository) <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=tree;f=external-schema-repo-generatore>`_
+.. note::
+ For more information on generating schema files, see `External-schema-repo-generator (OOM Utils repository) <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=tree;f=external-schema-repo-generator>`_
+
+ Default ONAP deployment for Istanbul release makes available the SA88-Rel16 OpenAPI schema files; optionally SA99-Rel16 files can be loaded using the `Generator script <https://gerrit.onap.org/r/gitweb?p=oom/utils.git;a=blob;f=external-schema-repo-generator/generator/generate.sh>`_ based on the steps documented in `README <https://git.onap.org/oom/utils/tree/external-schema-repo-generator/README.md>`_
+
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:
@@ -84,9 +87,9 @@ E.g:
type: configmap
mountPath: /opt/app/VESCollector/etc/externalRepo
optional: true
- - name: 'dev-dcae-external-repo-configmap-sa91-rel16'
+ - name: 'dev-dcae-external-repo-configmap-sa88-rel16'
type: configmap
- mountPath: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI
+ mountPath: /opt/app/VESCollector/etc/externalRepo/3gpp/rep/sa5/MnS/blob/SA88-Rel16/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.
diff --git a/docs/sections/services/ves-http/stnd-defined-validation.rst b/docs/sections/services/ves-http/stnd-defined-validation.rst
index 576b60fc..9e6f2992 100644
--- a/docs/sections/services/ves-http/stnd-defined-validation.rst
+++ b/docs/sections/services/ves-http/stnd-defined-validation.rst
@@ -48,20 +48,20 @@ Format of the schema mapping file is a JSON file with list of mappings, as shown
[
{
- "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/faultMnS.yaml",
- "localURL": "3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/faultMnS.yaml"
+ "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/faultMnS.yaml",
+ "localURL": "3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/faultMnS.yaml"
},
{
- "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/FileDataReportingMnS.yaml",
- "localURL": "3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/FileDataReportingMnS.yaml"
+ "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/heartbeatNtf.yaml",
+ "localURL": "3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/heartbeatNtf.yaml"
},
{
- "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/heartbeatNtf.yaml",
- "localURL": "3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/heartbeatNtf.yaml"
+ "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/PerDataFileReportMnS.yaml",
+ "localURL": "3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/PerDataFileReportMnS.yaml"
},
{
- "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/provMnS.yaml",
- "localURL": "3gpp/rep/sa5/MnS/blob/Rel-16-SA-91/OpenAPI/provMnS.yaml"
+ "publicURL": "https://forge.3gpp.org/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/provMnS.yaml",
+ "localURL": "3gpp/rep/sa5/MnS/blob/SA88-Rel16/OpenAPI/provMnS.yaml"
}
]
@@ -76,7 +76,7 @@ The mapping and schema files content can be changed by editing a proper config m
+==============================================+=====================================================================================================+
| dcae-external-repo-configmap-schema-map | Defines a content of the /opt/app/VESCollector/etc/externalRepo/schema-map.json file. |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------+
-| dcae-external-repo-configmap-sa91-rel16 | Defines a content of schemas stored in the /opt/app/VESCollector/etc/externalRepo folder. |
+| dcae-external-repo-configmap-sa88-rel16 | Defines a content of schemas stored in the /opt/app/VESCollector/etc/externalRepo folder. |
+----------------------------------------------+-----------------------------------------------------------------------------------------------------+
Config maps are defined in the `OOM <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2-services/resources/external>`_ repository