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-2019 AT&T Intellectual Property. All rights reserved.
   4
   5 CLAMP - Control 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, Policy engine target both XACML and Drools PDP, Policy Engine trigger operations 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 (single jar).
  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 pre-populated 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 one datasource for Clamp. By default, it 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:sequential://clampdb.{{ include "common.namespace" . }}:3306/cldsdb4?autoReconnect=true&connectTimeout=10000&socketTimeout=10000&retriesAllDown=3",
 116         "clamp.config.files.sdcController": "file:/opt/clamp/sdc-controllers-config.json",
 117         "clamp.config.dcae.inventory.url": "https://inventory.{{ include "common.namespace" . }}:8080",
 118         "clamp.config.dcae.dispatcher.url": "https4://deployment-handler.{{ include "common.namespace" . }}:8443",
 119         "clamp.config.dcae.deployment.url": "https4://deployment-handler.{{ include "common.namespace" . }}:8443",
 120         "clamp.config.dcae.deployment.userName": "none",
 121         "clamp.config.dcae.deployment.password": "none",
 122         "clamp.config.policy.api.url": "https4://policy-api.{{ include "common.namespace" . }}:6969",
 123         "clamp.config.policy.api.userName": "healthcheck",
 124         "clamp.config.policy.api.password": "zb!XztG34",
 125         "clamp.config.policy.pap.url": "https4://policy-pap.{{ include "common.namespace" . }}:6969",
 126         "clamp.config.policy.pap.userName": "healthcheck",
 127         "clamp.config.policy.pap.password": "zb!XztG34",
 128         "clamp.config.cadi.aafLocateUrl": "https://aaf-locate.{{ include "common.namespace" . }}:8095",
 129         "com.att.eelf.logging.path": "/opt/clamp",
 130         "com.att.eelf.logging.file": "logback.xml"
 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     {
 140      "sdc-connections":{
 141        "sdc-controller1":{
 142            "user": "clamp",
 143            "consumerGroup": "consumerGroup1",
 144            "consumerId": "consumerId1",
 145            "environmentName": "AUTO",
 146            "sdcAddress": "localhost:8443",
 147            "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 148            "pollingInterval":30,
 149            "pollingTimeout":30,
 150            "activateServerTLSAuth":"false",
 151            "keyStorePassword":"",
 152            "keyStorePath":"",
 153            "messageBusAddresses":["dmaaphost.com"]
 154        },
 155        "sdc-controller2":{
 156            "user": "clamp",
 157            "consumerGroup": "consumerGroup1",
 158            "consumerId": "consumerId1",
 159            "environmentName": "AUTO",
 160            "sdcAddress": "localhost:8443",
 161            "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 162            "pollingInterval":30,
 163            "pollingTimeout":30,
 164            "activateServerTLSAuth":"false",
 165            "keyStorePassword":"",
 166            "keyStorePath":"",
 167            "messageBusAddresses":["dmaaphost.com"]
 168        }
 169      }
 170     }
 171
 172 Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
 173 Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.
 174 The environmentName is normally the Dmaap Topic used by SDC.
 175 If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers)
 176
 177 Administration
 178 --------------
 179
 180 A user can access CLAMP UI at the following URL : https://localhost:443/designer/index.html.
 181 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 182 For OOM, the URL is https://<host-ip>:30258
 183
 184 .. code-block:: html
 185
 186    - Without AAF, the credentials are
 187      Default username : admin
 188      Default password : password
 189
 190    - With AAF enabled, the certificate p12 must be added to the browser
 191      ca path: src/main/resources/clds/aaf/org.onap.clamp.p12, password "China in the Spring"
 192      Or get it from this page : https://wiki.onap.org/display/DW/Control+Loop+Flows+and+Models+for+Casablanca
 193
 194 A user can access the Control-Loop DashBoard (ELK stack based) at the following URL : https://localhost:5601 .
 195 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 196 For OOM, the URL is https://<host-ip>:30290. Since El Alto release, User access is protected using the Search Guard plugin, community Edition!,
 197 for Kibana and ElasticSearch. The initial users and credentials provided by the Search Guard plugins are used by default.
 198 (take a look at the files in the ElasticSearch docker image located in the folder: /usr/share/elasticsearch/config/sg/,
 199 especially the file "sg_internal_users.yml").
 200
 201 Human Interfaces
 202 ----------------
 203 .. Basic info on the interface type, ports/protocols provided over, etc.
 204
 205 User Interface (CLAMP Designer) - serve to configure control loop
 206 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.
 207
 208 The following actions are done using the UI:
 209
 210 * Design a control loop flow by selecting a predefined template from a list
 211   (a template is an orchestration chain of Micro-services, so the template
 212   defines how the micro-services of the control loop are chained together)
 213
 214 * Give value to the configuration the parameters of each micro-service of
 215   the control loop
 216
 217 * Select the service and VNF(of that service) to which the control loop
 218   will be attached
 219
 220 * Configure the operational policy(the actual operation resulting from
 221   the control loop)
 222
 223 * Send the “TOSCA” blueprint parameters that will be used by DCAE to start the
 224   control loop (The blueprint will be sent first to SDC and SDC will
 225   publish it to DCAE)
 226
 227 * Trigger the deployment of the Control loop in DCAE
 228
 229 * Control (start/stop) the operation of the control loop in DCAE
 230
 231 HealthCheck API - serve to verify CLAMP status (see offered API's section)
 232 * https://<host-ip>:8443/restservices/clds/v1/healthcheck
 233 This one does not require the certificate
 234
 235 Walk-through can be found here: https://wiki.onap.org/display/DW/CLAMP+videos
 236
 237 .. toctree::
 238    :maxdepth: 1
 239    :titlesonly:
 240
 241    CLAMP User Guide <user-guide.rst>