diff options
| -rw-r--r-- | docs/sections/services/prh/architecture.rst | 15 | ||||
| -rw-r--r-- | docs/sections/services/prh/configuration.rst | 53 | ||||
| -rw-r--r-- | docs/sections/services/prh/delivery.rst | 9 | ||||
| -rw-r--r-- | docs/sections/services/prh/index.rst | 26 | ||||
| -rw-r--r-- | docs/sections/services/prh/installation.rst | 60 | ||||
| -rw-r--r-- | docs/sections/services/serviceindex.rst | 1 |
6 files changed, 164 insertions, 0 deletions
diff --git a/docs/sections/services/prh/architecture.rst b/docs/sections/services/prh/architecture.rst new file mode 100644 index 00000000..c47772a3 --- /dev/null +++ b/docs/sections/services/prh/architecture.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +PRH Architecture +=================== + +**PRH** is a new DCAE micro-service which participates in the Physical Network Function Plug and Play (PNF PnP) +procedure. PNF PnP is used to register PNF when it comes online. + +PRH Processing Flow +=================== + +.. image:: ../../images/prhAlgo.png + + diff --git a/docs/sections/services/prh/configuration.rst b/docs/sections/services/prh/configuration.rst new file mode 100644 index 00000000..a36ad953 --- /dev/null +++ b/docs/sections/services/prh/configuration.rst @@ -0,0 +1,53 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Configuration +============= + +PRH expects to be able to fetch configuration directly from consul service in following JSON format: + +.. code-block:: json + + { + "dmaap.dmaapProducerConfiguration.dmaapTopicName":"/events/unauthenticated.PNF_READY", + "dmaap.dmaapConsumerConfiguration.dmaapHostName":"message-router.onap.svc.cluster.local", + "aai.aaiClientConfiguration.aaiPnfPath":"/network/pnfs/pnf", + "aai.aaiClientConfiguration.aaiUserPassword":"AAI", + "dmaap.dmaapConsumerConfiguration.dmaapUserName":"admin", + "aai.aaiClientConfiguration.aaiBasePath":"/aai/v12", + "dmaap.dmaapConsumerConfiguration.timeoutMs":-1, + "dmaap.dmaapProducerConfiguration.dmaapPortNumber":3904, + "aai.aaiClientConfiguration.aaiHost":"aai.onap.svc.cluster.local", + "dmaap.dmaapConsumerConfiguration.dmaapUserPassword":"admin", + "dmaap.dmaapProducerConfiguration.dmaapProtocol":"http", + "aai.aaiClientConfiguration.aaiIgnoreSslCertificateErrors":true, + "dmaap.dmaapProducerConfiguration.dmaapContentType":"application/json", + "dmaap.dmaapConsumerConfiguration.dmaapTopicName":"/events/unauthenticated.VES_PNFREG_OUTPUT", + "dmaap.dmaapConsumerConfiguration.dmaapPortNumber":3904, + "dmaap.dmaapConsumerConfiguration.dmaapContentType":"application/json", + "dmaap.dmaapConsumerConfiguration.messageLimit":-1, + "dmaap.dmaapConsumerConfiguration.dmaapProtocol":"http", + "aai.aaiClientConfiguration.aaiUserName":"AAI", + "dmaap.dmaapConsumerConfiguration.consumerId":"c12", + "dmaap.dmaapProducerConfiguration.dmaapHostName":"message-router.onap.svc.cluster.local", + "aai.aaiClientConfiguration.aaiHostPortNumber":8443, + "dmaap.dmaapConsumerConfiguration.consumerGroup":"OpenDCAE-c12", + "aai.aaiClientConfiguration.aaiProtocol":"https", + "dmaap.dmaapProducerConfiguration.dmaapUserName":"admin", + "dmaap.dmaapProducerConfiguration.dmaapUserPassword":"admin" + } + + +There are also optional configuration parameters: + +.. code-block:: json + + "security": { + "keyFile": "/opt/app/prh/local/org.onap.prh.keyfile", + "trustStore": "/opt/app/prh/local/org.onap.prh.trust.jks", + "trustStorePassword": "change it", + "keyStore": "/opt/app/prh/local/org.onap.prh.p12", + "keyStorePassword": "change it", + "enableAaiCertAuth": "false", + "enableDmaapCertAuth": "false" + } diff --git a/docs/sections/services/prh/delivery.rst b/docs/sections/services/prh/delivery.rst new file mode 100644 index 00000000..3369376e --- /dev/null +++ b/docs/sections/services/prh/delivery.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Delivery +======== + +**PRH** is delivered as a docker container and published in ONAP Nexus repository in the following image naming convention. + +Full image name is `onap/org.onap.dcaegen2.services.prh.prh-app-server`.
\ No newline at end of file diff --git a/docs/sections/services/prh/index.rst b/docs/sections/services/prh/index.rst new file mode 100644 index 00000000..d8a22e21 --- /dev/null +++ b/docs/sections/services/prh/index.rst @@ -0,0 +1,26 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +PNF Registration Handler (PRH) +============================== + +.. Add or remove sections below as appropriate for the platform component. + +**PNF Registration Handler** is a micro-service in DCAE used during Physical Network Function (PNF) Plug-n-Play to process +the PNF Registration event. + + +PRH overview and functions +-------------------------- + + +.. toctree:: + :maxdepth: 1 + ./architecture.rst + ./configuration.rst + ./delivery.rst + ./installation.rst + + +.. _`Offered APIs`: ../../apis/prh.rst
\ No newline at end of file diff --git a/docs/sections/services/prh/installation.rst b/docs/sections/services/prh/installation.rst new file mode 100644 index 00000000..aa65dadf --- /dev/null +++ b/docs/sections/services/prh/installation.rst @@ -0,0 +1,60 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +Following docker-compose-yaml file shows default configuration and can be run using `docker compose up` command: + +.. code-block:: yaml + +version: '2' +services: + prh: + image: nexus3.onap.org:10003/onap/org.onap.dcaegen2.services.prh.prh-app-server + command: > + --dmaap.dmaapConsumerConfiguration.dmaapHostName=10.42.111.36 + --dmaap.dmaapConsumerConfiguration.dmaapPortNumber=8904 + --dmaap.dmaapConsumerConfiguration.dmaapTopicName=/events/unauthenticated.SEC_OTHER_OUTPUT + --dmaap.dmaapConsumerConfiguration.dmaapProtocol=http + --dmaap.dmaapConsumerConfiguration.dmaapUserName=admin + --dmaap.dmaapConsumerConfiguration.dmaapUserPassword=admin + --dmaap.dmaapConsumerConfiguration.dmaapContentType=application/json + --dmaap.dmaapConsumerConfiguration.consumerId=c12 + --dmaap.dmaapConsumerConfiguration.consumerGroup=OpenDCAE-c12 + --dmaap.dmaapConsumerConfiguration.timeoutMS=-1 + --dmaap.dmaapConsumerConfiguration.message-limit=-1 + --dmaap.dmaapProducerConfiguration.dmaapHostName=10.42.111.36 + --dmaap.dmaapProducerConfiguration.dmaapPortNumber=8904 + --dmaap.dmaapProducerConfiguration.dmaapTopicName=/events/unauthenticated.PNF_READY + --dmaap.dmaapProducerConfiguration.dmaapProtocol=http + --dmaap.dmaapProducerConfiguration.dmaapUserName=admin + --dmaap.dmaapProducerConfiguration.dmaapUserPassword=admin + --dmaap.dmaapProducerConfiguration.dmaapContentType=application/json + --aai.aaiClientConfiguration.aaiHostPortNumber=30233 + --aai.aaiClientConfiguration.aaiHost=10.42.111.45 + --aai.aaiClientConfiguration.aaiProtocol=https + --aai.aaiClientConfiguration.aaiUserName=admin + --aai.aaiClientConfiguration.aaiUserPassword=admin + --aai.aaiClientConfiguration.aaiIgnoreSSLCertificateErrors=true + --aai.aaiClientConfiguration.aaiBasePath=/aai/v11 + --aai.aaiClientConfiguration.aaiPnfPath=/network/pnfs/pnf + entrypoint: + - java + - -Dspring.profiles.active=dev + - -jar + - /opt/prh-app-server.jar + ports: + - "8100:8100" + - "8433:8433" + restart: always + + +Running with dev-mode of PRH +============================== + +Heartbeat: http://<container_address>:8100/heartbeat or https://<container_address>:8443/heartbeat + +Start prh: http://<container_address>:8100/start or https://<container_address>:8433/start + +Stop prh: http://<container_address>:8100/stopPrh or https://<container_address>:8433/stopPrh
\ No newline at end of file diff --git a/docs/sections/services/serviceindex.rst b/docs/sections/services/serviceindex.rst index ff6e9516..5cde2603 100644 --- a/docs/sections/services/serviceindex.rst +++ b/docs/sections/services/serviceindex.rst @@ -14,3 +14,4 @@ Service components under DCAE ./ves-http/index.rst ./ves-hv/index.rst ./mapper/index.rst + ./prh/index.rst |