Merge "Extract JIRA issues"
[docs.git] / docs / release-notes / projects / distribution.rst
index b8c1a6134d351a777166325c56f73c1154c57e0b..ec251bbeaca7e260f8e11484ad2e49a219011fd8 100644 (file)
-========================
-Integration/Distribution
-========================
-
-Major Features
-==============
-
-odl-integration-all
--------------------
-
-* **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
-* **Description:** An aggregate feature grouping all user-facing ODL features
-  which can be installed together without Karaf becoming unusable or without port conflicts.
-* **Top Level:** Yes.
-* **User Facing:** Yes, but not intended for production use (only for testing purposes).
-* **Experimental:** No.
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/job/distribution-deploy-oxygen
-
-odl-integration-compatible-with-all
------------------------------------
-
-* **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
-* **Description:** An aggregate feature grouping all user-facing ODL features
-  which are not pro-active and which (as a group) should be compatible with most other ODL features.
-* **Top Level:** Yes.
-* **User Facing:** Yes, but not intended for production use (only for testing purposes).
-* **Experimental:** No.
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-oxygen
-
-odl-distribution-version
-------------------------
-
-* **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
-* **Description:** Allows NETCONF/RESTCONF users to determine the version of ODL they are communicating with.
-* **Top Level:** Yes.
-* **User Facing:** Yes.
-* **Experimental:** No.
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-oxygen
+============
+Distribution
+============
 
-Karaf 4 distribution archive
-----------------------------
-* **Gitweb URL:** https://git.opendaylight.org/gerrit/gitweb?p=integration/distribution.git;a=blob;f=karaf/pom.xml;hb=refs/heads/stable/oxygen
-* **Description:** Zip or tar.gz; when extracted, a self-consistent ODL installation is created.
-* **Top Level:** Yes.
-* **User Facing:** Yes.
-* **Experimental:** No.
-* **CSIT Test:** https://jenkins.opendaylight.org/releng/job/distribution-deploy-oxygen
+Overview
+========
 
-Documentation
-=============
+The Distribution project is the placeholder for the ODL karaf
+distribution. The project currently generates 3 artifacts:
 
-* **Getting Started Guide**
+.. list-table:: Distribution Artifacts
+   :widths: 20 50
+   :header-rows: 1
 
-  * :ref:`Clustering scripts <getting-started-clustering-scripts>`
-  * :ref:`Distribution version <getting-started-opendaylight-version>`
+   * - **Artifact**
+     - **Description**
 
-* **User Guide:**
+   * - **Managed distribution** (e.g., ``karaf-<version>.tar.gz``)
+     - This includes the managed projects in OpenDaylight
+       (refer to, :ref:`managed-release`).
+   * - **Common distribution** (e.g., ``opendaylight-<version>.tar.gz``)
+     - This includes managed and self-managed projects
+       (refer to, :ref:`managed-release`).
+   * - **ONAP distribution** (e.g., ``onap-karaf-<version>.tar.gz``)
+     - This is the distribution used in the ONAP CCSDK project.
 
-  * :ref:`Distribution version <user-guide-dist-version>`
+The distribution project is also the placeholder for the distribution
+scripts. Example of these scripts:
 
-* **Developer Guide**
+* :ref:`Clustering scripts in Distribution <getting-started-clustering-scripts>`
 
-  * :ref:`Test features <developer-guide-dist-test-features>`
-  * :ref:`Distribution version <developer-guide-dist-version>`
-
-Security Considerations
-=======================
-
-* Karaf 4 exposes ssh console on port 8101.
-  The security basically basically the same as in upstream Karaf of corresponding versions,
-  except library version overrides implemented in odlparent:karaf-parent.
+Behavior/Feature Changes
+========================
 
-  See :ref:`securing-karaf`
+Here is the link to the features improved in this release:
 
-Quality Assurance
-=================
+`OpenDaylight JIRA Tickets - Improvement <https://jira.opendaylight.org/issues/?jql=project+%3D+distribution+AND+type+%3D+Improvement+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28%22Silicon+GA%22%2C+Silicon%2C+silicon%29++ORDER+BY+issuetype+DESC%2C+key+ASC>`_
 
-* CSIT job: https://jenkins.opendaylight.org/releng/job/distribution-csit-1node-userfeatures-all-oxygen
-* No additional manual testing was needed.
+New Features
+============
 
-Migration
----------
+Here is the link to the new features introduced in this release:
 
-* Version feature works exactly the same as in Nitrogen.
-  After migration the versions are set to the new default, configurable in runtime or via configfile.
+`OpenDaylight JIRA Tickets - New Feature <https://jira.opendaylight.org/issues/?jql=project+%3D+distribution+AND+type+%3D+%22New+Feature%22+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28%22Silicon+GA%22%2C+Silicon%2C+silicon%29++ORDER+BY+issuetype+DESC%2C+key+ASC>`_
 
-Compatibility
--------------
+Deprecated Features
+===================
 
-* Version feature works exactly the same as in Nitrogen.
-* Test features change every release but these are only intended for distribution test.
+Here is the link to the features removed in this release:
 
-Bugs Fixed
-----------
+`OpenDaylight JIRA Tickets - Deprecated Feature <https://jira.opendaylight.org/issues/?jql=project+%3D+distribution+AND+type+%3D+Deprecate+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28%22Silicon+GA%22%2C+Silicon%2C+silicon%29++ORDER+BY+issuetype+DESC%2C+key+ASC>`_
 
-* `INTDIST-92 <https://jira.opendaylight.org/browse/INTDIST-92>`_
+Resolved Issues
+===============
 
-** odl-distribution-version contains list of bundles instead of nice feature dependency.
+Here is the link to the resolved issues fixed in this release:
 
-* `ODLPARENT-142 <https://jira.opendaylight.org/browse/ODLPARENT-142>`_
+`OpenDaylight JIRA Tickets - Resolved Issue <https://jira.opendaylight.org/issues/?jql=project+%3D+distribution+AND+type+%3D+Bug+AND+status+in+%28Resolved%2C+Done%2C+Closed%29+AND+fixVersion+in+%28%22Silicon+GA%22%2C+Silicon%2C+silicon%29++ORDER+BY+issuetype+DESC%2C+key+ASC>`_
 
-** Karaf-plugin packages mysql-connector-java.
 
 Known Issues
-------------
-
-* `ODLPARENT-110 <https://jira.opendaylight.org/browse/ODLPARENT-110>`_
-
-** Successive feature installation from karaf4 console causes bundles refresh.
-
-*** **Workaround:**
-
-  * Use --no-auto-refresh option in the karaf feature install command.
-
-  .. code:: bash
-
-    feature:install --no-auto-refresh odl-netconf-topology
-
-  * List all the features you need in the karaf config boot file.
-  * Install all features at once in console, for example:
-
-  .. code:: bash
-
-    feature:install odl-restconf odl-netconf-mdsal odl-mdsal-apidocs odl-clustering-test-app odl-netconf-topology
-
-* `ODLPARENT-113 <https://jira.opendaylight.org/browse/ODLPARENT-113>`_
-
-** The ssh-dss method is used by Karaf SSH console, but no longer supported by clients such as OpenSSH.
-
-*** **Workaround:**
-
-  * Use the bin/client script, which uses karaf:karaf as the default credentials.
-  * Use this ssh option:
-
-  .. code:: bash
-
-    ssh -oHostKeyAlgorithms=+ssh-dss -p 8101 karaf@localhost
-
-** After restart, Karaf is unable to re-use the generated host.key file.
-
-*** **Workaround:** Delete the etc/host.key file before starting Karaf again.
-
-End-of-life
-===========
-
-* Version feature is deprecated and will be removed in Flourine release.
-
-Standards
-=========
-
-No standard implemented directly (see upstream projects).
+============
 
-Release Mechanics
-=================
+Here is the link to the known issues exist in this release:
 
-* `Release plan <https://wiki.opendaylight.org/view/Integration/Distribution/Oxygen_Release_Plan>`_
+`OpenDaylight JIRA Tickets - Known Issue <https://jira.opendaylight.org/issues/?jql=project+%3D+distribution+AND+type+%3D+Bug+AND+status+not+in+%28Resolved%2C+Done%2C+Closed%29+ORDER+BY+issuetype+DESC%2C+key+ASC>`_