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 The list of APIs that CLAMP has offered could be find in the following table:
  15
  16 .. |pdf-icon| image:: images/pdf.png
  17               :width: 40px
  18
  19 .. |swagger-icon| image:: images/swagger.png
  20                    :width: 40px
  21
  22 .. |html-icon| image:: images/html.png
  23                :width: 40px
  24
  25 .. csv-table::
  26    :header: "|Swagger-icon|", "|html-icon|", "|pdf-icon|"
  27    :widths: 60,60,60
  28
  29    "swagger json file", "html doc", "pdf doc"
  30    ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`"
  31
  32
  33 Consumed APIs
  34 -------------
  35 CLAMP uses the API's exposed by the following ONAP components:
  36
  37 - SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
  38 - DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
  39 - 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
  40
  41
  42 Delivery
  43 --------
  44 CLAMP component is composed of a UI layer and a BackEnd layer and packaged into a single container.
  45 CLAMP also requires a database instance with 1 DB, it uses MariaDB.
  46 CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashboard.
  47
  48 .. blockdiag::
  49
  50
  51    blockdiag layers {
  52        orientation = portrait
  53        CLAMP_UI -> CLAMP_BACKEND;
  54        CLAMP_BACKEND -> CLDSDB;
  55        CLAMP_KIBANA -> CLAMP_ELASTICSEARCH;
  56        CLAMP_LOGSTASH -> CLAMP_ELASTICSEARCH;
  57        group l1 {
  58        color = blue;
  59        label = "CLAMP container";
  60        CLAMP_UI; CLAMP_BACKEND;
  61        }
  62        group l3 {
  63        color = orange;
  64        label = "MariaDB container";
  65        CLDSDB;
  66        }
  67        group l4 {
  68        color = green;
  69        label = "E_Search container";
  70        CLAMP_ELASTICSEARCH;
  71        }
  72        group l5 {
  73           color = green;
  74           label = "Kibana container";
  75           CLAMP_KIBANA;
  76        }
  77        group l6 {
  78           color = green;
  79           label = "LogStash container";
  80           CLAMP_LOGSTASH;
  81        }
  82    }
  83
  84 Logging & Diagnostic Information
  85 --------------------------------
  86 CLAMP uses logback framework to generate logs. The logback.xml file can be found under the [src/main/resources/ folder](src/main/resources).
  87
  88 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.
  89
  90
  91 .. _index-clamp-installation:
  92
  93 Installation
  94 ------------
  95 A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/).
  96
  97 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).
  98
  99 Configuration
 100 -------------
 101 .. Where are they provided?
 102 .. What are parameters and values?
 103
 104
 105 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.
 106
 107 .. TODO detail config parameters and the usage
 108
 109
 110 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 :
 111
 112 .. code-block:: json
 113
 114     {
 115         "spring.datasource.cldsdb.url": "jdbc:mariadb://anotherDB.onap.org:3306/cldsdb4?verifyServerCertificate=false&useSSL=false&requireSSL=false&autoReconnect=true",
 116         "spring.datasource.cldsdb.username": "admin",
 117         "spring.datasource.cldsdb.password": "password",
 118
 119         "clamp.config.sdc.catalog.url": "https://sdchost:8443/sdc/v1/catalog/",
 120         "clamp.config.sdc.hostUrl": "https://sdchost:8443/",
 121         "clamp.config.sdc.serviceUrl": "https://sdchost:8443/sdc/v1/catalog/services",
 122         "clamp.config.sdc.serviceUsername": "clamp",
 123         "clamp.config.sdc.servicePassword": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 124         "clamp.config.dcae.inventory.url": "http://dcaegen2.host:8080",
 125         "clamp.config.dcae.dispatcher.url": "http://dcaegen2.host:8080",
 126         "clamp.config.policy.pdpUrl1": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",
 127         "clamp.config.policy.pdpUrl2": "https://policy-pdp.host:9091/pdp/ , testpdp, alpha123",
 128         "clamp.config.policy.papUrl": "https://policy-pap.host:8443/pap/ , testpap, alpha123",
 129         "clamp.config.policy.clientKey": "5CE79532B3A2CB4D132FC0C04BF916A7"
 130         "clamp.config.files.sdcController":"file:/opt/clamp/config/sdc-controllers-config.json"
 131     }
 132
 133 SDC-Controllers config
 134 ----------------------
 135 This file is a JSON that must be specified to Spring config, here is an example:
 136
 137 .. code-block:: json
 138  {
 139   "sdc-connections":{
 140     "sdc-controller1":{
 141         "user": "clamp",
 142         "consumerGroup": "consumerGroup1",
 143         "consumerId": "consumerId1",
 144         "environmentName": "AUTO",
 145         "sdcAddress": "localhost:8443",
 146         "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 147         "pollingInterval":30,
 148         "pollingTimeout":30,
 149         "activateServerTLSAuth":"false",
 150         "keyStorePassword":"",
 151         "keyStorePath":"",
 152         "messageBusAddresses":["dmaaphost.com"]
 153     },
 154     "sdc-controller2":{
 155         "user": "clamp",
 156         "consumerGroup": "consumerGroup1",
 157         "consumerId": "consumerId1",
 158         "environmentName": "AUTO",
 159         "sdcAddress": "localhost:8443",
 160         "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 161         "pollingInterval":30,
 162         "pollingTimeout":30,
 163         "activateServerTLSAuth":"false",
 164         "keyStorePassword":"",
 165         "keyStorePath":"",
 166         "messageBusAddresses":["dmaaphost.com"]
 167     }
 168   }
 169  }
 170
 171 Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
 172 Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.
 173 The environmentName is normally the Dmaap Topic used by SDC.
 174 If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers)
 175
 176 Administration
 177 --------------
 178
 179 A user can access CLAMP UI at the following URL : http://localhost:8080/designer/index.html.
 180 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 181
 182 .. code-block:: html
 183
 184     Default username : admin
 185     Default password : password
 186
 187 Human Interfaces
 188 ----------------
 189 .. Basic info on the interface type, ports/protocols provided over, etc.
 190
 191 User Interface (CLAMP Designer) - serve to configure control loop
 192 The following actions are done using the UI:
 193
 194 * Design a control loop flow by selecting a predefined template from a list
 195   (a template is an orchestration chain of Micro-services, so the template
 196   defines how the micro-services of the control loop are chained together)
 197
 198 * Give value to the configuration the parameters of each micro-service of
 199   the control loop
 200
 201 * Select the service and VNF(of that service) to which the control loop
 202   will be attached
 203
 204 * Configure the operational policy(the actual operation resulting from
 205   the control loop)
 206
 207 * Generate the “TOSCA” blueprint that will be used by DCAE to start the
 208   control loop (The blueprint will be sent first to SDC and SDC will
 209   publish it to DCAE)
 210
 211 * Trigger the deployment of the Control loop in DCAE
 212
 213 * Control (start/stop) the operation of the control loop in DCAE
 214
 215
 216
 217 HealthCheck API - serve to verify CLAMP status (see offered API's section)