docs/release-notes/projects/infrautils.rst

   1 ==========
   2 Infrautils
   3 ==========
   4
   5 Major Features
   6 ==============
   7
   8 odl-infrautils-all
   9 ------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-all/pom.xml;hb=stable/oxygen
  12 * **Feature Description:**  This feature exposes all infrautils framework features
  13 * **Top Level:** Yes
  14 * **User Facing:** No
  15 * **Experimental:** Yes
  16 * **CSIT Test:** covered by Netvirt and Genius CSITs
  17   * https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-1node-openstack-queens-upstream-stateful-oxygen/
  18   * https://jenkins.opendaylight.org/releng/view/genius/job/genius-csit-1node-gate-all-oxygen/
  19
  20 .. note that this is experimental until the system test waiver is granted
  21 .. on this thread:
  22 .. https://lists.opendaylight.org/pipermail/infrautils-dev/2017-May/000322.html
  23
  24 odl-infrautils-jobcoordinator
  25 -----------------------------
  26
  27 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-jobcoordinator/pom.xml;hb=stable/oxygen
  28 * **Feature Description:**  This feature exposes the jobcoordinator framework which is heavily used in genius and netvirt.
  29 * **Top Level:** Yes
  30 * **User Facing:** No
  31 * **Experimental:** Yes
  32 * **CSIT Test:** covered by Netvirt and Genius CSITs
  33
  34 odl-infrautils-metrics
  35 ----------------------
  36
  37 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-metrics/pom.xml;hb=stable/oxygen
  38 * **Feature Description:**  This feature exposes the new infrautils.metrics API with labels and first implementation based on Dropwizard incl. thread watcher
  39 * **Top Level:** Yes
  40 * **User Facing:** No
  41 * **Experimental:** Yes
  42 * **CSIT Test:** covered by Netvirt and Genius CSITs
  43
  44 odl-infrautils-ready
  45 --------------------
  46
  47 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-ready/pom.xml;hb=stable/oxygen
  48 * **Feature Description:**  This feature exposes the system readiness framework
  49 * **Top Level:** Yes
  50 * **User Facing:** No
  51 * **Experimental:** Yes
  52 * **CSIT Test:** covered by Netvirt and Genius CSITs
  53
  54 odl-infrautils-caches
  55 ---------------------
  56
  57 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-caches/pom.xml;hb=stable/oxygen
  58 * **Feature Description:**  This feature exposes new infrautils.caches API, CLI commands for monitoring, and first implementation based on Guava
  59 * **Top Level:** Yes
  60 * **User Facing:** No
  61 * **Experimental:** Yes
  62 * **CSIT Test:** covered by Netvirt and Genius CSITs
  63
  64 odl-infrautils-diagstatus
  65 -------------------------
  66
  67 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=infrautils.git;a=blob;f=common/features/odl-infrautils-diagstatus/pom.xml;hb=stable/oxygen
  68 * **Feature Description:**  This feature exposes the status and diagnostics framework
  69 * **Top Level:** Yes
  70 * **User Facing:** No
  71 * **Experimental:** Yes
  72 * **CSIT Test:** covered by Netvirt and Genius CSITs
  73
  74
  75
  76 Documentation
  77 =============
  78
  79 * **User Guide(s):**
  80
  81   * :doc:`User Guide </submodules/infrautils/docs/specs/index>`
  82
  83 * **Developer Guide(s):**
  84
  85   * :doc:`Developer Guide </submodules/infrautils/docs/index>`
  86
  87 Security Considerations
  88 =======================
  89
  90 * JMX RMI Registry opens on port listed at https://wiki.opendaylight.org/view/Ports
  91
  92 Quality Assurance
  93 =================
  94
  95 * `Link to Sonar Report <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.infrautils%3Ainfrautils>`_
  96 * Project infrautils provides low-level technical framework utilities
  97   and therefore no CSIT automated system testing is available. However
  98   the same gets covered by the CSIT of users of infrautils (eg : Genius, Netvirt)
  99
 100 Migration
 101 ---------
 102
 103 * No additional migration steps needed
 104
 105 Compatibility
 106 -------------
 107
 108 * Is this release compatible with the previous release?
 109
 110   * Functionality is fully backwards compatible.
 111
 112 * Any API changes?
 113
 114   * New APIs added for diagstatus
 115   * New APIs added for metrics
 116   * New APIs added for caches
 117
 118 * Any configuration changes?
 119
 120   * No
 121
 122 Bugs Fixed
 123 ----------
 124
 125 * `List of bugs fixed since the previous release: <https://jira.opendaylight.org/browse/INFRAUTILS-29?jql=project%20%3D%20INFRAUTILS%20AND%20created%20%3E%3D%202017-10-07%20AND%20created%20%3C%3D%202018-03-08>`_
 126
 127 Known Issues
 128 ------------
 129
 130 * There are no currently known issues
 131
 132 End-of-life
 133 ===========
 134
 135 * This section is N/A
 136
 137 Standards
 138 =========
 139
 140 * This section is N/A
 141
 142 Release Mechanics
 143 =================
 144
 145 * `Link to release plan <https://wiki.opendaylight.org/view/InfraUtils:Oxygen:Release_Plan>`_