summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorosgn422w <gervais-martial.ngueko@intl.att.com>2021-03-16 16:27:47 +0100
committerosgn422w <gervais-martial.ngueko@intl.att.com>2021-03-16 19:42:32 +0100
commitebc6907968050189688a0b8ccc0e0c42419a9202 (patch)
tree2e090abc9e0b10fe284621ef54d6ba61695652e7 /docs/index.rst
parentc757487d6831c18b9942833054817272c641c6ce (diff)
Policy/Clamp doc update
update the documentation to reflect the merge of clamp into Policy framework Issue-ID: REQ-684 Change-Id: I06391cb6468c15aba58bac18a5c042d05b6c8b9f Signed-off-by: osgn422w <gervais-martial.ngueko@intl.att.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst50
1 files changed, 13 insertions, 37 deletions
diff --git a/docs/index.rst b/docs/index.rst
index c8aafc23c..9be3af223 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,10 +1,10 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (c) 2017-2019 AT&T Intellectual Property. All rights reserved.
+.. Copyright (c) 2017-2021 AT&T Intellectual Property. All rights reserved.
.. _master_index:
-CLAMP - Control Loop Automation Management Platform
-===================================================
+Policy/CLAMP - Control Loop Automation Management Platform
+==========================================================
.. High level architecture, design, and packaging information for release planning and delivery.
.. include:: architecture.rst
@@ -12,7 +12,7 @@ CLAMP - Control Loop Automation Management Platform
Offered APIs
------------
-The list of APIs that CLAMP has offered could be find in the following table:
+The list of APIs that Policy/CLAMP has offered could be find in the following table:
.. |pdf-icon| image:: images/pdf.png
:width: 40px
@@ -33,18 +33,17 @@ The list of APIs that CLAMP has offered could be find in the following table:
Consumed APIs
-------------
-CLAMP uses the API's exposed by the following ONAP components:
+Policy/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, Policy engine target both XACML and Drools PDP, Policy Engine trigger operations to App-C/VF-C/SDN-C
+- Policy Core: REST based interface, Policy engine target both XACML and Drools PDP, Policy Engine trigger operations to App-C/VF-C/SDN-C
- CDS: REST based interface, to retrieve list of operations/actions with their corresponding payload at runtime for Operational Policies where the field 'actor' is 'CDS'.
Delivery
--------
-CLAMP component is composed of a UI layer and a backend layer and packaged into a single container (single jar).
-CLAMP also requires a database instance with 1 DB, it uses MariaDB.
-CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashboard.
+Policy/CLAMP component is composed of a UI layer and a backend layer and packaged into a single container (single jar).
+Policy/CLAMP also requires a database instance with 1 DB, it uses MariaDB, which is the same DB as for the core Policy.
.. blockdiag::
@@ -53,8 +52,6 @@ CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashb
orientation = portrait
CLAMP_UI -> CLAMP_BACKEND;
CLAMP_BACKEND -> CLDSDB;
- CLAMP_KIBANA -> CLAMP_ELASTICSEARCH;
- CLAMP_LOGSTASH -> CLAMP_ELASTICSEARCH;
group l1 {
color = blue;
label = "CLAMP container";
@@ -65,21 +62,6 @@ CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashb
label = "MariaDB container";
CLDSDB;
}
- group l4 {
- color = green;
- label = "E_Search container";
- CLAMP_ELASTICSEARCH;
- }
- group l5 {
- color = green;
- label = "Kibana container";
- CLAMP_KIBANA;
- }
- group l6 {
- color = green;
- label = "LogStash container";
- CLAMP_LOGSTASH;
- }
}
Logging & Diagnostic Information
@@ -178,8 +160,8 @@ If the sdcAddress is not specified or not available (connection failure) the mes
Administration
--------------
-A user can access CLAMP UI at the following URL : https://localhost:3000.
-(in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
+A user can access Policy/CLAMP UI at the following URL : https://localhost:3000.
+(in this URL 'localhost' must be replaced by the actual host where Policy/CLAMP has been installed if it is not your current localhost)
For OOM, the URL is https://<host-ip>:30258
.. code-block:: html
@@ -192,19 +174,13 @@ For OOM, the URL is https://<host-ip>:30258
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
-A user can access the Control-Loop DashBoard (ELK stack based) at the following URL : https://localhost:5601 .
-(in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
-For OOM, the URL is https://<host-ip>:30290. Since El Alto release, User access is protected using the Search Guard plugin, community Edition!,
-for Kibana and ElasticSearch. The initial users and credentials provided by the Search Guard plugins are used by default.
-(take a look at the files in the ElasticSearch docker image located in the folder: /usr/share/elasticsearch/config/sg/,
-especially the file "sg_internal_users.yml").
-
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.
+User Interface - serve to configure control loop
+Policy/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.
+Policy/CLAMP UI is also used to manage Policies outside of a Control Loop.
The following actions are done using the UI: