aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorsebdet <sebastien.determe@intl.att.com>2019-01-11 13:11:03 +0100
committersebdet <sebastien.determe@intl.att.com>2019-01-11 13:11:03 +0100
commit5dea22255fc131d5c2b0348986bfc75c56d17097 (patch)
tree83d32c3289d83ed68e7c6d3d314a90fe8f026232 /docs/index.rst
parente463a1572a0155363665c321fc9b70a22d2952cb (diff)
Add user guide
Add user guide to the ReadTheDoc pages, this is still a draft Issue-ID: CLAMP-257 Change-Id: I9b1feb9af3749b262ad42518110280b21df7e610 Signed-off-by: sebdet <sebastien.determe@intl.att.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 43fb315f6..677c32b12 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -190,12 +190,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 +222,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