NONRTRIC - Implement DMaaP mediator producer service in Java

[nonrtric.git] / dmaap-mediator-producer / README.md

diff --git a/dmaap-mediator-producer/README.md b/dmaap-mediator-producer/README.md
index e4a2ffd..c22c561 100644 (file)
--- a/dmaap-mediator-producer/README.md
+++ b/dmaap-mediator-producer/README.md
@@ -7,9 +7,10 @@ The producer takes a number of environment variables, described below, as config
 >- INFO_PRODUCER_HOST  **Required**. The host for the producer.                                   Example: `http://mrproducer`
 >- LOG_LEVEL           Optional. The log level, which can be `Error`, `Warn`, `Info` or `Debug`.  Defaults to `Info`.
 >- INFO_PRODUCER_PORT  Optional. The port for the product.                                        Defaults to `8085`.
 >- INFO_PRODUCER_HOST  **Required**. The host for the producer.                                   Example: `http://mrproducer`
 >- LOG_LEVEL           Optional. The log level, which can be `Error`, `Warn`, `Info` or `Debug`.  Defaults to `Info`.
 >- INFO_PRODUCER_PORT  Optional. The port for the product.                                        Defaults to `8085`.

->- INFO_COORD_ADDR     Optional. The address of the Information Coordinator.                      Defaults to `http://enrichmentservice:8083`.
->- MR_HOST             Optional. The host for the DMaaP Message Router.                           Defaults to `http://message-router.onap`.
->- MR_PORT             Optional. The port for the DMaaP Message Router.                           Defaults to `3904`.
+>- INFO_COORD_ADDR     Optional. The address of the Information Coordinator.                      Defaults to `https://enrichmentservice:8434`.
+>- DMAAP_MR_ADDR       Optional. The address of the DMaaP Message Router.                         Defaults to `https://message-router.onap:3905`.
+>- PRODUCER_CERT_PATH  Optional. The path to the certificate to use for https.                    Defaults to `configs/producer.crt`
+>- PRODUCER_KEY_PATH   Optional. The path to the key to the certificate to use for https.         Defaults to `configs/producer.key`

 
 The file `configs/type_config.json` contains the configuration of job types that the producer will support.
 
 
 The file `configs/type_config.json` contains the configuration of job types that the producer will support.
 


@@ -23,6 +24,8 @@ The file `configs/type_config.json` contains the configuration of job types that
       ]
     }
 
       ]
     }
 

+The server part of the producer uses https, and the communication towards ICS and MR use https, with no server certificate verification.
+

 At start up the producer will register the configured job types in ICS and also register itself as a producer supporting these types.
 
 Once the initial registration is done, the producer will constantly poll MR for all configured job types. When receiving messages for a type, it will distribute these messages to all jobs registered for the type. If no jobs for that type are registered, the messages will be discarded. If a consumer is unavailable for distribution, the messages will be discarded for that consumer.
 At start up the producer will register the configured job types in ICS and also register itself as a producer supporting these types.
 
 Once the initial registration is done, the producer will constantly poll MR for all configured job types. When receiving messages for a type, it will distribute these messages to all jobs registered for the type. If no jobs for that type are registered, the messages will be discarded. If a consumer is unavailable for distribution, the messages will be discarded for that consumer.