docs/index.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (c) 2017-2018 AT&T Intellectual Property. All rights reserved.
   4
   5 CLAMP - Closed Loop Automation Management Platform
   6 ==================================================
   7 .. High level architecture, design, and packaging information for release planning and delivery.
   8
   9 .. include:: architecture.rst
  10
  11
  12 Offered APIs
  13 ------------
  14 CLAMP offers the following API:
  15 * HealthCheck
  16
  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
  22 .. code-block:: json
  23
  24     {
  25         "healthCheckComponent": "CLDS-APP",
  26         "healthCheckStatus": "UP",
  27         "description": "OK"
  28     }
  29
  30
  31 Consumed APIs
  32 -------------
  33 CLAMP uses the API's exposed by the following ONAP components:
  34
  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
  38
  39
  40 Delivery
  41 --------
  42 CLAMP component is composed of a UI layer and a BackEnd layer and packaged into a single container.
  43 CLAMP also requires a database instance with 1 DB, it uses MariaDB.
  44 CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashboard.
  45
  46 .. blockdiag::
  47
  48
  49    blockdiag layers {
  50        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        }
  80    }
  81
  82 Logging & Diagnostic Information
  83 --------------------------------
  84 CLAMP uses logback framework to generate logs. The logback.xml file can be found under the [src/main/resources/ folder](src/main/resources).
  85
  86 With 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.
  87
  88
  89 .. _index-clamp-installation:
  90
  91 Installation
  92 ------------
  93 A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/).
  94
  95 Once 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).
  96
  97 Configuration
  98 -------------
  99 .. Where are they provided?
 100 .. What are parameters and values?
 101
 102
 103 Currently, 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.
 104
 105 .. TODO detail config parameters and the usage
 106
 107
 108 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 :
 109
 110 .. code-block:: json
 111
 112     {
 113         "spring.datasource.camunda.url": "jdbc:mariadb://anotherDB.onap.org:3306/camundabpm?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 114         "spring.datasource.camunda.username": "admin",
 115         "spring.datasource.camunda.password": "password",
 116         "spring.datasource.cldsdb.url": "jdbc:mariadb://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 117         "spring.datasource.cldsdb.username": "admin",
 118         "spring.datasource.cldsdb.password": "password"
 119     }
 120
 121 OR
 122
 123 .. code-block:: json
 124
 125     {
 126         "spring":
 127         {
 128             "datasource":
 129             {
 130                 "camunda":
 131                 {
 132                     "url": "jdbc:mariadb://anotherDB.onap.org:3306/camundabpm?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 133                     "username": "admin",
 134                     "password": "password"
 135                 },
 136
 137                 "cldsdb":
 138                 {
 139                 "url": "jdbc:mariadb://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 140                 "username": "admin",
 141                 "password": "password"
 142                 }
 143             }
 144         }
 145     }
 146
 147 Administration
 148 --------------
 149
 150 A user can access CLAMP UI at the following URL : http://localhost:8080/designer/index.html.
 151 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 152
 153 .. code-block:: html
 154
 155     Default username : admin
 156     Default password : password
 157
 158 Human Interfaces
 159 ----------------
 160 .. Basic info on the interface type, ports/protocols provided over, etc.
 161
 162 User Interface (CLAMP Designer) - serve to configure control loop
 163 The following actions are done using the UI:
 164
 165 * Design a control loop flow by selecting a predefined template from a list
 166   (a template is an orchestration chain of Micro-services, so the template
 167   defines how the micro-services of the control loop are chained together)
 168
 169 * Give value to the configuration the parameters of each micro-service of
 170   the control loop
 171
 172 * Select the service and VNF(of that service) to which the control loop
 173   will be attached
 174
 175 * Configure the operational policy(the actual operation resulting from
 176   the control loop)
 177
 178 * Generate the “TOSCA” blueprint that will be used by DCAE to start the
 179   control loop (The blueprint will be sent first to SDC and SDC will
 180   publish it to DCAE)
 181
 182 * Trigger the deployment of the Control loop in DCAE
 183
 184 * Control (start/stop) the operation of the control loop in DCAE
 185
 186
 187
 188 HealthCheck API - serve to verify CLAMP status (see offered API's section)