X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fsections%2Fservices%2Fprh%2Finstallation.rst;fp=docs%2Fsections%2Fservices%2Fprh%2Finstallation.rst;h=eea0d3b67832758a4a1fbd7de72b7999f4560545;hb=a6f72a8f1c7bd93ca5916cd73d4226208ff469d3;hp=3334025b21ca1efb0d08115970fce6fb14e2505f;hpb=74d53a77e5d74c921cfbc034a01f2cbf08e102a4;p=dcaegen2.git diff --git a/docs/sections/services/prh/installation.rst b/docs/sections/services/prh/installation.rst index 3334025b..eea0d3b6 100644 --- a/docs/sections/services/prh/installation.rst +++ b/docs/sections/services/prh/installation.rst @@ -3,8 +3,8 @@ .. _prh-installation: -Installation -============ +Docker Installation +=================== The following docker-compose-yaml file shows a default configuration. The file can be run using `docker compose up` command: @@ -65,4 +65,93 @@ Heartbeat: http://:8100/heartbeat or https://:8100/start or https://:8433/start -Stop prh: http://:8100/stopPrh or https://:8433/stopPrh \ No newline at end of file +Stop prh: http://:8100/stopPrh or https://:8433/stopPrh + + + +Helm Installation +================= + +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. + +- Make the chart and deploy using the following command: + + .. code-block:: bash + + cd oom/kubernetes/ + make dcaegen2-services + helm install dev-dcaegen2-services dcaegen2-services --namespace --set global.masterPassword= + +- To deploy only PRH: + + .. code-block:: bash + + helm install dev-dcae-prh dcaegen2-services/components/dcae-prh --namespace --set global.masterPassword= + +- To Uninstall + + .. code-block:: bash + + helm uninstall dev-dcae-prh + +Application Configurations +-------------------------- + +Supported configuration modifiable in HELM charts under **applicationConfig** section. + +.. code-block:: yaml + + applicationConfig: + dmaap.dmaapConsumerConfiguration.dmaapContentType: "application/json" + dmaap.dmaapConsumerConfiguration.consumerId: "c12" + dmaap.dmaapConsumerConfiguration.consumerGroup: "OpenDCAE-c12" + dmaap.dmaapConsumerConfiguration.timeoutMs: -1 + dmaap.dmaapProducerConfiguration.dmaapContentType: "application/json" + dmaap.dmaapUpdateProducerConfiguration.dmaapContentType: "application/json" + aai.aaiClientConfiguration.pnfUrl: http://aai-internal.onap.svc.cluster.local:80/aai/v23/network/pnfs/pnf + aai.aaiClientConfiguration.baseUrl: http://aai-internal.onap.svc.cluster.local:80/aai/v23 + aai.aaiClientConfiguration.aaiHost: aai-internal.onap.svc.cluster.local + aai.aaiClientConfiguration.aaiHostPortNumber: 80 + aai.aaiClientConfiguration.aaiProtocol: "http" + aai.aaiClientConfiguration.aaiUserName: ${AAI_USER} + aai.aaiClientConfiguration.aaiUserPassword: ${AAI_PASSWORD} + aai.aaiClientConfiguration.aaiIgnoreSslCertificateErrors: true + aai.aaiClientConfiguration.aaiBasePath: "/aai/v23" + aai.aaiClientConfiguration.aaiPnfPath: "/network/pnfs/pnf" + aai.aaiClientConfiguration.aaiServiceInstancePath: "/business/customers/customer/{{customer}}/service-subscriptions/service-subscription/{{serviceType}}/service-instances/service-instance/{{serviceInstanceId}}" + aai.aaiClientConfiguration.aaiHeaders: + X-FromAppId: "prh" + X-TransactionId: "9999" + Accept: "application/json" + Real-Time: "true" + Authorization: ${AUTH_HDR} + security.trustStorePath: "/opt/app/prh/etc/cert/trust.jks" + security.trustStorePasswordPath: "/opt/app/prh/etc/cert/trust.pass" + security.keyStorePath: "/opt/app/prh/etc/cert/cert.jks" + security.keyStorePasswordPath: "/opt/app/prh/etc/cert/jks.pass" + security.enableAaiCertAuth: false + security.enableDmaapCertAuth: false + streams_publishes: + pnf-update: + type: "message_router" + dmaap_info: + topic_url: http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.PNF_UPDATE + pnf-ready: + type: "message_router" + dmaap_info: + topic_url: http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.PNF_READY + streams_subscribes: + ves-reg-output: + type: "message_router" + dmaap_info: + topic_url: http://message-router.onap.svc.cluster.local:3904/events/unauthenticated.VES_PNFREG_OUTPUT + +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``