docs: fix the bullet list for release-notes.rst
[pti/rtp.git] / docs / release-notes.rst
index 0359af4..a59d9cc 100644 (file)
@@ -1,17 +1,19 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (C) 2019 - 2022 Wind River Systems, Inc.
 
 
-Release-Notes
-=============
+INF Release Notes
+=================
 
 
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document provides the release notes for 6.0.0 of INF RTP.
 
-.. contents::
-   :depth: 3
-   :local:
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
 
+   release-notes.rst
 
 Version history
 ---------------
@@ -20,150 +22,89 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              |                    | First draft        |
+| 2019-11-02         | 1.0.0              | Jackie Huang       | Initial Version    |
+|                    |                    |                    | Amber Release      |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-06-14         | 2.0.0              | Xiaohua Zhang      | Bronze Release     |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
+| 2020-11-23         | 3.0.0              | Xiaohua Zhang      | Cherry Release     |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
+| 2021-06-29         | 4.0.0              | Xiaohua Zhang      | Dawn Release       |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2021-12-15         | 5.0.0              | Jackie Huang       | E Release          |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2022-06-15         | 6.0.0              | Jackie Huang       | F Release          |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
-
-Summary
--------
-
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
-
-
-
-
-Release Data
-------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
-
-+--------------------------------------+--------------------------------------+
-| **Project**                          | E.g. project                                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | E.g. Arno RC2                        |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | E.g. 2015-04-16                      |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-
-
-
-Feature Additions
-^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
-**JIRA BACK-LOG:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-Bug Corrections
-^^^^^^^^^^^^^^^
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-Deliverables
-^^^^^^^^^^^^
-
-Software Deliverables
-+++++++++++++++++++++
-
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
-
-Documentation Deliverables
-++++++++++++++++++++++++++
-
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
-
-
-Known Limitations, Issues and Workarounds
------------------------------------------
-
-System Limitations
-^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
-
-
-
-Known Issues
-^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
-
-<EXAMPLE>:
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-|                                     |                                      |
-|                                      |                                     |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-
-Workarounds
-^^^^^^^^^^^
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
-
-
-References
-----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
-
+Version 6.0.0, 2022-06-15
+-------------------------
+#. Sixth version (F release)
+#. INF MultiOS support:
+   * Add support for CentOS as the base OS
+   * Two images will be provided:
+     * Yocto based image
+     * CentOS based image
+
+#. Enable three deployment modes on Yocto based image:
+   * AIO simplex mode
+   * AIO duplex mode (2 servers with High Availabity)
+   * AIO duplex mode (2 servers with High Availabity) with additional worker node
+
+#. Enable four deployment modes on CentOS based image:
+   * AIO simplex mode
+   * AIO duplex mode (2 servers with High Availabity)
+   * AIO duplex mode (2 servers with High Availabity) with additional worker node
+   * Distributed Cloud
+
+Version 5.0.0, 2021-12-15
+-------------------------
+#. Fifth version (E release)
+#. Upgrade most components to align with StarlingX 5.0
+#. Enable three deployment modes:
+   * AIO simplex mode
+   * AIO duplex mode (2 servers with High Availabity)
+   * AIO duplex mode (2 servers with High Availabity) with additional worker node
+
+Version 4.0.0, 2021-06-29
+-------------------------
+#. Fourth version (D release)
+#. Enable the AIO duplex mode (2 servers with High Availabity) with additional worker node.
+#. Reconstruct the repo to align the upstream projects include StarlingX and Yocto
+
+Version 3.0.0, 2020-11-23
+-------------------------
+#. Third version (Cherry)
+#. Based on version 2.0.0 (Bronze)
+#. Add the AIO (all-in-one) 2 servers mode (High Availability)
+
+Version 2.0.0, 2020-06-14
+-------------------------
+#. Second version (Bronze)
+#. Based on Yocto version 2.7
+#. Linux kernel 5.0 with preempt-rt patches
+#. Leverage the StarlingX 3.0
+#. Support the AIO (all-in-one) deployment scenario
+#. With Software Management, Configuration Management, Host Management, Service Management, and Service Management enabled for IA platform
+#. Support the Kubernetes Cluster for ARM platform (verified by NXP LX2160A)
+#. With the ansbile bootstrap supported for IA platform
+
+
+Version 1.0.0, 2019-11-02
+-------------------------
+#. Initial Version
+#. Based on Yocto version 2.6 ('thud' branch)
+#. Linux kernel 4.18.41 with preempt-rt patches
+#. Add Docker-18.09.0, kubernetes-1.15.2
+#. Add kubernetes plugins:
+   * kubernetes-dashboard-1.8.3
+   * flannel-0.11.0
+   * multus-cni-3.3
+   * node-feature-discovery-0.4.0
+   * cpu-manager-for-kubernetes-1.3.1