diff options
| -rw-r--r-- | docs/sections/dcaeservice_helm_template.rst | 161 | ||||
| -rw-r--r-- | docs/sections/images/dmaap_provisioning.png | bin | 0 -> 74415 bytes | |||
| -rw-r--r-- | docs/sections/images/dmaap_provisioning_architecture_diagram.drawio | 1 | ||||
| -rw-r--r-- | docs/sections/installation_oom.rst | 2 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 5 | ||||
| -rw-r--r-- | docs/sections/services/ves-http/installation-helm.rst | 3 |
6 files changed, 169 insertions, 3 deletions
diff --git a/docs/sections/dcaeservice_helm_template.rst b/docs/sections/dcaeservice_helm_template.rst index 1379d557..a59d7359 100644 --- a/docs/sections/dcaeservice_helm_template.rst +++ b/docs/sections/dcaeservice_helm_template.rst @@ -463,4 +463,163 @@ If a component is using an external certificate (CMPv2), the override file would correct common name/SAN. Also note that if the chart for ``dcae-ves-collector`` has been pushed into a Helm repository, the ``helm install`` command can refer to the -repository (for instance, ``local/dcae-ves-collector``) instead of using the chart on the local filesystem.
\ No newline at end of file +repository (for instance, ``local/dcae-ves-collector``) instead of using the chart on the local filesystem. + + +Dynamic Topic and Feed Provisioning +----------------------------------- +This section introduces details on creation of dynamic Dmaap Topics in Message Router and Feeds in Data Router via DCAE helm charts. + +Provisioning support through DCAE common-service template +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When using DCAE common-service template in microservice chart ``deployment.yaml`` file it is required to include ``dcaegen2-services-common.microserviceDeployment`` template. +The dcaegen2-services-common include necessary ``common.dmaap.provisioning.initContainer`` template which provisions topics and feeds on Dmaap Message Router and Data Router. + +Example : Including ``dcaegen2-services-common.microserviceDeployment`` template in ``deployment.yaml``. + +:: + + {{ include "dcaegen2-services-common.microserviceDeployment" . }} + +The ``common.dmaap.provisioning.initContainer`` template included in DCAE ``dcaegen2-services-common.microserviceDeployment`` makes use of +dmaap-bc client image to create Topics on Message Router and Feeds on Data Router microservice, with the help of ``dbc-client.sh`` script, +it uses Bus Controller REST API to create resources. + +If the resource creation is successful via script, the response is logged in file with appropriate naming convention. + +.. note:: + The configuration provided via ``values.yaml`` file, is consumed by ``common.dmaap.provisioning.initContainer`` template which runs two + init-container, First named init-dmaap-provisioning for creating resources on Dmaap, Second named init-merge-config which updates application config + with response generated as an outcome of operation by init-dmaap-provisioning container. + +The figure below shows Dmaap Topics, Feeds Provisioning architecture via dcae-service-common helm charts. + +.. + The following diagram has been created on https://app.diagrams.net/. There is an editable version of the diagram + in repository under path docs/sections/images/dmaap_provisioning_architecture_diagram.drawio, import file to update diagram. + +.. image:: images/dmaap_provisioning.png + +Configuration to be added in ``values.yaml`` file. + +.. note:: + For more information on attributes that are set in ``values.yaml`` for Data Router Feed, Publisher and Subscriber, Message Router Topic creation, + you can refer DMaaP Bus Controller API documentation at: https://docs.onap.org/projects/onap-dmaap-buscontroller/en/latest/apis/api.html + +Dmaap Data Router Feeds creation input can be provided in below format. It consumes list of Feeds. + +.. note:: + For DR Feed creation except ``feedName``, ``feedDescription``, ``feedVersion`` avoid update on other attributes. + All other attributes are mandatory, contains required default values. + +:: + + drFeedConfig: + - feedName: bulk_pm_feed + owner: dcaecm + feedVersion: 0.0 + asprClassification: unclassified + feedDescription: DFC Feed Creation + +Once the Feeds creation is successful we can attach Publisher and Subscriber to Feeds. + +Dmaap Data Router Publisher config: + +.. note:: + For DR Publisher creation except ``feedName`` avoid update on other attribute. + All other attributes are mandatory, contains required default values. + +:: + + drPubConfig: + - feedName: bulk_pm_feed + dcaeLocationName: loc00 + +Dmaap Data Router Subscriber config: + +.. note:: + For DR Subscriber creation except ``feedName`` avoid update on other attributes. + Attribute username, userpwd will be updated via init-merge-config init-container of ``common.dmaap.provisioning.initContainer`` template. + In case dcae-pm-mapper microservice is not the Subscriber, attribute deliveryURL need to be updated and privilegedSubscriber can be updated to False. + All other attributes are mandatory, contains required default values. + +:: + + drSubConfig: + - feedName: bulk_pm_feed + decompress: True + username: ${DR_USERNAME} + userpwd: ${DR_PASSWORD} + dcaeLocationName: loc00 + privilegedSubscriber: True + deliveryURL: https://dcae-pm-mapper:8443/delivery + +Dmaap Message Router Topics creation input can be provided in below format. It consumes list of Topics. +Also we can attach Message Router Publisher and Subscriber at same time while creation of Topic. + +.. note:: + For Message Router Topic creation except ``topicName`` and ``topicDescription`` avoid update on other attributes. + All other attributes are mandatory, contains required default values. + +:: + + mrTopicsConfig: + - topicName: PERFORMANCE_MEASUREMENTS + topicDescription: Description about Topic + owner: dcaecm + tnxEnabled: false + clients: + - dcaeLocationName: san-francisco + clientRole: org.onap.dcae.pmPublisher + action: + - pub + - view + +Volume configuration for configMap to be provided in ``values.yaml`` file. + +:: + + volumes: + - name: feeds-config + path: /opt/app/config/feeds + - name: drpub-config + path: /opt/app/config/dr_pubs + - name: drsub-config + path: /opt/app/config/dr_subs + - name: topics-config + path: /opt/app/config/topics + + +For example directory containing ``dcae-datafile-collector``, ``dcae-pm-mapper`` chart under +dcaegen2-services in OOM repository we can find examples for Feed and Topic creation. + +Provisioning support through DCAE When using custom deployment.yaml +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When using custom ``deployment.yaml`` it is required explicitly to include ``common.dmaap.provisioning.initContainer`` template in +initContainer specs of ``deployment.yaml`` file. + +Example : Including ``common.dmaap.provisioning.initContainer`` template in ``deployment.yaml`` file. + +:: + + {{- include "common.dmaap.provisioning.initContainer" . | nindent XX }} + +Note also need to take care of the ``Volumes`` that are required to be mounted on Application Pod in ``deployment.yaml``. + +:: + + {{- include "common.dmaap.provisioning._volumes" . | nindent XX -}} + +Configuration to be added in ``values.yaml`` file is similar to described in ``Provisioning support through DCAE common-service template``. + +Removal of Data Router Feed, Publisher and Subscriber Or Message Router Topic +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +DCAE does not support automatic removal of Feed, Publisher and Subscriber from Data Router or Topic from Message Router at present. +So it is the responsibility of operator to manually remove Feeds and associated Publisher or Subscriber from Data Router and Topics +from Message Router after uninstalling microservice charts which created resources on installation. + +Reference to DMAAP Bus Controller API documentation to figure out steps for manual removal of resources. +https://docs.onap.org/projects/onap-dmaap-buscontroller/en/latest/apis/api.html diff --git a/docs/sections/images/dmaap_provisioning.png b/docs/sections/images/dmaap_provisioning.png Binary files differnew file mode 100644 index 00000000..44523d61 --- /dev/null +++ b/docs/sections/images/dmaap_provisioning.png diff --git a/docs/sections/images/dmaap_provisioning_architecture_diagram.drawio b/docs/sections/images/dmaap_provisioning_architecture_diagram.drawio new file mode 100644 index 00000000..84811e83 --- /dev/null +++ b/docs/sections/images/dmaap_provisioning_architecture_diagram.drawio @@ -0,0 +1 @@ +<mxfile host="wiki.onap.org" modified="2021-07-21T12:29:36.174Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36" etag="DluRCvCppGvkMgnA6wmF" version="13.2.3" type="atlas"><mxAtlasLibraries/><diagram id="F1Bre9ZVPEtWtABPQS02" name="Page-1">7VxZe5s4FP01fsQfEqsfXTtpZ6ZLvmZmMp03ATKmxYiCnNjz60cCsVp2SAM4m/NguJIA33PuoiuRibbY7N4nKF5/Ih4OJ1D1dhNtOYEQWJbKvrhkLyRAM3OJnwSekFWC6+A/LIRioL8NPJw2OlJCQhrETaFLogi7tCFDSULumt1WJGzeNUa+uKNaCa5dFOKDbjeBR9e51DZqvT/gwF8XdwaqaNmgorMQpGvkkbuaSLuYaIuEEJofbXYLHHLtFXrJx10eaS0fLMER7TKAOuHvbvBznqz9dPZpphOs/KuIq9yicCt+sHhYui80kJBt5GF+EXWivbtbBxRfx8jlrXcMdCZb003IzgA7XAVhuCAhSbKx2srgf0ye0oT8wLUWM/vwESSiNXn+YfLDn1c8K04o3tVE4ue+x2SDabJnXUSrohW6F+xTdHF+V0EJ1EK4ruFoaUKIBH/88uqVitmB0PIDNA6H1biHsL1ypRp3beys+tGseahHE0rUaJpDqVF7CWpU4KxJUM0+VKwmUyy0h1Ks/qI9AjSaCteBNTUOVA5lLgGqxkAqNyQqN0MqVNHQvflzS4oGJc2i5Zx1AHa8qxrZkS++s6s4hcDbIBQrjls0sKd12p2ZLL9rIW6BzzRNmwg3kYxIhFuwCxEKAz9ipy7DDzP5O45bwELtXDRsAs/jt5FSqkk6/ogiWYBqT9wALWM0gCxaSJkxEDHMxxND70SMG5L8YJBA9TPL4NiXAvulSK/QNx2KAzxvpcocClAtbYZH9NQAjEkOayxyXBFvSIfBkFJV82J+eYgtcBDAcADXUQ9I2WfU8KKNSRN7LJr8Yaes8yLcphyiYQlTmvYxZ9AnYfogRpeZyGxMWsxecprX8tXAOlS2YUi0rQ82XSkiwxlCOXgL5a2569SEZ47dQFZ3eQveZw3eHZzGqIEbWgdoYM/H1+KUJHRNfBKh8KKStrRV9flISCwA/I4p3Yu5E9pS0oQX7wL6jxjOj7/x46khzpa7WtNyX5xE7Pdmg6a6BgsBH6moU1U1Ckk1OjtrDL/CScD0xvkhcw3sKipeyekHlu8WpyiQkm3i4hOaBqLmQVHiY3qioyg6cRhOMirBIaLBbbOE3D9B7HMSBPwKQUCdHGLUCWY8SRKAWd8syIbOkwTtax1iEkQ0rV35igvqYazpr1hGU2fUvf0N024xMH+Cio/lT3lEnBu4mugZ2PZ0GSNs6GhZmtlDZAB6S9WaJDTIsndjsNgwe3amX7P2bw1jl5t+yuyQzvkCHs8cQpSmgVuIL4OwfKTIKzqJKiOTiHaJB/FslWWSMr7MDZUvBD3KgxjPy4MYdqukdY8Hafc3VPVkf900TvUfxuMUpvmcsqaHBcWGZQjS181CbZpFZTuVZUg86bCxtbNlWE8qwwKylZlnH760s4cvIFvYePZ61SGUFXvH1axsVaCl2XSNYn7o7sOAqTi5X71OjsVHpxQg94efIfRlS9lV8FPCwZDt8pCiMNSCLuhQXX1pKGjWU0MBHq+5HtTBHrfQnq2rcwUm5DZIAxIFkc+fLgqo4rILIIZNcrTkJqvOPbAMN86iex+22sohoS5bHhu1zNZDKbbb7ovmZQVzXMSL9BvMEiMmQxuu9chJ48mJGu3xcu7Je2V07PuijN6rwP9Flj+nHScDkF+TkH/cVcAiLp2V/CiOQwYKZX6zb3a+8bITL1tLH7om3RQ3KjM1cKDvMefx5dy9rFU9uMJV1rpHnccPWuGCYgHk/nm8mOA9kXk8lO0WbrkP5oWUPJi9soysvetRkrdb2tQyxgxLsmWD9l5Wx1USnMYkSrHiIneNXxduens9R5JMAL2sSNRxA4Phdnwn86/PuKT7HC42MeXK8AIW2dW/Sbjd4AeF+JdKC2BV21vKlT7JTBzaUpMe7rWX43uZ36gxlscwp7Z1VmogXbmca++/w+XyN2uJTPXzzSfpO2gtZnygNOa7S6++XP/Jvr7in1ucco6wBI4hLcovzpb34Sl/QsIw2wR3dPvTvSA/MfBYStWqnMCO9bXBcDs+dyz1/FUE6EzZJGEK4VWxSfYyZH5227bPV2CIhtaCEsgWDqQ7EquZWe9wdsiRv2LEMUORV9Ws+PQ9t7osdV5we+RvGKkV9q8JW731BkC5/FNHdqh9hFJcO+TSf8Ueopk55o60ALNltPUp0qs0XAA7gGuNCW6HhPsyiFDYRi9GaZoBy2tuIoqW1bhXBuphxqzLXu6SvxP6YFzZafXOf77rpfrXCdrF/w==</diagram></mxfile>
\ No newline at end of file diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst index 7b4be666..cc5538af 100644 --- a/docs/sections/installation_oom.rst +++ b/docs/sections/installation_oom.rst @@ -57,8 +57,10 @@ The dcaegen2 chart has the following sub-charts: The dcaegen2-services chart has the following sub-charts: +* ``dcae-datafile-collector``: deploys the DCAE DataFile Collector service. * ``dcae-hv-ves-collector``: deploys the DCAE High-Volume VES collector service. * ``dcae-ms-healthcheck``: deploys a health check component that tests the health of the 4 DCAE services deployed via Helm. +* ``dcae-pm-mapper``: deploys the DCAE PM-Mapper service. * ``dcae-prh``: deploys the DCAE PNF Registration Handler service. * ``dcae-tcagen2``: deploys the DCAE TCA analytics service. * ``dcae-ves-collector``: deploys the DCAE VES collector service. diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index 6d153258..116e9966 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -44,7 +44,7 @@ Release Data | | | +--------------------------------------+--------------------------------------+ | **Docker images** | onap/org.onap.ccsdk.dashboard. | -| | .ccsdk-app-os:1.4.3 | +| | .ccsdk-app-os:1.4.4 | +--------------------------------------+--------------------------------------+ | **Release designation** | Honolulu Maintenance Release | | | | @@ -62,7 +62,8 @@ None - `DCAEGEN2-2751 <https://jira.onap.org/browse/DCAEGEN2-2751>`_ Dashboard login issue due to oom/common PG upgrade to centos8-13.2-4.6.1 - `CCSDK-3233 <https://jira.onap.org/browse/CCSDK-3233>`_ Switch to integration base image & vulnerability updates fixes - +- `DCAEGEN2-2800 <https://jira.onap.org/browse/DCAEGEN2-2800>`_ DCAE Healthcheck failure due to Dashboard +- `DCAEGEN2-2869 <https://jira.onap.org/browse/DCAEGEN2-2869>`_ Fix PRH aai lookup url config **Known Issues** diff --git a/docs/sections/services/ves-http/installation-helm.rst b/docs/sections/services/ves-http/installation-helm.rst index 9728e64b..d97cd1c6 100644 --- a/docs/sections/services/ves-http/installation-helm.rst +++ b/docs/sections/services/ves-http/installation-helm.rst @@ -55,6 +55,9 @@ 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>`_
+
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:
|
