docs/getting-started-guide/project-release-notes/distribution.rst

   1 ========================
   2 Integration/Distribution
   3 ========================
   4
   5 Major Features
   6 ==============
   7
   8 odl-integration-all
   9 -------------------
  10
  11 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features3-test/src/main/features/features.xml;hb=refs/heads/stable/carbon
  12 * **Description:** An aggregate feature grouping all user-facing ODL features
  13   which can be installed together without Karaf becoming unusable or without port conflicts.
  14 * **Top Level:** Yes
  15 * **User Facing:** No (CSIT purposes only)
  16 * **Experimental:** No
  17 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-deploy-carbon
  18
  19 odl-integration-compatible-with-all
  20 -----------------------------------
  21
  22 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features3-test/src/main/features/features.xml;hb=refs/heads/stable/carbon
  23 * **Description:** An aggregate feature grouping all user-facing ODL features
  24   which are not pro-active and which (as a group) should be compatible with most other ODL features.
  25 * **Top Level:** Yes
  26 * **User Facing:** No (CSIT purposes only)
  27 * **Experimental:** No
  28 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-csit-1node-userfeatures-all-carbon
  29
  30 odl-distribution-version
  31 ------------------------
  32
  33 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features3-distribution/src/main/features/features.xml;hb=refs/heads/stable/carbon
  34 * **Description:** Allows NETCONF/RESTCONF users to determine the version of ODL they are communicating with.
  35 * **Top Level:** Yes
  36 * **User Facing:** Yes
  37 * **Experimental:** No
  38 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-csit-1node-userfeatures-only-carbon
  39
  40 Karaf 3 distribution archive
  41 ----------------------------
  42 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=distribution-karaf/pom.xml;hb=refs/heads/stable/carbon
  43 * **Description:** Zip or tar.gz; when extracted, a self-consistent ODL installation is created.
  44 * **Top Level:** Yes
  45 * **User Facing:** Yes
  46 * **Experimental:** No
  47 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/distribution/job/distribution-offline-carbon
  48
  49 Karaf 4 distribution archive
  50 ----------------------------
  51 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=karaf/pom.xml;hb=refs/heads/stable/carbon
  52 * **Description:** Zip or tar.gz; when extracted, a self-consistent ODL installation is created.
  53 * **Top Level:** Yes
  54 * **User Facing:** Yes
  55 * **Experimental:** Yes
  56 * **CSIT Test:** Removed to save resources.
  57
  58 Documentation
  59 =============
  60
  61 * **User Guide:**
  62
  63   * :ref:`Clustering scripts <getting-started-clustering-scripts>`
  64
  65 * **Developer Guide:**
  66
  67   * :ref:`dist-version`
  68
  69 Security Considerations
  70 =======================
  71
  72 * Karaf 3 exposes ssh console on port 8101.
  73   The security basically basically the same as in upstream Karaf of corresponding versions,
  74   except library version overrides implemented in odlparent:karaf-parent.
  75
  76   See :ref:`securing-karaf`
  77
  78 Quality Assurance
  79 =================
  80
  81 * `Sonar Report <https://sonar.opendaylight.org/overview?id=61911>`_ (0%)
  82
  83   * Only 42 lines of java `code <https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=tree;f=version/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/integration/distribution/version/rev160316;hb=refs/heads/stable/carbon>`_.
  84
  85 * `Test report page <https://wiki.opendaylight.org/view/Integration/Distribution/Carbon_Test_Report>`_
  86 * No additional manual testing.
  87
  88 Migration
  89 ---------
  90
  91 * Version feature works exactly the same as in Boron.
  92   After migration the versions are set to the new default, configurable in runtime or via configfile.
  93   The Boron configfile would work, but users are advised to consider reporting a bumped version.
  94 * No upgrade path for other features.
  95
  96 Compatibility
  97 -------------
  98
  99 * No API changes in Karaf 3.
 100 * Karaf features are not compatible with Boron.
 101
 102   * even odl-distribution-version depends on different version of Config Subsystem.
 103
 104 Bugs Fixed
 105 ----------
 106
 107 * `Bug 4296 <https://bugs.opendaylight.org/show_bug.cgi?id=4296>`_:
 108   At the time of Boron release, the default versions were not being set properly. Now they are.
 109 * `Bug 7255 <https://bugs.opendaylight.org/show_bug.cgi?id=7255>`_:
 110   During Carbon deveopment -all- jobs for NETCONF started to fail.
 111   Turns out NETCONF provides two NETCONF topology managers (single node or cluster)
 112   which are incompatible with each other.
 113   Fixed by moving both out of odl-integration-compatible-with-all.
 114 * `Bug 7493 <https://bugs.opendaylight.org/show_bug.cgi?id=7493>`_:
 115   Controller briefly used Artery, but distribution scripts were not compatible with that.
 116   After all, Artery is not used in Carbon release,
 117   but the scripts now contain information how to make them compatible if needed.
 118 * `Bug 4219 <https://bugs.opendaylight.org/show_bug.cgi?id=4219>`_:
 119   Karaf 4 features and archives are available, but in experimental state only.
 120   NETCONF server and NETCONF connectors do not work. RESTCONF works only up to attempted re-install.
 121
 122
 123 Known Issues
 124 ------------
 125
 126 * No known issues for Karaf 3.
 127 * Karaf 4 is highly experimental.
 128
 129 End-of-life
 130 ===========
 131
 132 No features/APIs which are EOLed, deprecated, and/or removed in this release.
 133
 134 Standards
 135 =========
 136
 137 No standard implemented directly (see upstream projects).
 138
 139 Release Mechanics
 140 =================
 141
 142 * `Release plan <https://wiki.opendaylight.org/view/Integration/Distribution/Carbon_Release_Plan>`_
 143 * Major shifts in release schedule
 144
 145   * Karaf 4 was running late due to difficulty of making CSIT work.
 146     Eventually Karaf 4 was moved to experimental status.
 147   * Team Lead was often busy, neglecting status updates.