docs/user-guide/cardinal_-opendaylight-monitoring-as-a-service.rst

   1 Cardinal: OpenDaylight Monitoring as a Service
   2 ==============================================
   3
   4 This section describes how to use the Cardinal feature in OpenDaylight
   5 and contains configuration, administration, and management sections for
   6 the feature.
   7
   8 Overview
   9 --------
  10
  11 Cardinal (OpenDaylight Monitoring as a Service) enables OpenDaylight and
  12 the underlying software defined network to be remotely monitored by
  13 deployed Network Management Systems (NMS) or Analytics suite. In the
  14 Boron release, Cardinal will add:
  15
  16 1. OpenDaylight MIB.
  17
  18 2. Enable ODL diagnostics/monitoring to be exposed across SNMP (v2c, v3)
  19    and REST north-bound.
  20
  21 3. Extend ODL System health, Karaf parameter and feature info, ODL
  22    plugin scalability and network parameters.
  23
  24 4. Support autonomous notifications (SNMP Traps).
  25
  26 Cardinal Architecture
  27 ---------------------
  28
  29 The Cardinal architecture can be found at the below link:
  30
  31 https://wiki.opendaylight.org/images/8/89/Cardinal-ODL_Monitoring_as_a_Service_V2.pdf
  32
  33 Configuring Cardinal feature
  34 ----------------------------
  35
  36 To start Cardinal feature, start karaf and type the following command:
  37
  38 ::
  39
  40     feature:install odl-cardinal
  41
  42 After this Cardinal should be up and working with SNMP daemon running on
  43 port 161.
  44
  45 Tutorials
  46 ---------
  47
  48 Below are tutorials for Cardinal.
  49
  50 Using Cardinal
  51 ~~~~~~~~~~~~~~
  52
  53 These tutorials are intended for any user who wants to monitor three
  54 basic component in OpenDaylight
  55
  56 1. System Info in which controller is running.
  57
  58 2. Karaf Info
  59
  60 3. Project Specific Information.
  61
  62 Prerequisites
  63 ^^^^^^^^^^^^^
  64
  65 There is no as such specific prerequisite. Cardinal can work without
  66 installing any third party software. However If one wants to see the
  67 output of a snmpget/snmpwalk on the CLI prompt, than one can install the
  68 SNMP using the below link:
  69
  70 https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-an-snmp-daemon-and-client-on-ubuntu-14-04
  71
  72 Using the above command line utility one can get the same result as the
  73 cardinal APIs will give for the snmpget/snmpwalk request.
  74
  75 Target Environment
  76 ^^^^^^^^^^^^^^^^^^
  77
  78 This tutorial is developed considering the following environment:
  79
  80 controller-Linux(Ubuntu 14.02).
  81
  82 Instructions
  83 ^^^^^^^^^^^^
  84
  85 Install Cardinal feature
  86 ''''''''''''''''''''''''
  87
  88 Open karaf and install the cardinal feature using the following command:
  89
  90 ::
  91
  92     feature:install odl-cardinal
  93
  94 Please verify that SNMP daemon is up on port 161 using the following
  95 command on the terminal window of Linux machine:
  96
  97 ::
  98
  99     netstat -anp | grep "161"
 100
 101 If the grep on the \`\`snmpd\`\` port is successful than SNMP daemon is
 102 up and working.
 103
 104 APIs Reference
 105 ''''''''''''''
 106
 107 Please see Developer guide for usage of Cardinal APIs.
 108
 109 CLI commands to do snmpget/walk
 110 '''''''''''''''''''''''''''''''
 111
 112 One can do snmpget/walk on the ODL-CARDINAL-MIB. Open the linux terminal
 113 and type the below command:
 114
 115 ::
 116
 117     snmpget -v2c -c public localhost Oid_Of_the_mib_variable
 118
 119 Or
 120
 121 ::
 122
 123     snmpget -v2c -c public localhost ODL-CARDINAL-MIB::mib_variable_name
 124
 125 For snmpwalk use the below command:
 126
 127 ::
 128
 129     snmpwalk -v2c -c public localhost SNMPv2-SMI::experimental
 130