From 88cce5072757c1d37443309a8f28924ca12877a3 Mon Sep 17 00:00:00 2001 From: Andrei Gherzan <andrei.gherzan@huawei.com> Date: Mon, 21 Nov 2022 11:55:52 +0000 Subject: [PATCH] Add 2.0.0 release notes Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com> --- releases/2.0/2.0.0/index.rst | 19 +++ releases/2.0/2.0.0/release_notes.rst | 201 +++++++++++++++++++++++++++ releases/2.0/2.0.0/requirements.rst | 117 ++++++++++++++++ releases/index.rst | 1 + 4 files changed, 338 insertions(+) create mode 100644 releases/2.0/2.0.0/index.rst create mode 100644 releases/2.0/2.0.0/release_notes.rst create mode 100644 releases/2.0/2.0.0/requirements.rst diff --git a/releases/2.0/2.0.0/index.rst b/releases/2.0/2.0.0/index.rst new file mode 100644 index 0000000..308a386 --- /dev/null +++ b/releases/2.0/2.0.0/index.rst @@ -0,0 +1,19 @@ +.. SPDX-FileCopyrightText: Huawei Inc. +.. +.. SPDX-License-Identifier: CC-BY-4.0 + +.. include:: ../../../definitions.rst + +2.0.0 +##### + +**Release timeframe**: 2022-03-07 .. 2022-11-30 + +**Release Artefacts Download Area**: https://download.eclipse.org/oniro-core/releases/2.0.0/ + +.. toctree:: + :maxdepth: 1 + + release_notes + requirements + ip_compliance_note diff --git a/releases/2.0/2.0.0/release_notes.rst b/releases/2.0/2.0.0/release_notes.rst new file mode 100644 index 0000000..5db98c9 --- /dev/null +++ b/releases/2.0/2.0.0/release_notes.rst @@ -0,0 +1,201 @@ +.. SPDX-FileCopyrightText: Huawei Inc. +.. +.. SPDX-License-Identifier: CC-BY-4.0 + +.. include:: ../../../definitions.rst + +Release Notes +############# + +About +***** + +The objective of this document is to provide basic introductory information +about included functionalities, known issues and instructions guidance for the +2.0.0 release of the |main_project_name| project. + +The |main_project_name| project serves as a solid base foundation for products. +It is not a standalone product itself but rather a platform that aims at +accelerating the development and maintenance of other projects and products. + +During this release, the project's code and most of its infrastructure moved to +Eclipse Foundation as one of the top-level projects. This follows the fact that +|main_project_name| became an Eclipse Foundation project during a preview +release iteration. + +Scope +***** + +The Objectives of the Release +----------------------------- + +The objective of the *2.0.0* release is to consolidate the features previously +released, add new outstanding features and meet the requirements defined by the +Eclipse Foundation Development Process. That includes, but is not limited to: + +- Migration of code to Eclipse Foundation +- Work towards migration of the project's infrastructure to Eclipse Foundation + (eg. CI, pipelines, etc.) +- Hardware & Software roadmap expansion +- Deployment of the IP compliance toolchain and related policies +- Security and maintenance featuring CVE fixes, LEDGE support, etc. + +The List of Software Features Included +-------------------------------------- + +- Linux Kernel LTS version supported for all ARM and X86 targets +- Zephyr kernel 3.1 supported for all ARM and X86 targets +- Over-the-Air system update, including integration with hawkbit and SysOTA + backends +- Toolchain package upgrades including LLVM, GCC, musl, etc. +- Matter 1.0 and Thread 1.2 support +- Modbus support with RTU (over RS485) and TCP modes +- New hardware supported: Raspberry Pi 3, SECO (SBC-C61, SBC-B68, SBC-D23), + QEMU ARM 32/64bit, Arduino Nano 33 BLE +- Development and integration of functional testing suites +- Integration of standard test toolkits (eg. LTP) +- More LAVA support development including new LAVA nodes +- Security OS features targeting runtime and build-time (:ref:`SecurityGuide`) +- Development for security-oriented features for Oniro upgrades and CVE fixes +- Upstream contributions in terms of fixes, backports and CVE issues +- Repackaging of |main_project_name| from monolithic to modular, leveraging the + Yocto Project layer architecture, as well as the Eclipse Foundation + sub-project structure +- Split Blueprints, Sysota, and OpenHarmony components into their sub-project + +For more details, a full list of requiremnts can be seen +:ref:`here<2_0_0_Requirements>`. + +Supported Hardware Platforms +---------------------------- + ++---------------------------------+-------------------+---------------------------------------+ +| Board (chipset) | Supported kernels | Board documentation | ++=================================+===================+=======================================+ +| QEMU X86 | Linux & Zephyr | :ref:`SupportedVBoardQemuX86` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU X86-64 | Linux | :ref:`SupportedVBoardQemuX86-64` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU ARM (EFI) | Linux | :ref:`SupportedVBoardQemuARM` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU ARM64 (EFI) | Linux | :ref:`SupportedVBoardQemuARM64` | ++---------------------------------+-------------------+---------------------------------------+ +| QEMU Cortex M3 | Zephyr | :ref:`Zephyr_Kernel` | ++---------------------------------+-------------------+---------------------------------------+ +| SECO SBC-B68 | Linux | :ref:`SupportedBoardSecoB68` | ++---------------------------------+-------------------+---------------------------------------+ +| SECO SBC-C61 | Linux | :ref:`SupportedBoardSecoC61` | ++---------------------------------+-------------------+---------------------------------------+ +| SECO SBC-D23 | Linux | :ref:`SupportedBoardSecoD23` | ++---------------------------------+-------------------+---------------------------------------+ +| Raspberry Pi 4 B (BCM2711) | Linux | :ref:`raspberrypi` | ++---------------------------------+-------------------+---------------------------------------+ +| Raspberry Pi 3 B+ (BCM2837B0) | Linux | :ref:`raspberrypi` | ++---------------------------------+-------------------+---------------------------------------+ +| Arduino Nano 33 BLE | Zephyr | :ref:`SupportedBoardArduinoNano33BLE` | ++---------------------------------+-------------------+---------------------------------------+ + +Test Report +----------- + +TODO + +Installation +************ + +:ref:`Quick Build <OniroQuickBuild>` provides an example of how to build the +|main_project_name| project for an example target. Visit the :ref:`Hardware +Support <HardwareSupport>` section for instructions on how to build for other +supported targets. + +Visit :ref:`setting up a repo workspace <RepoWorkspace>` for instructions how +to prepare the workspace for development. Since |main_project_name| uses `repo` +tool for its development, you can use the release tag for the `repo init` +commands as follows: + +.. code-block:: console + + repo init -u https://gitlab.eclipse.org/eclipse/oniro-core/oniro.git -b v2.0.0 + +Known Issues +------------ + +Visit `this link +<https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/issues/?sort=label_priority_desc&state=all&label_name%5B%5D=KnownIssue%3A%3ARelease2.0.0&first_page_size=20>`__ +to see known issues for this release. + +Source Code +----------- + +For more details on our repo structure, see `OniroProject's GitLab +<https://gitlab.eclipse.org/eclipse/oniro-core>`__ project group. + +DevOps Infrastructure +********************* + +To learn more about our approach to CI (Continuous Integration) strategy used +for this release, please see: + +:doc:`/ci/index` document. + +Testing +------- + +Details can be found in: + +:doc:`/ci/device-testing` document. + +IP Compliance +------------- + +This release comes with a detailed `IP Compliance note` accesible +:ref:`here<2_0_0_IPComplianceNote>`. + +Out of Scope +************ + +|main_project_name| bundles components from multiple upstream sources. These +upstream sources come with features that the project might not explicitly +mention as part of its supportability policy. Similarly, |main_project_name| +includes supported features that are explicitly marked as 'experimental'. All +these cases, mainly driven by the community, will imply basic support from the +project. + +|main_project_name| exercises an upstream-first support policy, so even for +cases that are not strictly in the supportability scope of the project, +|main_project_name| will provide guidance and traceability while facilitating +the upstream effort. + +Contributions +************* + +If you are a developer eager to know more details about |main_project_name| or +just an enthusiast with a patch proposal, you are welcome to participate in our +|main_project_name| ecosystem development. To do so, please sign-up using the +process described below: + +:doc:`/contributing/index` document. + +License +******* + +Project manifest, project-specific meta-layers, recipes, and software packages +are published under the MIT license unless specified otherwise. The whole +operating system built by users from the project manifest is an aggregate +comprised of many third-party components or component groups, each subject to +its license conditions. + +Official project release includes only the project manifest, project-specific +meta-layers, and recipes. Any reference binary image, build cache, and other +build artefacts are distributed only as a convenience and are not part of the +release itself. + +.. note:: + + "supported" `referred to a board` means that a board is officially targeted + as a potential platform where an Oniro image can be installed for any + purposes; when `referred to an image`, means that the image targeting a + supported board receives thorough testing and specific attention during the + development. It does NOT mean that both will receive support services nor + that any member of the Oniro Working Group or of the Eclipse Foundation will + provide any warranty whatsoever. diff --git a/releases/2.0/2.0.0/requirements.rst b/releases/2.0/2.0.0/requirements.rst new file mode 100644 index 0000000..fb586fa --- /dev/null +++ b/releases/2.0/2.0.0/requirements.rst @@ -0,0 +1,117 @@ +.. SPDX-FileCopyrightText: Huawei Inc. +.. +.. SPDX-License-Identifier: CC-BY-4.0 + +.. include:: ../../../definitions.rst + +.. _2_0_0_Requirements: + +Release Requirements +#################### + +The development process in |main_project_name| is based on requirements. They +represent in a written form, the aims of a release that satisfy them. The +`2.0.0` release, includes the following requirements that were addressed during +its development cycle: + ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Domain |Feature/deliverable |Gitlab Epics/Issues | ++======================+==========================================================+=======================================================================================================================================================================+ +|Kernels |Linux 5.1x LTS |`Linux kernel LTS version for ARM and X86 targets <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/58>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Zephyr LTS |`Zephyr kernel version 3.1 for X86 and ARM targets <https://gitlab.eclipse.org/groups/ec¨lipse/oniro-core/-/epics/10>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|OTA |System OTA Linux |`System OTA - Linux target <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/18>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |System OTA end-to-end including cloud backend |`OTA Cloud Backend Integration <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/10>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Toolchains |Toolchain LTS |`Toolchain LTS version <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/1>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |LLVM |`Toolchain LLVM Integration <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/85>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |GCC |`Toolchain GCC Integration <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/84>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Toolchain GCC CI Integration <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/86>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Networking |RS485, Modbus RTU and TCP |`RS485, Modbus RTU and TCP support <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/11>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |OpenThread 1.2 |`OpenThread update to support Thread 1.2 <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/6>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Matter for Linux |`Matter network protocol support for Linux <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/5>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Research and Document the Project Matter specification version Goofy will be compatible with <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/445>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Reference Hardware |Seco SBC C61 - NXP i.MX8M Mini - Linux |`SECO ASTRID (SBC-C61) - Linux <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/34>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Seco SBC B68 - Intel Atom - Linux |`SECO ALVIN - SBC-B68 - Linux <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/35>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Seco D23 - Rockchip - Linux and Zephyr |`SECO JUNO (SBC-D23) - Linux <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/38>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Arduino Nano BLE - Zephyr |`Arduino Nano BLE - Zephyr <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/32>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |RPi 3/4 - Linux |`Raspberry Pi 3/4 - Linux <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/33>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |QEMU for Intel, ARM - Linux, Zephyr |`QEMU targets <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/41>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Infrastructure |Eclipse Foundation migration |`Eclipse Foundation migration <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/139>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Testing |Completion of LAVA testing infrastructure |`Complete LAVA testing infrastructure <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/14>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Additional lab online - NOI Techpark |`Setup an Oniro HW LAVA lab at NOI Techpark <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/253>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Enable functional verification Oniro HW LAVA lab at NOI Techpark <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/254>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Additional lab online - Kalpa |`LAVA node setup in Kalpa <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/592>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |More DUTs - Warsaw lab |`Add one more RPi4 to the WRC lab <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/569>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Add one more C61 to the WRC lab <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/646>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Periodic report of functional and performance verification|`Periodic reporting of results of functional testing and performance benchmarking <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/15>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Integration of standard test toolkits |`Add LTP test plan across the board <https://git.ostc-eu.org/OSTC/infrastructure/infrastructure-maintenence/-/issues/30>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Integration of functional test suites |`Integration of functional test suites into Oniro CI <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/46>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Documentation & UX |Tests of all reference platforms code after migration |`UX: Test the code on all reference platforms after migrate repos to Eclipse Foundation <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/133>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Tests of blueprints code building |`UX: Blueprints Code Build I Retest [booting.oniro.org] <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/137>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|Security & Maintenance|Secure-by-default Linux images |`Debug/production builds <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/140>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`User and login hardening <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/130>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Security processes for Goofy <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/111>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Document security hardening options and decisions <https://gitlab.eclipse.org/eclipse/oniro-core/docs/-/issues/14>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Security, Vulnerability, Bugfix management tools |`Yocto SBOM generation tool in Oniro <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/101>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`JSON-based output of cve-check <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/98>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Integrate bugfix and security data into the IP toolchain dashboard <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/121>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Oniro upgrade delta check tool <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/100>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |LEDGE RP Compatibility for Oniro |`Use meta-ledge in Oniro <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/112>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Use meta-ts in Oniro <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/113>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Research and Document the target LEDGE Release for Goofy inclusion <https://gitlab.eclipse.org/eclipse/oniro-core/oniro/-/issues/446>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |CVE Fixes |`CVE fixes March 2022 <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/138>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`June CVE fixes <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/146>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`July CVE fixes <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/150>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`August CVE fixes <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/155>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| |Upstream security issues backports |`Kirkstone backports for April 2022 <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/141>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`Kirkstone backports for May 2022 <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/142>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`June backports to kirkstone <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/144>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| | |`August backports to kirkstone <https://gitlab.eclipse.org/groups/eclipse/oniro-core/-/epics/154>`_ | ++----------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/releases/index.rst b/releases/index.rst index 986aab9..8b0041a 100644 --- a/releases/index.rst +++ b/releases/index.rst @@ -14,3 +14,4 @@ This section contains information related to releases of |main_project_name|. aladeen/0.1.0/release_notes jasmine/1.0.0/release_notes + 2.0/2.0.0/index -- GitLab