docs/getting-started-guide/project-release-notes/distribution-release-notes.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=features/singles/odl-integration-all/pom.xml;h=c3df09e8828ff16299d96f82e78b1901de1a60ca;hb=refs/heads/stable/nitrogen
  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:** Yes, but not intended for production use (only for testing purposes).
  16 * **Experimental:** No.
  17 * **CSIT Test:** https://jenkins.opendaylight.org/releng/job/distribution-deploy-nitrogen
  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=features/singles/odl-integration-compatible-with-all/pom.xml;h=5ddd52a15cdc658ed18f4647469666b8c849cf4c;hb=refs/heads/stable/nitrogen
  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:** Yes, but not intended for production use (only for testing purposes).
  27 * **Experimental:** No.
  28 * **CSIT Test:** https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-nitrogen
  29
  30 odl-distribution-version
  31 ------------------------
  32
  33 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=features/singles/odl-distribution-version/pom.xml;h=b504cbeb6889379492d33322f1c5cfa488a207a4;hb=refs/heads/stable/nitrogen
  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/job/distribution-csit-1node-userfeatures-all-nitrogen
  39
  40 Karaf 4 distribution archive
  41 ----------------------------
  42 * **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=karaf/pom.xml;h=082fd09a2467e02e4303f8a5ce0bd42b48ad0267;hb=refs/heads/stable/nitrogen
  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/job/distribution-deploy-nitrogen
  48
  49 Documentation
  50 =============
  51
  52 * **Getting Started Guide**
  53
  54   * :ref:`Clustering scripts <getting-started-clustering-scripts>`
  55   * :ref:`Distribution version <getting-started-opendaylight-version>`
  56
  57 * **User Guide:**
  58
  59   * :ref:`Distribution version <user-guide-dist-version>`
  60
  61 * **Developer Guide**
  62
  63   * :ref:`Test features <developer-guide-dist-test-features>`
  64   * :ref:`Distribution version <developer-guide-dist-version>`
  65
  66 Security Considerations
  67 =======================
  68
  69 * Karaf 4 exposes ssh console on port 8101.
  70   The security basically basically the same as in upstream Karaf of corresponding versions,
  71   except library version overrides implemented in odlparent:karaf-parent.
  72
  73   See :ref:`securing-karaf`
  74
  75   There is `Bug 9044 <https://bugs.opendaylight.org/show_bug.cgi?id=9044>` which limits
  76   accessibility of karaf console over SSH after restart.
  77
  78 * `Sonar Report <https://sonar.opendaylight.org/overview?id=61911>`_ (0%)
  79
  80   * 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;h=517b2d5a2e726b77360389a20ad8cd8b1a0a6a46;hb=refs/heads/stable/nitrogen>`_.
  81
  82 * `Test report page <https://wiki.opendaylight.org/view/Integration/Distribution/Nitrogen_Test_Report>`_
  83
  84 * No additional manual testing was needed.
  85
  86 Migration
  87 ---------
  88
  89 * Version feature works exactly the same as in Carbon.
  90   After migration the versions are set to the new default, configurable in runtime or via configfile.
  91   The Carbon configfile would work, but users are strongly advised to consider reporting the migrated versions.
  92 * No upgrade path for other major features.
  93
  94 Compatibility
  95 -------------
  96
  97 * Multiple API changes, as Nitrogen is Karaf 4 while Carbon was Karaf 3.
  98 * Even odl-distribution-version depends on different version of Config Subsystem.
  99 * Only cluster configuration scripts remained compatible.
 100
 101 Bugs Fixed
 102 ----------
 103
 104 None since Carbon SR1 release.
 105
 106 Known Issues
 107 ------------
 108
 109 * `Bug 9044 <https://bugs.opendaylight.org/show_bug.cgi?id=9044>`_
 110
 111 ** The ssh-dss method is used by Karaf SSH console, but no longer supported by clients such as OpenSSH.
 112
 113 *** **Workaround:** Use the bin/client script, which uses karaf:karaf as the default credentials.
 114
 115 ** After restart, Karaf is unable to re-use the generated host.key file.
 116
 117 *** **Workaround** Delete the etc/host.key file before starting Karaf again.
 118
 119 * `Bug 9161 <https://bugs.opendaylight.org/show_bug.cgi?id=9161>`_
 120
 121 ** Karaf is slow to start processing features after start.
 122
 123 *** **Workaround:** Use a wait loop to continue only when OpenDaylight starts restonding correctly
 124     to requests to the desired northbound interface.
 125     If no OpenDaylight feature is installed, use bin/client in the wait loop
 126     until Karaf SSH console starts responding.
 127
 128 End-of-life
 129 ===========
 130
 131 * All APIs and functionalities related to Karaf 3 were removed.
 132   Only Karaf 4 (or higher) will be supported from now on.
 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/Nitrogen_Release_Plan>`_
 143
 144 * Major shifts in release schedule
 145
 146   * Upstream OpenDaylight projects were slow to controbute their Karaf 4 features and debug them when needed.
 147   * While project deliverables were relatively on time, wiki updates were late,
 148     and documentation and milestone report were extremely late.