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

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