docs/release-notes/projects/cardinal.rst

   1 ========
   2 Cardinal
   3 ========
   4
   5 Major Features
   6 ==============
   7
   8 odl-cardinal
   9 ------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=cardinal.git;a=blob;f=features/odl-cardinal/pom.xml
  12 * **Feature Description:** This feature installs the odl-cardinal
  13   application which provides OpenDaylight health statistics, Karaf
  14   and Bundle statistics, Openflow/NETCONF specific statistics to
  15   a NMS server via SNMP protocol. And it also provides REST service
  16   to expose these statistics.
  17 * **Top Level:** Yes
  18 * **User Facing:** Yes
  19 * **Experimental:** Yes
  20 * **CSIT Test:** NA
  21
  22
  23 odl-cardinal-api
  24 ----------------
  25
  26 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=cardinal.git;a=blob;f=features/odl-cardinal-api/pom.xml
  27 * **Feature Description:**  This feature contains the dependencies to
  28   use MDSAL features in CARDINAL.
  29 * **Top Level:** Yes
  30 * **User Facing:** Yes
  31 * **Experimental:** Yes
  32 * **CSIT Test:** NA
  33
  34
  35 odl-cardinal-rest
  36 -----------------
  37
  38 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=cardinal.git;a=blob;f=features/odl-cardinal-rest/pom.xml
  39 * **Feature Description:**  Implements a South Bound Rest interface to
  40   send configuration to REST-capable switches.
  41 * **Top Level:** Yes
  42 * **User Facing:** Yes
  43 * **Experimental:** Yes
  44 * **CSIT Test:** NA
  45
  46
  47 odl-cardinal-ui
  48 ---------------
  49
  50 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=cardinal.git;a=blob;f=features/odl-cardinal-ui/pom.xml
  51 * **Feature Description:**  This feature is the CARDINAL User Interface.
  52 * **Top Level:** Yes
  53 * **User Facing:** Yes
  54 * **Experimental:** Yes
  55 * **CSIT Test:** NA
  56
  57
  58 Documentation
  59 =============
  60
  61 * **User Guide(s):**
  62
  63   * :ref:`cardinal-user-guide`
  64
  65 * **Developer Guide(s):**
  66
  67   * :ref:`cardinal-dev-guide`
  68
  69
  70 Security Considerations
  71 =======================
  72
  73 * SNMP agent runs on port 161,2001,2003
  74
  75   * Current support is for SNMPv2c (no encryption or authentication)
  76
  77 * Are all interfaces exposed using RESTCONF?
  78
  79   * Cardinal supports two interfaces - SNMP and RESTCONF
  80   * Cardinal REST APIs are RESTCONF (authentication) enabled
  81   * Cardinal SNMP support is through SNMP Agent (SNMPv2c as mentioned above)
  82   * :ref:`Link to all RESTCONF API <cardinal-dev-guide>`
  83
  84 Quality Assurance
  85 =================
  86
  87 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=66521>`_ (25.8%)
  88 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/cardinal/>`_
  89 * All modules have been unit tested. Integration tests have been performed for
  90   all major features. System tests have been performed on most major features.
  91
  92 Migration
  93 ---------
  94
  95 * Is it possible to migrate from the previous release? If so, how?
  96
  97   Yes. Migration to this release involves migrating features to Karaf 4; see
  98   `the wiki <https://wiki.opendaylight.org/view/Karaf_4_migration>`_ for details.
  99
 100 Compatibility
 101 -------------
 102
 103 * Is this release compatible with the previous release?
 104
 105   No.
 106
 107 * Any API changes?
 108
 109   All Karaf 3 features have been removed in favour of (compatible) Karaf 4 features
 110
 111 Bugs Fixed
 112 ----------
 113
 114 None.
 115
 116
 117 Known Issues
 118 ------------
 119
 120 No known issues.
 121
 122 End-of-life
 123 ===========
 124
 125 * N/A.
 126
 127
 128 Standards
 129 =========
 130
 131 * MIB OIDS were compiled for generating java classes using 3rd party library Open-DMK(mib-gen)
 132
 133 Release Mechanics
 134 =================
 135
 136 * `ODL CARDINAL Nitrogen release plan <https://wiki.opendaylight.org/view/Cardinal:_Nitrogen_Release_Plan>`_
 137 * No major shifts in the release schedule from the release plan