Upgrade ELK to 6.1.3

[clamp.git] / README.md

diff --git a/README.md b/README.md
index ea061ce..4eaed8a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -37,44 +37,70 @@ Currently, the clamp docker image can be deployed with small configuration needs
 \r
 ### Databases\r
 There are two needed datasource for Clamp. By default, both will try to connect to the localhost server using the credentials available in the example SQL files. If you need to change the default database host and/or credentials, you can do it by using the following json as SPRING_APPLICATION_JSON environment variable :\r
+Note that all others configurations can be configured in the JSON as well, \r
 \r
 ```json\r
 {\r
-    "spring.datasource.camunda.url": "jdbc:mysql://anotherDB.onap.org:3306/camundabpm?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",\r
-    "spring.datasource.camunda.username": "admin",\r
-    "spring.datasource.camunda.password": "password",\r
-    "spring.datasource.cldsdb.url": "jdbc:mysql://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",\r
+    "spring.datasource.cldsdb.url": "jdbc:mysql://anotherDB.onap.org:3306/cldsdb4?autoReconnect=true&connectTimeout=10000&socketTimeout=10000&retriesAllDown=3",\r
     "spring.datasource.cldsdb.username": "admin",\r
     "spring.datasource.cldsdb.password": "password"\r
+    \r
+    "clamp.config.sdc.catalog.url": "https://sdchost:8443/sdc/v1/catalog/",\r
+    "clamp.config.sdc.hostUrl": "https://sdchost:8443/",\r
+    "clamp.config.sdc.serviceUrl": "https://sdchost:8443/sdc/v1/catalog/services",\r
+    "clamp.config.sdc.serviceUsername": "clamp",\r
+    "clamp.config.sdc.servicePassword": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",\r
+    "clamp.config.dcae.inventory.url": "http://dcaegen2.host:8080",\r
+    "clamp.config.dcae.dispatcher.url": "http://dcaegen2.host:8080",\r
+    "clamp.config.policy.pdpUrl1": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",\r
+    "clamp.config.policy.pdpUrl2": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",\r
+    "clamp.config.policy.papUrl": "https://policy-pap.host:8443/pap/ , testpap, alpha123",\r
+    "clamp.config.policy.clientKey": "5CE79532B3A2CB4D132FC0C04BF916A7"\r
+    "clamp.config.files.sdcController":"file:/opt/clamp/config/sdc-controllers-config.json"\r
 }\r
 ```\r
+### SDC-Controllers config\r
 \r
-OR \r
+This file is a JSON that must be specified to Spring config, here is an example:\r
 \r
 ```json\r
 {\r
-    "spring": \r
-    {\r
-        "datasource": \r
-        {\r
-            "camunda": \r
-            {\r
-                "url": "jdbc:mysql://anotherDB.onap.org:3306/camundabpm?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",\r
-                "username": "admin",\r
-                "password": "password"\r
-            },\r
-\r
-            "cldsdb": \r
-            {\r
-                "url": "jdbc:mysql://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",\r
-                "username": "admin",\r
-                "password": "password"\r
-            }\r
-        }\r
+  "sdc-connections":{\r
+    "sdc-controller1":{\r
+        "user": "clamp",\r
+        "consumerGroup": "consumerGroup1",\r
+        "consumerId": "consumerId1",\r
+        "environmentName": "AUTO",\r
+        "sdcAddress": "localhost:8443",\r
+        "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",\r
+        "pollingInterval":30,\r
+        "pollingTimeout":30,\r
+        "activateServerTLSAuth":"false",\r
+        "keyStorePassword":"",\r
+        "keyStorePath":"",\r
+        "messageBusAddresses":["dmaaphost.com"]\r
+    },\r
+    "sdc-controller2":{\r
+        "user": "clamp",\r
+        "consumerGroup": "consumerGroup1",\r
+        "consumerId": "consumerId1",\r
+        "environmentName": "AUTO",\r
+        "sdcAddress": "localhost:8443",\r
+        "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",\r
+        "pollingInterval":30,\r
+        "pollingTimeout":30,\r
+        "activateServerTLSAuth":"false",\r
+        "keyStorePassword":"",\r
+        "keyStorePath":"",\r
+        "messageBusAddresses":["dmaaphost.com"]\r
     }\r
+  }\r
 }\r
-\r
 ```\r
+Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.\r
+Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.\r
+The environmentName is normally the Dmaap Topic used by SDC. \r
+If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers) \r
 \r
 ### Docker-compose\r
 \r
@@ -91,4 +117,19 @@ With the default log settings, all logs will be generated into console and into
 \r
 ### Api\r
 \r
-You can see the swagger definition for the jaxrs apis at `/restservices/clds/v1/openapi.json`
\ No newline at end of file
+You can see the swagger definition for the jaxrs apis at `/restservices/clds/v1/openapi.json`\r
+\r
+\r
+## Clamp Credentials\r
+\r
+Credentials should be specified in `src/main/resources/clds/clds-users.json`. You might specify you own credential file by redefining the `clamp.config.files.cldsUsers` in `application.properties`.\r
+\r
+Passwords should be hashed using Bcrypt :\r
+```\r
+# pip3 install bcrypt  # if you don't have the bcrypt python lib installed, should be done once.\r
+# python3 -c 'import bcrypt; print(bcrypt.hashpw("password".encode(), bcrypt.gensalt(rounds=10, prefix=b"2a")))'\r
+```\r
+\r
+Default credentials are admin/password and cs0008/password.\r
+\r
+\r