Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Iad0b8cd373aaa70dc4ad56c6416fbeae4fb8ccc0
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| Main documentation areas | Description |
+=================================================================================+===============================================================================================+
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| Main documentation areas | Description |
+=================================================================================+===============================================================================================+
- | :ref:`ONAP Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,|
+ | :ref:`ONAP 'Jakarta' Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,|
| | feature enhancements, or bug fixes. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Project Specific Release Notes <doc-releaserepos>` | The Project Specific Release Notes are providing information about recent changes, feature |
| | feature enhancements, or bug fixes. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`Project Specific Release Notes <doc-releaserepos>` | The Project Specific Release Notes are providing information about recent changes, feature |
| | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is |
| | subject to be reviewed, updated and migrated to the ONAP Documentation Guide. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is |
| | subject to be reviewed, updated and migrated to the ONAP Documentation Guide. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed |
+ | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. You can learn about discovered and fixed|
| | vulnerabilities. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
| | vulnerabilities. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
-Jakarta Release Notes
-^^^^^^^^^^^^^^^^^^^^^
+ONAP 'Jakarta' Release Notes
+============================
-This page provides the release notes for the ONAP Jakarta release. This
+This page provides the release notes for the ONAP 'Jakarta' release. This
includes details of software versions, known limitations, and outstanding
trouble reports.
includes details of software versions, known limitations, and outstanding
trouble reports.
maintained in the component specific release notes.
Jakarta Major Release 10.0.0
maintained in the component specific release notes.
Jakarta Major Release 10.0.0
-============================
+----------------------------
+--------------------------------------+--------------------------------------+
| **Project** | Open Network Automation Platform |
+--------------------------------------+--------------------------------------+
| **Project** | Open Network Automation Platform |
+--------------------------------------+--------------------------------------+
Features
+--------------------------------------+--------------------------------------+
Features
ONAP Jakarta focusses on:
- Security enhancements in the A&AI, CCSDK, MSB, and MultiCloud projects,
ONAP Jakarta focusses on:
- Security enhancements in the A&AI, CCSDK, MSB, and MultiCloud projects,
and KubeRef RI2
Functional Requirements
and KubeRef RI2
Functional Requirements
Increased Cloud Native Functionality
Increased Cloud Native Functionality
-....................................
+""""""""""""""""""""""""""""""""""""
- Improved synchronization of k8s resources after the creation of the CNF.
When some change occurs for the CNF in the k8s cluster, k8splugin sends
- Improved synchronization of k8s resources after the creation of the CNF.
When some change occurs for the CNF in the k8s cluster, k8splugin sends
- New model for CNF modeling: Application Service Descriptor (ASD) model
E2E Network Slicing
- New model for CNF modeling: Application Service Descriptor (ASD) model
E2E Network Slicing
- CPS Integration with SDN-R for RAN Slice allocate and reconfigure scenarios
- E2E network Slicing with CPS is completed for allocation and re-use scenarios
- CPS Integration with SDN-R for RAN Slice allocate and reconfigure scenarios
- E2E network Slicing with CPS is completed for allocation and re-use scenarios
- Closed-loop enhancement in CCVPN to support Transport Slicing’s closed-loop
Control Loop evolutions
- Closed-loop enhancement in CCVPN to support Transport Slicing’s closed-loop
Control Loop evolutions
- Control Loop in TOSCA LCM Improvement: abstract Automation Composition
Management (ACM) logic with a generic Automation Composition definition,
- Control Loop in TOSCA LCM Improvement: abstract Automation Composition
Management (ACM) logic with a generic Automation Composition definition,
- Scripts are added to make release of the Policy Framework easier
Fault management
- Scripts are added to make release of the Policy Framework easier
Fault management
- DCAE Helm Transformation finalized
- Topic alignment for DCAE microservices: use standard topics for PM-Mapper,
Slice-Analysis and KPI-MS
Extended O-RAN Integration
- DCAE Helm Transformation finalized
- Topic alignment for DCAE microservices: use standard topics for PM-Mapper,
Slice-Analysis and KPI-MS
Extended O-RAN Integration
-..........................
+""""""""""""""""""""""""""
- The O-RAN A1 interface (from the CCSDK project) provides a flexible way for
RAN operators to manage wide area RAN network optimization
- The O-RAN A1 interface (from the CCSDK project) provides a flexible way for
RAN operators to manage wide area RAN network optimization
- SDN-C is upgraded to OpenDaylight Phosphorus release
- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
Service Design
- SDN-C is upgraded to OpenDaylight Phosphorus release
- Enhancements to CCVPN, Network Slicing, and ONAP A1 Interface
Service Design
- Improved support for TOSCA features
- Automation Composition Management model
- Support for large CSAR via S3 storage
Inventory
- Improved support for TOSCA features
- Automation Composition Management model
- Support for large CSAR via S3 storage
Inventory
- Schema updated for CCVPN use case mainly enhancing and bug fixes of the Cloud
Leased Line (CLL) service
ONAP Operations Manager
- Schema updated for CCVPN use case mainly enhancing and bug fixes of the Cloud
Leased Line (CLL) service
ONAP Operations Manager
- Introduction of Strimzi Kafka Operator
- Migration of all Kafka native clients to use Strimzi Apache Kafka.
- Disable VID, Portal
Non-Functional Requirements
- Introduction of Strimzi Kafka Operator
- Migration of all Kafka native clients to use Strimzi Apache Kafka.
- Disable VID, Portal
Non-Functional Requirements
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following 'non-functional' requirements are followed in the
Jakarta Release:
Best Practice
The following 'non-functional' requirements are followed in the
Jakarta Release:
Best Practice
- ONAP shall use STDOUT for logs collection
- IPv4/IPv6 dual stack support in ONAP
- ONAP shall use STDOUT for logs collection
- IPv4/IPv6 dual stack support in ONAP
- No root (superuser) access to database from application container
Code Quality
- No root (superuser) access to database from application container
Code Quality
- Each ONAP project shall improve its CII Badging score by improving input
validation and documenting it in their CII Badging site
- Each ONAP project shall improve its CII Badging score by improving input
validation and documenting it in their CII Badging site
least 55% code coverage
Security
least 55% code coverage
Security
- Python language 3.8
- Java language v11
- Python language 3.8
- Java language v11
Tools for automated SBOM creation are now rolled into the CI chain of ONAP
Documentation
Tools for automated SBOM creation are now rolled into the CI chain of ONAP
Documentation
- Documentation cleaned up. Chapters which include unmaintained projects were
removed to avoid misunderstandings at the readership
- Documentation cleaned up. Chapters which include unmaintained projects were
removed to avoid misunderstandings at the readership
- The guide to set up a development system for documentation is updated
Tests & Integration
- The guide to set up a development system for documentation is updated
Tests & Integration
- Create Java and Python base images
- Adapt robot tests to DCAE project changes: Cloudify to Helm migration
- Create Java and Python base images
- Adapt robot tests to DCAE project changes: Cloudify to Helm migration
Some non-functional requirements are not fully finalized. Please, check details
on the :doc:`Integration<usecases/release_non_functional_requirements>`
Some non-functional requirements are not fully finalized. Please, check details
on the :doc:`Integration<usecases/release_non_functional_requirements>`
-Project Specific Release Notes
-==============================
-ONAP releases are specified by a list of project artifact versions in the
-project repositories and Docker container image versions listed in the OOM
-Helm charts.
-
-Each project provides detailed :ref:`release notes<doc-releaserepos>`
-and prepends to these if/when any updated versions the project team believes
-are compatible with a major release are made available.
+Documentation Sources
+^^^^^^^^^^^^^^^^^^^^^
-Documentation
-=============
-ONAP Jakarta Release provides a set selection of documents,
-see :ref:`ONAP Documentation<master_index>`.
+The formal ONAP 'Jakarta' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
-The `developer wiki <http://wiki.onap.org>`_ remains a good source of
+The `Developer Wiki <http://wiki.onap.org>`_ remains a good source of
information on meeting plans and notes from committees, project teams and
community events.
CII Best Practice
information on meeting plans and notes from committees, project teams and
community events.
CII Best Practice
ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
.. index:: maturity
ONAP Maturity Testing Notes
.. index:: maturity
ONAP Maturity Testing Notes
-===========================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
For the Jakarta release, ONAP continues to improve in multiple areas of
Scalability, Security, Stability and Performance (S3P) metrics.
For the Jakarta release, ONAP continues to improve in multiple areas of
Scalability, Security, Stability and Performance (S3P) metrics.
More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
Known Issues and Limitations
More details in :ref:`ONAP Integration Project<onap-integration:master_index>`
Known Issues and Limitations
-============================
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Known Issues and limitations are documented in each
:ref:`project Release Notes <doc-releaserepos>`.
Known Issues and limitations are documented in each
:ref:`project Release Notes <doc-releaserepos>`.
:orphan:
Project Specific Release Notes
:orphan:
Project Specific Release Notes
-++++++++++++++++++++++++++++++
+==============================
-.. toctree::
- :maxdepth: 1
-
--------------------------------------------------------------------------------
+ONAP releases are specified by a list of project artifact versions in the
+project repositories and Docker container image versions listed in the OOM
+Helm charts. Each project provides detailed release notes and prepends to these
+if/when any updated versions the project team believes are compatible with a
+major release are made available.
AAI - Active and Available Inventory
------------------------------------
AAI - Active and Available Inventory
------------------------------------
Code Review / doc.git / commitdiff