From 0ff3926806ef3a3fdb115faf1a3aaeaebeefd294 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Fri, 24 Jul 2020 16:07:36 -0400 Subject: [PATCH] Add R4 release notes Add new page and link for R4 release notes. Add release notes content. Change-Id: I3747b1f06d9f9b5747f73509c5c25df32da6a799 Signed-off-by: MCamp859 Signed-off-by: Bruce Jones Signed-off-by: MCamp859 --- doc/source/releasenotes/index.rst | 3 + doc/source/releasenotes/r4_release.rst | 180 +++++++++++++++++++++++++ 2 files changed, 183 insertions(+) create mode 100644 doc/source/releasenotes/r4_release.rst diff --git a/doc/source/releasenotes/index.rst b/doc/source/releasenotes/index.rst index cdd633804..b84eadabe 100644 --- a/doc/source/releasenotes/index.rst +++ b/doc/source/releasenotes/index.rst @@ -9,6 +9,8 @@ You can find details about a release on the specific release page. +------------------------+---------------------+-------------------------------+ | Version | Release Date | Notes | +========================+=====================+===============================+ +| StarlingX R4.0 | 2020-08 | :doc:`r4_release` | ++------------------------+---------------------+-------------------------------+ | StarlingX R3.0 | 2019-12 | :doc:`r3_release` | +------------------------+---------------------+-------------------------------+ | StarlingX R2.0.1 | 2019-10 | :doc:`r2_0_1_release` | @@ -26,6 +28,7 @@ You can find details about a release on the specific release page. r2_release r2_0_1_release r3_release + r4_release ------------------------------ Project-specific release notes diff --git a/doc/source/releasenotes/r4_release.rst b/doc/source/releasenotes/r4_release.rst new file mode 100644 index 000000000..d9501142c --- /dev/null +++ b/doc/source/releasenotes/r4_release.rst @@ -0,0 +1,180 @@ +================== +R4.0 Release Notes +================== + +.. contents:: + :local: + :depth: 1 + +--------- +ISO image +--------- + +The pre-built ISO and Docker images for StarlingX release 4.0 are located at +`CENGN’s StarlingX mirror +`_. + +------ +Branch +------ + +The source code for StarlingX release 4.0 is available in the r/stx.4.0 +branch in the `StarlingX repositories `_. + +---------- +Deployment +---------- + +A system install is required to deploy StarlingX release 4.0. There is no +upgrade path from previous StarlingX releases. For detailed instructions, see +the :doc:`R4.0 Installation Guides `. + +----------------------------- +New features and enhancements +----------------------------- + +The list below provides a detailed list of new features and links to the +associated user guides (if applicable). + +* Intel FPGA support for Kubernetes + + The Intel N3000 FPGA Programmable Acceleration Card is now supported + in StarlingX, including support for orchestrating updates to the + card's firmware. + + Guide: :doc:`Host FPGA Configuration for the Intel N3000 FPGA Programmable + Acceleration Card ` + +* Kata Containers + + Workloads can now be deployed in Kata Containers by StarlingX, which + provides a higher degree of isolation than workloads in generic containers. + + Guide: :doc:`How to run Kata Containers with Kubernetes on StarlingX + ` + +* Active Directory Integration for Kubernetes APIs + + StarlingX administrators can now deploy an optional system application + to support using Windows Active Directory for authentication of the + Kubernetes API. + + Guide: :doc:`Authenticate Kubernetes Users with Windows Active Directory + Server ` + +* Certificate Manager Integration + + StarlingX now provides a Certification Manager to enable automated + certificate issuance, monitor certificate expiration dates, and configure + an auto-renew process. + + Guide: :doc:`Enable secure HTTPS access and manage certificates ` + +* Time-Sensitive Networking (TSN) in Kata Containers + + Time-Sensitive Networking has been enabled for workloads running in Kata + Containers. + + Guide: :doc:`Enable TSN in Kata Containers + ` + +* Upversion OpenStack services + + The built-in OpenStack services, including Keystone, Horizon, Barbican, and + others, have been updated to Train. For more details, consult the + `OpenStack documentation for Train `_. + +* Upversion OpenStack application + + The built-in OpenStack application has been updated to Ussuri. For + more details, consult the `OpenStack documentation for Ussuri + `_. + +* Kubernetes support in backup and restore functionality + + Back up and restore is now available for workloads running in + Kubernetes pods. + + Guide: :doc:`Backup and restore your deployment ` + +* Kubernetes manual upgrade capability + + StarlingX now has the capability of updating the Kubernetes images + installed on the platform. + + Guide: :doc:`Upgrade your Kubernetes version ` + +* Redfish virtual media support + + StarlingX now supports the Redfish Virtual Media Controller to + support a secure BMC based ISO image boot. + +* Kernel rebase to 4.18 + + The Linux kernel used by StarlingX has been upgraded to version 4.18 as + provided in CentOS 8. + +* Upversion Kubernetes components + + Kubernetes was upversioned to v1.18.1, Calico was upversioned to v3.12, and + Helm was upversioned to v3. + +* Layered build + + StarlingX builds have been monolithic and time consuming. The new Layered + build system decomposes the system into separate layers that can be built + independently. Both Layered and Monolithic builds are supported in this + release. + + Guides: :doc:`Layered build reference (overview) ` + and :doc:`Layered build guide (step by step instructions) ` + +* Open Platform Communications Unified Architecture (OPC UA) support + + OPC UA is a data exchange standard for industrial communication in the + Industrial IoT (IIoT) category. StarlingX now supports OPC UA. + + Guide: :doc:`How to enable OPC UA on StarlingX ` + +---------- +Bug status +---------- + +********** +Fixed bugs +********** + +This release provides fixes for a number of defects. Refer to the StarlingX bug +database to review the `R4.0 fixed defects +`_. + +********* +Open bugs +********* + +Use the StarlingX bug database to review `R4.0 open bugs +`_. + +At the time of release, the following R4.0 bugs were open: + +* `1890350 `_ +* `1887589 `_ +* `1870999 `_ +* `1879018 `_ +* `1881915 `_ +* `1886429 `_ +* `1888546 `_ + +----------------- +Known limitations +----------------- + +The following are known limitations in this release. Workarounds +are suggested where applicable. Note that these limitations are considered +temporary and will likely be resolved in a future release. + +* `1887589 `_ Creating a + new instance with Horizon fails. + + +