From 7dcdb641d749496cf8178e8a9b2178684595eebe Mon Sep 17 00:00:00 2001 From: "sangeeta.bellara" Date: Sat, 29 Apr 2023 15:15:12 +0530 Subject: Documentation for new PRH feature to handle early registration onap-gerrit-review: -changelog-or-release-file-missing onap-gerrit-review: -changelog-missing onap-gerrit-review: -missing-setup-py onap-gerrit-review: -no-nl-ending-on-files Issue-ID: DCAEGEN2-3387 Change-id: 9470749204 Signed-off-by: Sangeeta Bellara Change-Id: Ifaf20eb16eeb1497aa1926fc15b5f63298b5364b --- docs/sections/services/prh/architecture.rst | 3 +++ docs/sections/services/prh/configuration.rst | 28 ++++++++++++++++++++++- docs/sections/services/prh/installation.rst | 33 +++++++++++++++++++++++++--- 3 files changed, 60 insertions(+), 4 deletions(-) (limited to 'docs/sections/services') diff --git a/docs/sections/services/prh/architecture.rst b/docs/sections/services/prh/architecture.rst index f0703a71..32314984 100644 --- a/docs/sections/services/prh/architecture.rst +++ b/docs/sections/services/prh/architecture.rst @@ -12,4 +12,7 @@ PRH Processing Flow .. image:: ../../images/prhAlgo.png +In London release, a new mode has been introduced which allows a PNF to send the registration event early, before SO registers the PNF in AAI. A timeout can be configured for the time until such an event is considered valid (default set to 1 day). When PRH receives such an event, and does not find the corresponding PNF in AAI, it will retry the check in AAI till either the PNF is found in AAI, or the timeout occurs (whichever is earlier).This does not block the processing of any events received after such a non-correlated event. +This mode is not the default mode in which PRH is installed, and has to enabled in the PRH Helm chart. Since it uses a native Kafka consumer and not DMAAP consumer, certain Kafka and Strimzi related configurable parameters are required, as described in the Configuration section. + diff --git a/docs/sections/services/prh/configuration.rst b/docs/sections/services/prh/configuration.rst index 5bdc423c..560c08c8 100644 --- a/docs/sections/services/prh/configuration.rst +++ b/docs/sections/services/prh/configuration.rst @@ -1,7 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _prh_configuration: Configuration ============= @@ -67,3 +66,30 @@ PRH fetches configuration directly from CBS service in the following JSON format } The configuration is created from PRH helm charts by specifying **applicationConfig** during ONAP OOM/Kubernetes deployment. + +For PRH 1.9.0 version (London) , a new mode has been introduced which allows early PNF registrations. This mode uses a direct Kafka consumer and not the DMAAP consumer. This mode is not the default mode and has to be activated by setting certain environment variables in the Helm chart values.yaml file under **applicationEnv**, as shown below: + +.. code-block:: yaml + + + - name: kafkaBoostrapServerConfig + value: onap-strimzi-kafka-bootstrap:9092 + - name: groupIdConfig + value: OpenDCAE-c12 + - name: kafkaUsername + value: strimzi-kafka-admin + - name: kafkaPassword + valueFrom: + secretKeyRef: + key: password + name: strimzi-kafka-admin + - name: kafkaTopic + value: unauthenticated.VES_PNFREG_OUTPUT + - name: SPRING_PROFILES_ACTIVE + value: autoCommitDisabled + - name: JAAS_CONFIG + valueFrom: + secretKeyRef: + key: sasl.jaas.config + name: strimzi-kafka-admin + diff --git a/docs/sections/services/prh/installation.rst b/docs/sections/services/prh/installation.rst index eea0d3b6..e73fae6a 100644 --- a/docs/sections/services/prh/installation.rst +++ b/docs/sections/services/prh/installation.rst @@ -1,6 +1,5 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -.. _prh-installation: Docker Installation @@ -76,7 +75,7 @@ The PRH microservice can be deployed using helm charts in the oom repository. Deployment steps -~~~~~~~~~~~~~~~~ +================ - Default app config values can be updated in oom/kubernetes/dcaegen2-services/components/dcae-prh/values.yaml. @@ -101,7 +100,7 @@ Deployment steps helm uninstall dev-dcae-prh Application Configurations --------------------------- +========================== Supported configuration modifiable in HELM charts under **applicationConfig** section. @@ -155,3 +154,31 @@ Supported configuration modifiable in HELM charts under **applicationConfig** se The location of the configuration file should be set in ``CBS_CLIENT_CONFIG_PATH`` env, for example: ``CBS_CLIENT_CONFIG_PATH: /app-config-input/application_config.yaml`` + + +For PRH 1.9.0 version (London) , a new mode has been introduced which allows early PNF registrations. This mode uses a direct Kafka consumer and not the DMAAP consumer. This mode is not the default mode and has to be activated by setting certain environment variables in the Helm chart values.yaml file under **applicationEnv**, as shown below: + +.. code-block:: yaml + + + - name: kafkaBoostrapServerConfig + value: onap-strimzi-kafka-bootstrap:9092 + - name: groupIdConfig + value: OpenDCAE-c12 + - name: kafkaUsername + value: strimzi-kafka-admin + - name: kafkaPassword + valueFrom: + secretKeyRef: + key: password + name: strimzi-kafka-admin + - name: kafkaTopic + value: unauthenticated.VES_PNFREG_OUTPUT + - name: SPRING_PROFILES_ACTIVE + value: autoCommitDisabled + - name: JAAS_CONFIG + valueFrom: + secretKeyRef: + key: sasl.jaas.config + name: strimzi-kafka-admin + -- cgit 1.2.3-korg