blob: a83c5d4cee33f1460dbe740d80e00c7e42ffae65 [file] [log] [blame]
ChrisCfb622922017-09-05 07:36:32 -07001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
ChrisC8ec1b912018-03-27 03:12:59 -07003.. Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
ChrisCfb622922017-09-05 07:36:32 -07004
ChrisCfac52642017-09-13 08:23:34 -07005CLAMP - Closed Loop Automation Management Platform
6==================================================
ChrisCfb622922017-09-05 07:36:32 -07007.. High level architecture, design, and packaging information for release planning and delivery.
8
Rich Bennettc58f8462017-10-24 08:26:42 -04009.. include:: architecture.rst
ChrisCfb622922017-09-05 07:36:32 -070010
martial99333152017-10-11 13:49:07 +020011
12Offered APIs
13------------
Eric Debeau8ecddd32017-10-20 20:21:57 +000014CLAMP offers the following API:
15* HealthCheck
Rich Bennettc58f8462017-10-24 08:26:42 -040016
17.. line-block::
18
19 URL: http://<host>:8080/restservices/clds/v1/clds/healthcheck
20 Result: if in good health it will return OK: "HTTP/1.1 200", and the following json string content:
21
Eric Debeau8ecddd32017-10-20 20:21:57 +000022.. code-block:: json
Rich Bennettc58f8462017-10-24 08:26:42 -040023
Eric Debeau8ecddd32017-10-20 20:21:57 +000024 {
25 "healthCheckComponent": "CLDS-APP",
26 "healthCheckStatus": "UP",
27 "description": "OK"
28 }
martial99333152017-10-11 13:49:07 +020029
30
31Consumed APIs
32-------------
33CLAMP uses the API's exposed by the following ONAP components:
Eric Debeauee81e8d2017-11-06 20:45:04 +000034
35- SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
36- DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
37- 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
ChrisCfb622922017-09-05 07:36:32 -070038
39
40Delivery
41--------
Eric Debeau8ecddd32017-10-20 20:21:57 +000042CLAMP component is composed of a UI layer and a BackEnd layer and packaged into a single container.
ChrisC8ec1b912018-03-27 03:12:59 -070043CLAMP also requires a database instance with 1 DB, it uses MariaDB.
44CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashboard.
ChrisCfb622922017-09-05 07:36:32 -070045
46.. blockdiag::
47
48
49 blockdiag layers {
ChrisC8ec1b912018-03-27 03:12:59 -070050 orientation = portrait
51 CLAMP_UI -> CLAMP_BACKEND;
52 CLAMP_BACKEND -> CLDSDB;
53 CLAMP_KIBANA -> CLAMP_ELASTICSEARCH;
54 CLAMP_LOGSTASH -> CLAMP_ELASTICSEARCH;
55 group l1 {
56 color = blue;
57 label = "CLAMP container";
58 CLAMP_UI; CLAMP_BACKEND;
59 }
60 group l3 {
61 color = orange;
62 label = "MariaDB container";
63 CLDSDB;
64 }
65 group l4 {
66 color = green;
67 label = "E_Search container";
68 CLAMP_ELASTICSEARCH;
69 }
70 group l5 {
71 color = green;
72 label = "Kibana container";
73 CLAMP_KIBANA;
74 }
75 group l6 {
76 color = green;
77 label = "LogStash container";
78 CLAMP_LOGSTASH;
79 }
ChrisCfac52642017-09-13 08:23:34 -070080 }
ChrisCfb622922017-09-05 07:36:32 -070081
82Logging & Diagnostic Information
83--------------------------------
ChrisC8ec1b912018-03-27 03:12:59 -070084CLAMP uses logback framework to generate logs. The logback.xml file can be found under the [src/main/resources/ folder](src/main/resources).
ChrisCfac52642017-09-13 08:23:34 -070085
Eric Debeau8ecddd32017-10-20 20:21:57 +000086With the default log settings, all logs will be generated into console and into root.log file under the CLAMP root folder. The root.log file is not allowed to be appended, thus restarting the CLAMP will result in cleaning of the old log files.
ChrisCfac52642017-09-13 08:23:34 -070087
ChrisCfb622922017-09-05 07:36:32 -070088
Gildas Lanilis53f49732017-11-22 11:09:27 -080089.. _index-clamp-installation:
ChrisCfb622922017-09-05 07:36:32 -070090
91Installation
92------------
ChrisCfac52642017-09-13 08:23:34 -070093A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/).
ChrisCfb622922017-09-05 07:36:32 -070094
Eric Debeau8ecddd32017-10-20 20:21:57 +000095Once the image has been built and is available locally, you can use the `docker-compose up` command to deploy a prepopullated database and a CLAMP instance available on [http://localhost:8080/designer/index.html](http://localhost:8080/designer/index.html).
ChrisCfb622922017-09-05 07:36:32 -070096
97Configuration
98-------------
ChrisCfac52642017-09-13 08:23:34 -070099.. Where are they provided?
100.. What are parameters and values?
ChrisCfb622922017-09-05 07:36:32 -0700101
102
Eric Debeau8ecddd32017-10-20 20:21:57 +0000103Currently, the CLAMP docker image can be deployed with small configuration needs. Though, you might need to make small adjustments to the configuration. As CLAMP is spring based, you can use the SPRING_APPLICATION_JSON environment variable to update its parameters.
ChrisCfac52642017-09-13 08:23:34 -0700104
105.. TODO detail config parameters and the usage
106
107
108There 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 :
109
110.. code-block:: json
111
112 {
ChrisCfac52642017-09-13 08:23:34 -0700113 "spring.datasource.cldsdb.url": "jdbc:mariadb://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
114 "spring.datasource.cldsdb.username": "admin",
Determe, Sebastien (sd378r)934663b2018-04-04 14:50:57 +0200115 "spring.datasource.cldsdb.password": "password",
116
117 "clamp.config.sdc.catalog.url": "https://sdchost:8443/sdc/v1/catalog/",
118 "clamp.config.sdc.hostUrl": "https://sdchost:8443/",
119 "clamp.config.sdc.serviceUrl": "https://sdchost:8443/sdc/v1/catalog/services",
120 "clamp.config.sdc.serviceUsername": "clamp",
121 "clamp.config.sdc.servicePassword": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
122 "clamp.config.dcae.inventory.url": "http://dcaegen2.host:8080",
123 "clamp.config.dcae.dispatcher.url": "http://dcaegen2.host:8080",
124 "clamp.config.policy.pdpUrl1": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",
125 "clamp.config.policy.pdpUrl2": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",
126 "clamp.config.policy.papUrl": "https://policy-pap.host:8443/pap/ , testpap, alpha123",
127 "clamp.config.policy.clientKey": "5CE79532B3A2CB4D132FC0C04BF916A7"
128 "clamp.config.files.sdcController":"file:/opt/clamp/config/sdc-controllers-config.json"
ChrisCfac52642017-09-13 08:23:34 -0700129 }
130
Determe, Sebastien (sd378r)934663b2018-04-04 14:50:57 +0200131SDC-Controllers config
132----------------------
133This file is a JSON that must be specified to Spring config, here is an example:
ChrisCfac52642017-09-13 08:23:34 -0700134
135.. code-block:: json
Determe, Sebastien (sd378r)46e851e2018-04-06 11:49:18 +0200136 {
137 "sdc-connections":{
138 "sdc-controller1":{
139 "user": "clamp",
140 "consumerGroup": "consumerGroup1",
141 "consumerId": "consumerId1",
142 "environmentName": "AUTO",
143 "sdcAddress": "localhost:8443",
144 "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
145 "pollingInterval":30,
146 "pollingTimeout":30,
147 "activateServerTLSAuth":"false",
148 "keyStorePassword":"",
149 "keyStorePath":"",
150 "messageBusAddresses":["dmaaphost.com"]
151 },
152 "sdc-controller2":{
153 "user": "clamp",
154 "consumerGroup": "consumerGroup1",
155 "consumerId": "consumerId1",
156 "environmentName": "AUTO",
157 "sdcAddress": "localhost:8443",
158 "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
159 "pollingInterval":30,
160 "pollingTimeout":30,
161 "activateServerTLSAuth":"false",
162 "keyStorePassword":"",
163 "keyStorePath":"",
164 "messageBusAddresses":["dmaaphost.com"]
165 }
166 }
167 }
ChrisCfac52642017-09-13 08:23:34 -0700168
Determe, Sebastien (sd378r)934663b2018-04-04 14:50:57 +0200169Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
170Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.
171The environmentName is normally the Dmaap Topic used by SDC.
172If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers)
ChrisCfac52642017-09-13 08:23:34 -0700173
ChrisCfb622922017-09-05 07:36:32 -0700174Administration
175--------------
176
ChrisCfac52642017-09-13 08:23:34 -0700177A user can access CLAMP UI at the following URL : http://localhost:8080/designer/index.html.
martial99333152017-10-11 13:49:07 +0200178(in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
Morgan Richommef391c6c2017-11-08 09:06:39 +0100179
180.. code-block:: html
181
Eric Debeau8ecddd32017-10-20 20:21:57 +0000182 Default username : admin
183 Default password : password
ChrisCfb622922017-09-05 07:36:32 -0700184
ChrisCfb622922017-09-05 07:36:32 -0700185Human Interfaces
186----------------
ChrisCfac52642017-09-13 08:23:34 -0700187.. Basic info on the interface type, ports/protocols provided over, etc.
188
189User Interface (CLAMP Designer) - serve to configure control loop
martial99333152017-10-11 13:49:07 +0200190The following actions are done using the UI:
ChrisCfac52642017-09-13 08:23:34 -0700191
Rich Bennettc58f8462017-10-24 08:26:42 -0400192* Design a control loop flow by selecting a predefined template from a list
193 (a template is an orchestration chain of Micro-services, so the template
194 defines how the micro-services of the control loop are chained together)
195
196* Give value to the configuration the parameters of each micro-service of
197 the control loop
198
199* Select the service and VNF(of that service) to which the control loop
200 will be attached
201
202* Configure the operational policy(the actual operation resulting from
203 the control loop)
204
205* Generate the “TOSCA” blueprint that will be used by DCAE to start the
206 control loop (The blueprint will be sent first to SDC and SDC will
207 publish it to DCAE)
208
209* Trigger the deployment of the Control loop in DCAE
210
211* Control (start/stop) the operation of the control loop in DCAE
martial99333152017-10-11 13:49:07 +0200212
Morgan Richommef391c6c2017-11-08 09:06:39 +0100213
martial99333152017-10-11 13:49:07 +0200214
Eric Debeau8ecddd32017-10-20 20:21:57 +0000215HealthCheck API - serve to verify CLAMP status (see offered API's section)