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 .. _master_index:
   5
   6 CLAMP - Control Loop Automation Management Platform
   7 ===================================================
   8 .. High level architecture, design, and packaging information for release planning and delivery.
   9
  10 .. include:: architecture.rst
  11
  12
  13 Offered APIs
  14 ------------
  15 The list of APIs that CLAMP has offered could be find in the following table:
  16
  17 .. |pdf-icon| image:: images/pdf.png
  18               :width: 40px
  19
  20 .. |swagger-icon| image:: images/swagger.png
  21                    :width: 40px
  22
  23 .. |html-icon| image:: images/html.png
  24                :width: 40px
  25
  26 .. csv-table::
  27    :header: "|Swagger-icon|", "|html-icon|", "|pdf-icon|"
  28    :widths: 60,60,60
  29
  30    "swagger json file", "html doc", "pdf doc"
  31    ":download:`link <swagger/swagger.json>`", ":download:`link <swagger/swagger.html>`", ":download:`link <swagger/swagger.pdf>`"
  32
  33
  34 Consumed APIs
  35 -------------
  36 CLAMP uses the API's exposed by the following ONAP components:
  37
  38 - SDC : REST based interface exposed by the SDC, Distribution of service to DCAE
  39 - DCAE: REST based interface exposed by DCAE, Common Controller Framework, DCAE microservices onboarded (TCA, Stringmatch, Holmes (optional))
  40 - Policy: REST based interface, Policy engine target both XACML and Drools PDP, Policy Engine trigger operations to App-C/VF-C/SDN-C
  41 - CDS: REST based interface, to retrieve list of operations/actions with their corresponding payload at runtime for Operational Policies where the field 'actor' is 'CDS'.
  42
  43 Delivery
  44 --------
  45 CLAMP component is composed of a UI layer and a backend layer and packaged into a single container (single jar).
  46 CLAMP also requires a database instance with 1 DB, it uses MariaDB.
  47 CLAMP also uses an ELK stack (Elastic Search, Logstash and Kibana) for the Dashboard.
  48
  49 .. blockdiag::
  50
  51
  52    blockdiag layers {
  53        orientation = portrait
  54        CLAMP_UI -> CLAMP_BACKEND;
  55        CLAMP_BACKEND -> CLDSDB;
  56        CLAMP_KIBANA -> CLAMP_ELASTICSEARCH;
  57        CLAMP_LOGSTASH -> CLAMP_ELASTICSEARCH;
  58        group l1 {
  59        color = blue;
  60        label = "CLAMP container";
  61        CLAMP_UI; CLAMP_BACKEND;
  62        }
  63        group l3 {
  64        color = orange;
  65        label = "MariaDB container";
  66        CLDSDB;
  67        }
  68        group l4 {
  69        color = green;
  70        label = "E_Search container";
  71        CLAMP_ELASTICSEARCH;
  72        }
  73        group l5 {
  74           color = green;
  75           label = "Kibana container";
  76           CLAMP_KIBANA;
  77        }
  78        group l6 {
  79           color = green;
  80           label = "LogStash container";
  81           CLAMP_LOGSTASH;
  82        }
  83    }
  84
  85 Logging & Diagnostic Information
  86 --------------------------------
  87 CLAMP uses logback framework to generate logs. The logback.xml file can be found under the [src/main/resources/ folder](src/main/resources).
  88
  89 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.
  90
  91
  92 .. _index-clamp-installation:
  93
  94 Installation
  95 ------------
  96 A [docker-compose example file](extra/docker/clamp/docker-compose.yml) can be found under the [extra/docker/clamp/ folder](extra/docker/).
  97
  98 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 [https://localhost:3000](https://localhost:3000).
  99
 100 Configuration
 101 -------------
 102 .. Where are they provided?
 103 .. What are parameters and values?
 104
 105
 106 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.
 107
 108 .. TODO detail config parameters and the usage
 109
 110
 111 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 :
 112
 113 .. code-block:: json
 114
 115     {
 116         "spring.datasource.cldsdb.url": "jdbc:mariadb:sequential://clampdb.{{ include "common.namespace" . }}:3306/cldsdb4?autoReconnect=true&connectTimeout=10000&socketTimeout=10000&retriesAllDown=3",
 117         "clamp.config.files.sdcController": "file:/opt/clamp/sdc-controllers-config.json",
 118         "clamp.config.dcae.inventory.url": "https://inventory.{{ include "common.namespace" . }}:8080",
 119         "clamp.config.dcae.dispatcher.url": "https4://deployment-handler.{{ include "common.namespace" . }}:8443",
 120         "clamp.config.dcae.deployment.url": "https4://deployment-handler.{{ include "common.namespace" . }}:8443",
 121         "clamp.config.dcae.deployment.userName": "none",
 122         "clamp.config.dcae.deployment.password": "none",
 123         "clamp.config.policy.api.url": "https4://policy-api.{{ include "common.namespace" . }}:6969",
 124         "clamp.config.policy.api.userName": "healthcheck",
 125         "clamp.config.policy.api.password": "zb!XztG34",
 126         "clamp.config.policy.pap.url": "https4://policy-pap.{{ include "common.namespace" . }}:6969",
 127         "clamp.config.policy.pap.userName": "healthcheck",
 128         "clamp.config.policy.pap.password": "zb!XztG34",
 129         "clamp.config.cadi.aafLocateUrl": "https://aaf-locate.{{ include "common.namespace" . }}:8095",
 130         "com.att.eelf.logging.path": "/opt/clamp",
 131         "com.att.eelf.logging.file": "logback.xml"
 132     }
 133
 134 SDC-Controllers config
 135 ----------------------
 136 This file is a JSON that must be specified to Spring config, here is an example:
 137
 138 .. code-block:: json
 139
 140     {
 141      "sdc-connections":{
 142        "sdc-controller1":{
 143            "user": "clamp",
 144            "consumerGroup": "consumerGroup1",
 145            "consumerId": "consumerId1",
 146            "environmentName": "AUTO",
 147            "sdcAddress": "localhost:8443",
 148            "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 149            "pollingInterval":30,
 150            "pollingTimeout":30,
 151            "activateServerTLSAuth":"false",
 152            "keyStorePassword":"",
 153            "keyStorePath":"",
 154            "messageBusAddresses":["dmaaphost.com"]
 155        },
 156        "sdc-controller2":{
 157            "user": "clamp",
 158            "consumerGroup": "consumerGroup1",
 159            "consumerId": "consumerId1",
 160            "environmentName": "AUTO",
 161            "sdcAddress": "localhost:8443",
 162            "password": "b7acccda32b98c5bb7acccda32b98c5b05D511BD6D93626E90D18E9D24D9B78CD34C7EE8012F0A189A28763E82271E50A5D4EC10C7D93E06E0A2D27CAE66B981",
 163            "pollingInterval":30,
 164            "pollingTimeout":30,
 165            "activateServerTLSAuth":"false",
 166            "keyStorePassword":"",
 167            "keyStorePath":"",
 168            "messageBusAddresses":["dmaaphost.com"]
 169        }
 170      }
 171     }
 172
 173 Multiple controllers can be configured so that Clamp is able to receive the notifications from different SDC servers.
 174 Each Clamp existing in a cluster should have different consumerGroup and consumerId so that they can each consume the SDC notification.
 175 The environmentName is normally the Dmaap Topic used by SDC.
 176 If the sdcAddress is not specified or not available (connection failure) the messageBusAddresses will be used (Dmaap servers)
 177
 178 Administration
 179 --------------
 180
 181 A user can access CLAMP UI at the following URL : https://localhost:3000.
 182 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 183 For OOM, the URL is https://<host-ip>:30258
 184
 185 .. code-block:: html
 186
 187    - Without AAF, the credentials are
 188      Default username : admin
 189      Default password : password
 190
 191    - With AAF enabled, the certificate p12 must be added to the browser
 192      ca path: src/main/resources/clds/aaf/org.onap.clamp.p12, password "China in the Spring"
 193      Or get it from this page : https://wiki.onap.org/display/DW/Control+Loop+Flows+and+Models+for+Casablanca
 194
 195 A user can access the Control-Loop DashBoard (ELK stack based) at the following URL : https://localhost:5601 .
 196 (in this URL 'localhost' must be replaced by the actual host where CLAMP has been installed if it is not your current localhost)
 197 For OOM, the URL is https://<host-ip>:30290. Since El Alto release, User access is protected using the Search Guard plugin, community Edition!,
 198 for Kibana and ElasticSearch. The initial users and credentials provided by the Search Guard plugins are used by default.
 199 (take a look at the files in the ElasticSearch docker image located in the folder: /usr/share/elasticsearch/config/sg/,
 200 especially the file "sg_internal_users.yml").
 201
 202 Human Interfaces
 203 ----------------
 204 .. Basic info on the interface type, ports/protocols provided over, etc.
 205
 206 User Interface (CLAMP Designer) - serve to configure control loop
 207 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.
 208
 209 The following actions are done using the UI:
 210
 211 * Design a control loop flow by selecting a predefined template from a list
 212   (a template is an orchestration chain of Micro-services, so the template
 213   defines how the micro-services of the control loop are chained together)
 214
 215 * Give value to the configuration the parameters of each micro-service of
 216   the control loop
 217
 218 * Select the service and VNF(of that service) to which the control loop
 219   will be attached
 220
 221 * Configure the operational policy(the actual operation resulting from
 222   the control loop)
 223
 224 * Send the “TOSCA” blueprint parameters that will be used by DCAE to start the
 225   control loop (The blueprint will be sent first to SDC and SDC will
 226   publish it to DCAE)
 227
 228 * Trigger the deployment of the Control loop in DCAE
 229
 230 * Control (start/stop) the operation of the control loop in DCAE
 231
 232 HealthCheck API - serve to verify CLAMP status (see offered API's section)
 233 * https://<host-ip>:8443/restservices/clds/v1/healthcheck
 234 This one does not require the certificate
 235
 236 Walk-through can be found here: https://wiki.onap.org/display/DW/CLAMP+videos
 237
 238 .. toctree::
 239    :maxdepth: 1
 240    :titlesonly:
 241
 242    CLAMP User Guide <user-guide.rst>