Language check for PRH docs
[dcaegen2.git] / docs / sections / services / prh / installation.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 Installation
5 ============
6
7 The following docker-compose-yaml file shows a default configuration. The file can be run using `docker compose up` command:
8
9 .. code-block:: yaml
10
11   version: '3'
12   services:
13     prh:
14       image: nexus3.onap.org:10003/onap/org.onap.dcaegen2.services.prh.prh-app-server
15       command: >
16         --dmaap.dmaapConsumerConfiguration.dmaapHostName=10.42.111.36
17         --dmaap.dmaapConsumerConfiguration.dmaapPortNumber=8904
18         --dmaap.dmaapConsumerConfiguration.dmaapTopicName=/events/unauthenticated.SEC_OTHER_OUTPUT
19         --dmaap.dmaapConsumerConfiguration.dmaapProtocol=http
20         --dmaap.dmaapConsumerConfiguration.dmaapUserName=admin
21         --dmaap.dmaapConsumerConfiguration.dmaapUserPassword=admin
22         --dmaap.dmaapConsumerConfiguration.dmaapContentType=application/json
23         --dmaap.dmaapConsumerConfiguration.consumerId=c12
24         --dmaap.dmaapConsumerConfiguration.consumerGroup=OpenDCAE-c12
25         --dmaap.dmaapConsumerConfiguration.timeoutMS=-1
26         --dmaap.dmaapConsumerConfiguration.message-limit=-1
27         --dmaap.dmaapProducerConfiguration.dmaapHostName=10.42.111.36
28         --dmaap.dmaapProducerConfiguration.dmaapPortNumber=8904
29         --dmaap.dmaapProducerConfiguration.dmaapTopicName=/events/unauthenticated.PNF_READY
30         --dmaap.dmaapProducerConfiguration.dmaapProtocol=http
31         --dmaap.dmaapProducerConfiguration.dmaapUserName=admin
32         --dmaap.dmaapProducerConfiguration.dmaapUserPassword=admin
33         --dmaap.dmaapProducerConfiguration.dmaapContentType=application/json
34         --aai.aaiClientConfiguration.aaiHostPortNumber=30233
35         --aai.aaiClientConfiguration.aaiHost=10.42.111.45
36         --aai.aaiClientConfiguration.aaiProtocol=https
37         --aai.aaiClientConfiguration.aaiUserName=admin
38         --aai.aaiClientConfiguration.aaiUserPassword=admin
39         --aai.aaiClientConfiguration.aaiIgnoreSSLCertificateErrors=true
40         --aai.aaiClientConfiguration.aaiBasePath=/aai/v11
41         --aai.aaiClientConfiguration.aaiPnfPath=/network/pnfs/pnf
42         --security.enableAaiCertAuth=false
43         --security.enableDmaapCertAuth=false
44         --security.keyStorePath=/opt/app/prh/etc/cert/cert.jks
45         --security.keyStorePasswordPath=/opt/app/prh/etc/cert/jks.pass
46         --security.trustStorePath=/opt/app/prh/etc/cert/trust.jks
47         --security.trustStorePasswordPath=/opt/app/prh/etc/cert/trust.pass
48       entrypoint:
49         - java
50         - -Dspring.profiles.active=dev
51         - -jar
52         - /opt/prh-app-server.jar
53       ports:
54         - "8100:8100"
55         - "8433:8433"
56       restart: always
57
58
59 Running with dev-mode of PRH
60 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
61
62 Heartbeat: http://<container_address>:8100/heartbeat or https://<container_address>:8443/heartbeat
63
64 Start prh: http://<container_address>:8100/start or https://<container_address>:8433/start
65
66 Stop prh: http://<container_address>:8100/stopPrh or https://<container_address>:8433/stopPrh