summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/prh
diff options
context:
space:
mode:
authorHansen, Tony (th1395) <th1395@att.com>2023-05-23 21:27:17 +0000
committerHansen, Tony (th1395) <th1395@att.com>2023-05-31 21:01:29 +0000
commit663df2c1b8d9176094a62b00b7e80de096180621 (patch)
tree849841dc428fcfba07d9c39494f95ccd1f25da8a /docs/sections/services/prh
parentbcd436a1be4fbe2c8ad7ce074d86b94b8ff44f4e (diff)
clean up some sphinx warnings
Change-Id: I8c2d925e8b27b4740227af0be3ab5d6f7153ec38 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Issue-ID: DCAEGEN2-3399 Signed-off-by: Hansen, Tony (th1395) <th1395@att.com> Signed-off-by: Vijay Venkatesh Kumar <vv770d@att.com> Signed-off-by: Hansen, Tony (th1395) <th1395@att.com>
Diffstat (limited to 'docs/sections/services/prh')
-rw-r--r--docs/sections/services/prh/architecture.rst4
-rw-r--r--docs/sections/services/prh/authorization.rst10
-rw-r--r--docs/sections/services/prh/configuration.rst5
-rw-r--r--docs/sections/services/prh/delivery.rst2
-rw-r--r--docs/sections/services/prh/installation.rst7
5 files changed, 12 insertions, 16 deletions
diff --git a/docs/sections/services/prh/architecture.rst b/docs/sections/services/prh/architecture.rst
index 32314984..6ac68015 100644
--- a/docs/sections/services/prh/architecture.rst
+++ b/docs/sections/services/prh/architecture.rst
@@ -12,7 +12,5 @@ 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.
+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/authorization.rst b/docs/sections/services/prh/authorization.rst
index d1fb8f2d..14e4091b 100644
--- a/docs/sections/services/prh/authorization.rst
+++ b/docs/sections/services/prh/authorization.rst
@@ -21,9 +21,9 @@ Default
Certificate-based
"""""""""""""""""
| There is an option to enable certificate-based authentication for PRH towards AAI service calls.
-| To achieve this secure flag needs to be turned on in PRH :ref:`configuration<prh_configuration>` :
+| To achieve this secure flag needs to be turned on in PRH :ref:`configuration <prh_configuration>` :
-.. code-block:: json
+.. code-block:: bash
security.enableAaiCertAuth=true
@@ -39,9 +39,9 @@ Default
Certificate-based
""""""""""""""""""
| There is an option to enable certificate-based authentication for PRH towards DMaaP Bus Controller service calls.
-| To achieve this secure flag needs to be turned on in PRH :ref:`configuration<prh_configuration>` :
+| To achieve this secure flag needs to be turned on in PRH :ref:`configuration <prh_configuration>` :
-.. code-block:: json
+.. code-block:: bash
--security.enableDmaapCertAuth=true
@@ -55,7 +55,7 @@ PRH identity and certificate data
| See :doc:`../../tls_enablement` for detailed information.
|
| PRH is using four files from ``tls-info`` DCAE volume (``cert.jks, jks.pass, trust.jks, trust.pass``).
-| Refer :ref:`configuration<prh_configuration>` for proper security attributes settings.
+| Refer :ref:`configuration <prh_configuration>` for proper security attributes settings.
|
| **IMPORTANT** Even when certificate-based authentication security features are disabled,
| still all security settings needs to be provided in configuration to make PRH service start smoothly.
diff --git a/docs/sections/services/prh/configuration.rst b/docs/sections/services/prh/configuration.rst
index 560c08c8..832611d4 100644
--- a/docs/sections/services/prh/configuration.rst
+++ b/docs/sections/services/prh/configuration.rst
@@ -1,6 +1,7 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. _prh_configuration:
Configuration
=============
@@ -67,11 +68,10 @@ 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:
+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
@@ -92,4 +92,3 @@ For PRH 1.9.0 version (London) , a new mode has been introduced which allows ear
secretKeyRef:
key: sasl.jaas.config
name: strimzi-kafka-admin
-
diff --git a/docs/sections/services/prh/delivery.rst b/docs/sections/services/prh/delivery.rst
index 63a744f7..53e9faad 100644
--- a/docs/sections/services/prh/delivery.rst
+++ b/docs/sections/services/prh/delivery.rst
@@ -6,4 +6,4 @@ Delivery
**PRH** is delivered as a docker container. It is published in ONAP Nexus repository.
-Full image name is `onap/org.onap.dcaegen2.services.prh.prh-app-server`. \ No newline at end of file
+Full image name is `onap/org.onap.dcaegen2.services.prh.prh-app-server`.
diff --git a/docs/sections/services/prh/installation.rst b/docs/sections/services/prh/installation.rst
index e73fae6a..6f591e79 100644
--- a/docs/sections/services/prh/installation.rst
+++ b/docs/sections/services/prh/installation.rst
@@ -154,9 +154,9 @@ 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:
+
+
+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
@@ -181,4 +181,3 @@ For PRH 1.9.0 version (London) , a new mode has been introduced which allows ear
secretKeyRef:
key: sasl.jaas.config
name: strimzi-kafka-admin
-