docs/user-guide.rst

   1 ..
   2 ..  Copyright (c) 2019 AT&T Intellectual Property.
   3 ..  Copyright (c) 2019 Nokia.
   4 ..
   5 ..  Licensed under the Creative Commons Attribution 4.0 International
   6 ..  Public License (the "License"); you may not use this file except
   7 ..  in compliance with the License. You may obtain a copy of the License at
   8 ..
   9 ..    https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 ..  Unless required by applicable law or agreed to in writing, documentation
  12 ..  distributed under the License is distributed on an "AS IS" BASIS,
  13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 ..
  15 ..  See the License for the specific language governing permissions and
  16 ..  limitations under the License.
  17 ..
  18
  19 User-Guide
  20 ==========
  21
  22 .. contents::
  23    :depth: 3
  24    :local:
  25
  26 RIC Alarm System
  27 ----------------
  28
  29 Overview
  30 --------
  31 RIC alarm system consists of three components: Alarm Manager, Application Library and Command Line Interface
  32
  33 The Alarm Manager is responsible for managing alarm situations in RIC cluster and interfacing with Northbound applications
  34 such as Prometheus Alert Manager to post the alarms as alerts. Alert Manager takes care of de-duplicating, silencing and
  35 inhibition (suppressing) of alerts, and routing them to the VES-Agent, which, in turn, takes care of converting alerts to
  36 faults and sending them to ONAP as VES events.
  37
  38 The Alarm Library provides a simple interface for RIC applications (both platform application and xApps) to raise and clear
  39 alarms. The Alarm Library interacts with the Alarm Manager via RMR interface.
  40
  41     .. image:: images/RIC_Alarm_System.png
  42       :width: 600
  43       :alt: Place in RIC's software architecture picture
  44
  45
  46 Alarm Manager
  47 -------------
  48 The Alarm Manager listens alarms coming via RMR and REST interfaces. An application can raise or clear alarms via either
  49 of interfaces. Alarm Manager listens also commands coming from CLI (Command Line Interface). In addition Alarm Manager supports few
  50 other commands that can be given through the interfaces. Such as list active alarms, list alarm history, add new alarms
  51 definition, delete existing alarm definition, re-raise alarms and clear all alarms. Those are not typically used by applications while
  52 running. Alarm Manager itself re-raises alarms periodically to keep alarms in active state. The other commands are can be used through
  53 CLI interface by operator or are used when applications is starting up or restarting.
  54
  55 Maximum amount of active alarms and size of alarm history are configurable. By default, the values are Maximum number of active
  56 alarms = 5000, Maximum number of alarm history = 20,000.
  57
  58 Alarm definitions can be updated dynamically via REST interface. Default definitions are read from JSON configuration file when FM
  59 service is deployed.
  60
  61
  62 Alarm Library
  63 -------------
  64 The Alarm Library provides simple interface for RIC applications (both platform application and xApps) to raise and clear
  65 alarms. A new alarm instance is created with InitAlarm()-function. ManagedObject (mo) and Application (ap) identities are
  66 given as parameters for Alarm Context/Object
  67
  68 The Alarm object contains following parameters:
  69
  70     SpecificProblem: problem that is the cause of the alarm \(*
  71
  72     PerceivedSeverity: The severity of the alarm, see below for possible values
  73
  74     ManagedObjectId: The name of the managed object that is the cause of the fault \(*
  75
  76     ApplicationId: The name of the process raised the alarm \(*
  77
  78     AdditionalInfo: Additional information given by the application
  79
  80     IdentifyingInfo: Identifying additional information, which is part of alarm identity \(*
  81
  82 Items marked with \*, i.e., ManagedObjectId (mo), SpecificProblem (sp), ApplicationId (ap) and IdentifyingInfo (IdentifyingInfo) make
  83 up the identity of the alarm. All parameters must be according to the alarm definition, i.e. all mandatory parameters should be present,
  84 and parameters should have correct value type or be from some predefined range. Addressing the same alarm instance in a clear() or reraise()
  85 call is done by making sure that all four values are the same is in the original raise() / reraise() call.
  86
  87 Alarm Manager does not allow raising "same alarm" more than once without that the alarm is cleared first. Alarm Manager compares
  88 ManagedObjectId (mo), SpecificProblem (sp), ApplicationId (ap) and IdentifyingInfo (IdentifyingInfo) parameters to check possible
  89 duplicate. If the values are the same then alarm is suppressed. If application raises the "same alarm" but PerceivedSeverity of the alarm
  90 is changed then Alarm Manager deletes the old alarm and makes new alarm according to new information.
  91
  92
  93 Alarm APIs
  94
  95     Raise: Raises the alarm instance given as a parameter
  96
  97     Clear: Clears the alarm instance given as a parameter, if it the alarm active
  98
  99     Reraise: Attempts to re-raise the alarm instance given as a parameter
 100
 101     ClearAll: Clears all alarms matching moId and appId given as parameters (not supported yet)
 102
 103
 104 Command line interface
 105 ----------------------
 106
 107 Through CLI operator can do the following operations:
 108
 109  - Check active alarms
 110  - Check alarm history
 111  - Raise an alarm
 112  - Clear an alarm
 113  - Configure maximum active alarms and maximum alarms in alarm history
 114  - Add new alarm definitions that can be raised
 115  - Delete existing alarm definition that can be raised
 116
 117 CLI commands need to be given inside Alarm Manger pod. To get there first print name of the Alarm Manger pod.
 118
 119 .. code-block:: none
 120
 121  kubectl get pods -A | grep alarmmanager
 122
 123 Output should be look someting like this:
 124
 125 .. code-block:: none
 126
 127  ricplt  deployment-ricplt-alarmmanager-6cc8764749-gnwjh 1/1 running 0  15d
 128
 129 Then give this command to enter inside the pod. Replace the pod name with the actual name from the printout.
 130
 131 .. code-block:: none
 132
 133  kubectl exec -it deployment-ricplt-alarmmanager-6cc8764749-gnwjh bash
 134
 135 CLI commands can have some of the following parameters
 136
 137 .. code-block:: none
 138
 139  --moid        ManagedObjectId, example string: RIC
 140  --apid        ApplicationId string, example string: UEEC
 141  --sp          SpecificProblem, example value: 8007
 142  --severity    Severity of the alarm, possible values: UNSPECIFIED, CRITICAL, MAJOR, MINOR, WARNING, CLEARED or DEFAULT
 143  --iinfo       Identifying info, a user specified string, example string: INFO-1
 144  --mal         Maximum number of active alarms, example value 1000
 145  --mah         Maximum number of alarms in alarm history, example value: 2000
 146  --aid         Alarm id, example value: 8007
 147  --atx         Alarm text string, example string: E2 CONNECTIVITY LOST TO E-NODEB
 148  --ety         Event type string, example string: Communication error
 149  --oin         Operation instructions string, example string: Not defined
 150  --prf         Performance profile id, possible values: 1 = peak performance test or 2 = endurance test
 151  --nal         Number of alarms, example value: 50
 152  --aps         Alarms per second, example value: 1
 153  --tim         Total time of test in minutes, example value: 1
 154  --host        Alarm Manager REST address: default value = localhost
 155  --port        Alarm Manager REST port: default value = 8080
 156  --if          Used Alarm Manager command interface, http or rmr: default value = http
 157
 158
 159 ``Note that there are two minus signs before parameter name!``
 160
 161 If parameter contains any white spaces then it must be enclosed in quotation marks like: "INFO 1"
 162
 163 CLI command examples:
 164
 165  Following command are given at top level directory!
 166
 167  Check active alarms:
 168
 169  .. code-block:: none
 170
 171   Syntax: cli/alarm-cli active [--host] [--port]
 172
 173   Example: cli/alarm-cli active
 174
 175   Example: cli/alarm-cli active --host localhost --port 8080
 176
 177  Check alarm history:
 178
 179  .. code-block:: none
 180
 181   Syntax: cli/alarm-cli active  [--host] [--port]
 182
 183   Example: cli/alarm-cli history
 184
 185   Example: cli/alarm-cli history --host localhost --port 8080
 186
 187  Raise alarm:
 188
 189  .. code-block:: none
 190
 191   Syntax: cli/alarm-cli raise --moid --apid --sp --severity --iinfo [--host] [--port] [--if]
 192
 193   Example: cli/alarm-cli raise --moid RIC --apid UEEC --sp 8007 --severity CRITICAL --iinfo INFO-1
 194
 195   Following is meant only for testing and verification purpose!
 196
 197   Example: cli/alarm-cli raise --moid RIC --apid UEEC --sp 8007 --severity CRITICAL --iinfo INFO-1 --host localhost --port 8080 --if rmr
 198
 199  Clear alarm:
 200
 201  .. code-block:: none
 202
 203   Syntax: cli/alarm-cli clear --moid --apid --sp --severity --iinfo [--host] [--port] [--if]
 204
 205   Example: cli/alarm-cli clear --moid RIC --apid UEEC --sp 8007 --iinfo INFO-1
 206
 207   Example: cli/alarm-cli clear --moid RIC --apid UEEC --sp 8007 --iinfo INFO-1 --host localhost --port 8080 --if rmr
 208
 209  Configure maximum active alarms and maximum alarms in alarm history:
 210
 211  .. code-block:: none
 212
 213   Syntax: cli/alarm-cli configure --mal --mah [--host] [--port]
 214
 215   Example: cli/alarm-cli configure --mal 1000 --mah 5000
 216
 217   Example: cli/alarm-cli configure --mal 1000 --mah 5000 --host localhost --port 8080
 218
 219  Add new alarm definition:
 220
 221  .. code-block:: none
 222
 223   Syntax: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" [--host] [--port]
 224
 225   Example: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined"
 226
 227   Example: cli/alarm-cli define --aid 8007 --atx "E2 CONNECTIVITY LOST TO E-NODEB" --ety "Communication error" --oin "Not defined" --host localhost --port 8080
 228
 229  Delete existing alarm definition:
 230
 231  .. code-block:: none
 232
 233   Syntax: cli/alarm-cli undefine --aid [--host] [--port]
 234
 235   Example: cli/alarm-cli undefine --aid 8007
 236
 237   Example: cli/alarm-cli undefine --aid 8007 --host localhost --port 8080
 238
 239  Conduct performance test:
 240
 241  Note that this is meant only for testing and verification purpose!
 242
 243  Before any performance test command can be issued, an environment variable needs to be set. The variable holds information where
 244  test alarm object file is stored.
 245
 246  .. code-block:: none
 247
 248   PERF_OBJ_FILE=cli/perf-alarm-object.json
 249
 250   Syntax: cli/alarm-cli perf --prf --nal --aps --tim [--host] [--port] [--if]
 251
 252   Peak performance test example: cli/alarm-cli perf --prf 1 --nal 50 --aps 1 --tim 1 --if rmr
 253
 254   Peak performance test example: cli/alarm-cli perf --prf 1 --nal 50 --aps 1 --tim 1 --if http
 255
 256   Peak performance test example: cli/alarm-cli perf --prf 1 --nal 50 --aps 1 --tim 1 --host localhost --port 8080 --if rmr
 257
 258   Endurance test example: cli/alarm-cli perf --prf 2 --nal 50 --aps 1 --tim 1 --if rmr
 259
 260   Endurance test example: cli/alarm-cli perf --prf 2 --nal 50 --aps 1 --tim 1 --if http
 261
 262   Endurance test example: cli/alarm-cli perf --prf 2 --nal 50 --aps 1 --tim 1 --host localhost --port 8080 --if rmr
 263
 264
 265 REST interface usage guide
 266 --------------------------
 267
 268 REST interface offers all the same services plus some more that are available via CLI. The CLI also uses the REST interface to implement the services it offers.
 269
 270 Below are examples for REST interface. Curl tool is used to send REST commands.
 271
 272  Check active alarms:
 273
 274    Example: curl -X GET "http://localhost:8080/ric/v1/alarms/active" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 275
 276  Check alarm history:
 277
 278    Example: curl -X GET "http://localhost:8080/ric/v1/alarms/history" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 279
 280  Raise alarm:
 281
 282    Example: curl -X POST "http://localhost:8080/ric/v1/alarms" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"managedObjectId\": \"RIC\", \"applicationId\": \"UEEC\", \"specificProblem\": 8007, \"perceivedSeverity\": \"CRITICAL\", \"additionalInfo\": \"-\", \"identifyingInfo\": \"INFO-1\", \"AlarmAction\": \"RAISE\", \"AlarmTime\": 0}"
 283
 284  Clear alarm:
 285
 286    Example: curl -X DELETE "http://localhost:8080/ric/v1/alarms" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"managedObjectId\": \"RIC\", \"applicationId\": \"UEEC\", \"specificProblem\": 8007, \"perceivedSeverity\": \"\", \"additionalInfo\": \"-\", \"identifyingInfo\": \"INFO-1\", \"AlarmAction\": \"CLEAR\", \"AlarmTime\": 0}"
 287
 288  Get configuration of maximum active alarms and maximum alarms in alarm history:
 289
 290    Example: curl -X GET "http://localhost:8080/ric/v1/alarms/config" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 291
 292  Configure maximum active alarms and maximum alarms in alarm history:
 293
 294    Example: curl -X POST "http://localhost:8080/ric/v1/alarms/config" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"maxactivealarms\": 1000, \"maxalarmhistory\": 5000}"
 295
 296  Get all alarm definitions:
 297
 298    Example: curl -X GET "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 299
 300  Get an alarm definition:
 301
 302    Syntax: curl -X GET "http://localhost:8080/ric/v1/alarms/define/{alarmId}" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 303
 304    Example: curl -X GET "http://localhost:8080/ric/v1/alarms/define/8007" -H  "accept: application/json" -H "Content-Type: application/json" -d "{}"
 305
 306  Add one new alarm definition:
 307
 308    Example: curl -X POST "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"alarmdefinitions\": [{\"alarmId\": 8007, \"alarmText\": \"E2 CONNECTIVITY LOST TO E-NODEB\", \"eventtype\": \"Communication error\", \"operationinstructions\": \"Not defined\"}]}"
 309
 310  Add two new alarm definitions:
 311
 312    Example: curl -X POST "http://localhost:8080/ric/v1/alarms/define" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"alarmdefinitions\": [{\"alarmId\": 8007, \"alarmText\": \"E2 CONNECTIVITY LOST TO E-NODEB\", \"eventtype\": \"Communication error\", \"operationinstructions\": \"Not defined\"},{\"alarmId\": 8008, \"alarmText\": \"ACTIVE ALARM EXCEED MAX THRESHOLD\", \"eventtype\": \"storage warning\", \"operationinstructions\": \"Clear alarms or raise threshold\"}]}"
 313
 314  Delete one existing alarm definition:
 315
 316    Syntax: curl -X DELETE "http://localhost:8080/ric/v1/alarms/define/{alarmId}" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 317
 318    Example: curl -X DELETE "http://localhost:8080/ric/v1/alarms/define/8007" -H "accept: application/json" -H "Content-Type: application/json" -d "{}"
 319
 320
 321 RMR interface usage guide
 322 -------------------------
 323 Through RMR interface application can only raise and clear alarms. RMR message payload is similar JSON message as in above REST interface use cases.
 324
 325  Supported events via RMR interface
 326
 327   - Raise alarm
 328   - Clear alarm
 329   - Reraise alarm
 330   - ClearAll alarms (not supported yet)
 331
 332
 333 Example on how to use the API from Golang code
 334 ----------------------------------------------
 335 Alarm library functions can be used directly from Golang code. Rising and clearing alarms goes via RMR interface from alarm library to Alarm Manager.
 336
 337
 338 .. code-block:: none
 339
 340  package main
 341
 342  import (
 343     alarm "gerrit.o-ran-sc.org/r/ric-plt/alarm-go/alarm"
 344  )
 345
 346  func main() {
 347     // Initialize the alarm component
 348     alarmer, err := alarm.InitAlarm("my-pod", "my-app")
 349
 350     // Create a new Alarm object (SP=8004, etc)
 351     alarm := alarmer.NewAlarm(8004, alarm.SeverityMajor, "NetworkDown", "eth0")
 352
 353     // Raise an alarm (SP=8004, etc)
 354     err := alarmer.Raise(alarm)
 355
 356     // Clear an alarm (SP=8004)
 357     err := alarmer.Clear(alarm)
 358
 359     // Re-raise an alarm (SP=8004)
 360     err := alarmer.Reraise(alarm)
 361
 362     // Clear all alarms raised by the application - (not supported yet)
 363     err := alarmer.ClearAll()
 364  }
 365
 366
 367 Example VES event
 368 -----------------
 369
 370 .. code-block:: none
 371
 372  INFO[2020-06-08T07:50:10Z]
 373  {
 374    "event": {
 375      "commonEventHeader": {
 376        "domain": "fault",
 377        "eventId": "fault0000000001",
 378        "eventName": "Fault_ricp_E2 CONNECTIVITY LOST TO G-NODEB",
 379        "lastEpochMicrosec": 1591602610944553,
 380        "nfNamingCode": "ricp",
 381        "priority": "Medium",
 382        "reportingEntityId": "035EEB88-7BA2-4C23-A349-3B6696F0E2C4",
 383        "reportingEntityName": "Vespa",
 384        "sequence": 1,
 385        "sourceName": "RIC",
 386        "startEpochMicrosec": 1591602610944553,
 387        "version": 3
 388      },
 389
 390      "faultFields": {
 391        "alarmCondition": "E2 CONNECTIVITY LOST TO G-NODEB",
 392        "eventSeverity": "MAJOR",
 393        "eventSourceType": "virtualMachine",
 394        "faultFieldsVersion": 2,
 395        "specificProblem": "eth12",
 396        "vfStatus": "Active"
 397      }
 398    }
 399  }
 400  INFO[2020-06-08T07:50:10Z] Schema validation succeeded