Remove bad url
[clamp.git] / docs / index.rst
index 43fb315..1f41485 100644 (file)
@@ -1,9 +1,9 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
+.. Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
 
-CLAMP - Closed Loop Automation Management Platform
-==================================================
+CLAMP - Control Loop Automation Management Platform
+===================================================
 .. High level architecture, design, and packaging information for release planning and delivery.
 
 .. include:: architecture.rst
@@ -36,7 +36,7 @@ CLAMP uses the API's exposed by the following ONAP components:
 
 - SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
 - DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
-- Policy: REST based interface (the Policy team provide a "jar" to handle the communication), both XACML and Drools PDP, APIs to App-C/VF-C/SDN-C
+- Policy: REST based interface, Policy engine target both XACML and Drools PDP, Policy Engine trigger operations to App-C/VF-C/SDN-C
 
 
 Delivery
@@ -116,11 +116,6 @@ There are one datasource for Clamp. By default, it will try to connect to the lo
         "spring.datasource.cldsdb.username": "admin",
         "spring.datasource.cldsdb.password": "password",
 
-        "clamp.config.sdc.catalog.url": "https://sdchost:8443/sdc/v1/catalog/",
-        "clamp.config.sdc.hostUrl": "https://sdchost:8443/",
-        "clamp.config.sdc.serviceUrl": "https://sdchost:8443/sdc/v1/catalog/services",
-        "clamp.config.sdc.serviceUsername": "clamp",
-        "clamp.config.sdc.servicePassword": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
         "clamp.config.dcae.inventory.url": "http://dcaegen2.host:8080",
         "clamp.config.dcae.dispatcher.url": "http://dcaegen2.host:8188",
         "clamp.config.policy.pdpUrl1": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",
@@ -173,8 +168,8 @@ This file is a JSON that must be specified to Spring config, here is an example:
 
 Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
 Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.
-The environmentName is normally the Dmaap Topic used by SDC. 
-If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers) 
+The environmentName is normally the Dmaap Topic used by SDC.
+If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers)
 
 Administration
 --------------
@@ -190,12 +185,15 @@ For OOM, the URL is https://<host-ip>:30258/designer/index.html
 
    - With AAF enabled, the certificate p12 must be added to the browser
      ca path: src/main/resources/clds/aaf/org.onap.clamp.p12, password "China in the Spring"
+     Or get it from this page : https://wiki.onap.org/display/DW/Control+Loop+Flows+and+Models+for+Casablanca
 
 Human Interfaces
 ----------------
 .. Basic info on the interface type, ports/protocols provided over, etc.
 
 User Interface (CLAMP Designer) - serve to configure control loop
+CLAMP UI is used to configure the Control Loop designed and distributed by SDC. From that UI it's possible to distribute the configuration policies and control the life-cycle of the DCAE Micro Services.
+
 The following actions are done using the UI:
 
 * Design a control loop flow by selecting a predefined template from a list
@@ -219,8 +217,14 @@ The following actions are done using the UI:
 
 * Control (start/stop) the operation of the control loop in DCAE
 
-
-
 HealthCheck API - serve to verify CLAMP status (see offered API's section)
 * https://<host-ip>:8443/restservices/clds/v1/healthcheck
 This one does not require the certificate
+
+Walk-through can be found here: https://wiki.onap.org/display/DW/CLAMP+videos
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   CLAMP User Guide <user-guide.rst>
\ No newline at end of file