docs/release-notes/projects/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=features/singles/odl-integration-all/pom.xml;hb=refs/heads/stable/oxygen
  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-oxygen
  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;hb=refs/heads/stable/oxygen
  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-oxygen
  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;hb=refs/heads/stable/oxygen
  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-oxygen
  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;hb=refs/heads/stable/oxygen
  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-oxygen
  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 Quality Assurance
  76 =================
  77
  78 * CSIT job: https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-oxygen
  79 * No additional manual testing was needed.
  80
  81 Migration
  82 ---------
  83
  84 * Version feature works exactly the same as in Nitrogen.
  85   After migration the versions are set to the new default, configurable in runtime or via configfile.
  86
  87 Compatibility
  88 -------------
  89
  90 * Version feature works exactly the same as in Nitrogen.
  91 * Test features change every release but these are only intended for distribution test.
  92
  93 Bugs Fixed
  94 ----------
  95
  96 * `INTDIST-92 <https://jira.opendaylight.org/browse/INTDIST-92>`_
  97
  98 ** odl-distribution-version contains list of bundles instead of nice feature dependency.
  99
 100 * `ODLPARENT-142 <https://jira.opendaylight.org/browse/ODLPARENT-142>`_
 101
 102 ** Karaf-plugin packages mysql-connector-java.
 103
 104 Known Issues
 105 ------------
 106
 107 * `ODLPARENT-110 <https://jira.opendaylight.org/browse/ODLPARENT-110>`_
 108
 109 ** Successive feature installation from karaf4 console causes bundles refresh.
 110
 111 *** **Workaround:**
 112
 113   * Use --no-auto-refresh option in the karaf feature install command.
 114
 115   .. code:: bash
 116
 117     feature:install --no-auto-refresh odl-netconf-topology
 118
 119   * List all the features you need in the karaf config boot file.
 120   * Install all features at once in console, for example:
 121
 122   .. code:: bash
 123
 124     feature:install odl-restconf odl-netconf-mdsal odl-mdsal-apidocs odl-clustering-test-app odl-netconf-topology
 125
 126 * `ODLPARENT-113 <https://jira.opendaylight.org/browse/ODLPARENT-113>`_
 127
 128 ** The ssh-dss method is used by Karaf SSH console, but no longer supported by clients such as OpenSSH.
 129
 130 *** **Workaround:**
 131
 132   * Use the bin/client script, which uses karaf:karaf as the default credentials.
 133   * Use this ssh option:
 134
 135   .. code:: bash
 136
 137     ssh -oHostKeyAlgorithms=+ssh-dss -p 8101 karaf@localhost
 138
 139 ** After restart, Karaf is unable to re-use the generated host.key file.
 140
 141 *** **Workaround:** Delete the etc/host.key file before starting Karaf again.
 142
 143 End-of-life
 144 ===========
 145
 146 * Version feature is deprecated and will be removed in Flourine release.
 147
 148 Standards
 149 =========
 150
 151 No standard implemented directly (see upstream projects).
 152
 153 Release Mechanics
 154 =================
 155
 156 * `Release plan <https://wiki.opendaylight.org/view/Integration/Distribution/Oxygen_Release_Plan>`_