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 © 2017 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 2 DB, it uses MariaDB.
  44
  45 .. blockdiag::
  46
  47
  48    blockdiag layers {
  49    orientation = portrait
  50    CLAMP_UI -> CLAMP_BACKEND;
  51    CLAMP_BACKEND -> CAMUNDADB;
  52    CLAMP_BACKEND -> CLDSDB;
  53    group l1 {
  54    color = blue;
  55    label = "CLAMP container";
  56    CLAMP_UI; CLAMP_BACKEND;
  57    }
  58    group l3 {
  59    color = orange;
  60    label = "MariaDB container";
  61    CAMUNDADB; CLDSDB;
  62    }
  63    }
  64
  65
  66 Logging & Diagnostic Information
  67 --------------------------------
  68 CLAMP uses logback framework to generate logs. The logback.xml file cand be found under the [src/main/resources/ folder](src/main/resources).
  69
  70 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.
  71
  72
  73 .. _index-clamp-installation:
  74
  75 Installation
  76 ------------
  77 A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/).
  78
  79 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).
  80
  81 Configuration
  82 -------------
  83 .. Where are they provided?
  84 .. What are parameters and values?
  85
  86
  87 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.
  88
  89 .. TODO detail config parameters and the usage
  90
  91
  92 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 :
  93
  94 .. code-block:: json
  95
  96     {
  97         "spring.datasource.camunda.url": "jdbc:mariadb://anotherDB.onap.org:3306/camundabpm?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
  98         "spring.datasource.camunda.username": "admin",
  99         "spring.datasource.camunda.password": "password",
 100         "spring.datasource.cldsdb.url": "jdbc:mariadb://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 101         "spring.datasource.cldsdb.username": "admin",
 102         "spring.datasource.cldsdb.password": "password"
 103     }
 104
 105 OR
 106
 107 .. code-block:: json
 108
 109     {
 110         "spring":
 111         {
 112             "datasource":
 113             {
 114                 "camunda":
 115                 {
 116                     "url": "jdbc:mariadb://anotherDB.onap.org:3306/camundabpm?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 117                     "username": "admin",
 118                     "password": "password"
 119                 },
 120
 121                 "cldsdb":
 122                 {
 123                 "url": "jdbc:mariadb://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 124                 "username": "admin",
 125                 "password": "password"
 126                 }
 127             }
 128         }
 129     }
 130
 131 Administration
 132 --------------
 133
 134 A user can access CLAMP UI at the following URL : http://localhost:8080/designer/index.html.
 135 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 136
 137 .. code-block:: html
 138
 139     Default username : admin
 140     Default password : password
 141
 142 Human Interfaces
 143 ----------------
 144 .. Basic info on the interface type, ports/protocols provided over, etc.
 145
 146 User Interface (CLAMP Designer) - serve to configure control loop
 147 The following actions are done using the UI:
 148
 149 * Design a control loop flow by selecting a predefined template from a list
 150   (a template is an orchestration chain of Micro-services, so the template
 151   defines how the micro-services of the control loop are chained together)
 152
 153 * Give value to the configuration the parameters of each micro-service of
 154   the control loop
 155
 156 * Select the service and VNF(of that service) to which the control loop
 157   will be attached
 158
 159 * Configure the operational policy(the actual operation resulting from
 160   the control loop)
 161
 162 * Generate the “TOSCA” blueprint that will be used by DCAE to start the
 163   control loop (The blueprint will be sent first to SDC and SDC will
 164   publish it to DCAE)
 165
 166 * Trigger the deployment of the Control loop in DCAE
 167
 168 * Control (start/stop) the operation of the control loop in DCAE
 169
 170
 171
 172 HealthCheck API - serve to verify CLAMP status (see offered API's section)