update architecture description
[doc.git] / docs / release / index.rst
index c3bcba2..555ca8b 100644 (file)
-.. This work is licensed under a Creative Commons Attribution 4.0
-   International License. http://creativecommons.org/licenses/by/4.0
+..
+  This work is licensed under a Creative Commons Attribution 4.0
+  International License. http://creativecommons.org/licenses/by/4.0
 
 
-.. _casablancarelease-notes:
+.. _onap-release-notes:
 
-Dublin Release Notes
-^^^^^^^^^^^^^^^^^^^^
+'NewDelhi' Release Notes
+========================
 
-This page provides the release notes for the ONAP Dublin release. This includes details of software versions used, known limitations, and
-outstanding trouble reports.
+This page provides the release notes for the ONAP 'NewDelhi' release. This
+includes details of software versions, known limitations, and outstanding
+trouble reports.
 
-Release notes are cumulative for the release, meaning this release note for the Dublin release will have an entry for each Major, Minor, and Maintenance
-release, if applicable. Information that is applicable regardless of release is included in the `Getting Started With ONAP`_ section of this
-document.
+Release notes are cumulative for the release, meaning this release note will
+have an entry for each Major, Minor, and Maintenance release, if applicable.
 
-Each component within the ONAP solution maintains their own component level release notes and links to those release notes are provided below.
-Details on the specific items delivered in each releaese by each component is maintained in the component specific release notes.
+Each component within the ONAP solution maintains their own component level
+release notes and links to those release notes are provided below.
+Details on the specific items delivered in each release by each component is
+maintained in the component specific release notes.
 
-Dublin Major Release 4.0.0
-==========================
+'NewDelhi' Major Release 14.0.0
+-------------------------------
 
-* Release Name: Dublin
-* Release Version: 4.0.0
-* Release Date: , 2019
++-----------------------------------+-----------------------------------------+
+| **Project**                       | Open Network Automation Platform (ONAP) |
++-----------------------------------+-----------------------------------------+
+| **Release name**                  | NewDelhi                                |
++-----------------------------------+-----------------------------------------+
+| **Release version**               | 14.0.0                                  |
++-----------------------------------+-----------------------------------------+
+| **Release date**                  | 2024, not released yet                  |
++-----------------------------------+-----------------------------------------+
 
-The Dublin 4.0.0 is the first release for Dublin.
+ONAP is evolving. We took efforts in streamlining processes and roles and
+NewDelhi release is the first one with agreed simplified software development
+life cycle governance.
 
-.. _getting-started:
+OpenSSF Gold Standard
+---------------------
 
-Getting Started With ONAP
-=========================
+We are proud to announce that first ONAP project achieved OpenSSF Gold
+standard. It will give ONAP consumers great confidence in the quality,
+security, and reliability of CPS.
 
-Summary
+Java 17
 -------
-ONAP provides a comprehensive platform for real-time, policy-driven
-service orchestration and automation including virtual network functions and
-applications instantiation and configuration, but also physical network
-functions configuration.
-ONAP will enable software, network, IT and cloud providers and developers
-to rapidly automate new services and support complete life cycle management.
-By unifying member resources, ONAP will accelerate the development of a
-vibrant ecosystem around a globally shared architecture and implementation
-for network automation-with an open standards focus-faster than any one
-product could on its own.
 
-Functionality
--------------
-**Portal** - a single, consistent user experience for both design time
-and run time environments, based on the user’s role.
+First ONAP projects (CCSDK, CPS, UUI and Policy) completed their upgrades to
+Java 17. Spring boot (uplift to v3.1.2) and OpenApi 3 upgrades were also
+performed. These upgrades allow benefits of patched vulnerabilities and
+software efficiencies in the latest versions.
 
-**Design Time Framework** - a comprehensive development environment with
-tools, techniques, and repositories for defining/describing resources,
-and services:
+CPS
+---
 
- - Service Design and Creation (SDC) provides tools, techniques, and
-   repositories to define/simulate/certify system assets as well as their
-   associated processes and policies.
+ONAP CPS project continued efforts in improvement of read/write, query
+operations, and huge reduction of memory consumption allowing for improved
+query performance and improve stability.
 
- - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP)
-   with tools for VNF supplier packaging and validation.
+Modeling
+--------
 
- - Policy Creation (POLICY) deals with conditions, requirements,
-   constraints, attributes, or needs that must be provided, maintained,
-   and/or enforced.
+Modeling project added provision of YANG modules automation tools, which helps
+improve the YANG development efficiency and check the version update of the
+YANG model.
 
- - Closed Loop Automation Management Platform (CLAMP) provides a method
-   for designing and managing control loops.
+OOM
+---
 
- - Optimization Framework (OOF) provides a policy-driven and model-driven
-   framework for creating optimization applications.
+OOM project team added support for Gateway-API in Ingress template (13.0.1) as
+well as support for mariadb-operator (13.0.2). All ONAP MariaDB instances will
+now be created with the latest version by default using the mariaDB-operator.
+Added Galera clients (e.g. SO, SDNC) will use access to "primary" pod to avoid
+"Deadlocks". Additionally added default role creation to ServiceAccount for
+better access management.
 
-**Runtime Framework** - The runtime execution framework executes the
-rules and policies distributed by the design and creation environment
-and Controllers that manage resources corresponding to their assigned
-controlled domain:
+SDC
+---
 
- - Service Orchestrator (SO) executes the specified BPMN processes and
-   automates sequences of activities, tasks, rules and policies needed for
-   on-demand creation, modification or removal of network, application or
-   infrastructure services and resources. SO is especially able to drive
-   any OpenStack-based cloud platform.
+SDC implemented-services update capability directly in yaml was added, more
+comprehensive support for defining behavior of interface operations and
+adaptability to define CSAR structure and content to suit the requirements of
+individual models.
 
- - Software Defined Network Controller (SDNC) executes network configuration
-   for cloud computing resources and network.
+CCSDK
+-----
 
- - Application Controller (APPC) executes Virtual Network Functions (VNF)
-   configurations and lifecycle management operations.
+CCSDK continued maintaining alignment with OpenDaylight release schedule by
+upgrading to OpenDaylight Argon version, Service Release 2. This allows latest
+ONAP user to make use of latest OpenDaylight software when they use latest
+release of ONAP.
 
- - Virtual Function Controller (VF-C) is responsible for lifecycle management
-   of virtual network functions and network services based on VNF using
-   VNF Manager.
+PortalNG
+--------s
 
- - Active and Available Inventory (A&AI) provides real-time views of a
-   system’s resources, services, products and their relationships with each
-   other.
+We introduced new PortalNG as a maintained alternative to the unmaintained
+Portal project.  Allows ONAP user to make informed decisions on software use of
+maintained and unmaintained projects.
 
-**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze >
-Detect -> Publish -> Respond:
+Documentation Sources
+---------------------
 
- - Data Collection, Analytics and Events (DCAE) collects events, performance,
-   usage and publishes information to policy that executes the rules to perform
-   closed loop actions.
+The formal ONAP 'NewDelhi' Release Documentation is available
+in :ref:`ReadTheDocs<master_index>`.
 
- - Holmes provides alarm correlation and analysis for Telecom cloud
-   infrastructure and services, including servers, cloud infrastructure,
-   VNFs and Network Services.
+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.
 
- - Common Services - operational services for all ONAP components including
-   activity logging, reporting, common data layer, access control, resiliency,
-   multisite state coordination, credential/secret management and
-   software lifecycle management.
+OpenSSF Best Practice
+---------------------
 
-**Microservices Support**
+ONAP has adopted the `OpenSSF Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
 
- - ONAP Operation Manager (OOM) use Kubernetes and Helm to manage ONAP components.
- - Microservices Bus (MSB) provides service registration/discovery,
-   external API gateway, internal API gateway, client software development kit
-   (SDK), and Swagger SDK.
-
-Project Specific Release Notes
-==============================
-ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts <doc-release-manifest-artifacts>`
-and :ref:`manifest dockers <doc-release-manifest-docker>`.
-
-.. toctree::
-   :hidden:
-
-   release-manifest-docker.rst
-   release-manifest.rst
-
-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.
-
-.. index:: Download
-
-Installation
-============
-ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<installing-onap>`
-
-Documentation
-=============
-ONAP Dublin Release provides multiple documents including the following:
-
- * A high level :ref:`architecture view<doc-architecture>` of how component
-   relate to each other.
-
- * A collection of documentation provided
-   by :ref:`each project <doc_onap-developer_guide_projects>`.
-
- * Application Programming Interface
-   Reference :ref:`available here <doc-apiref>`.
+- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
+- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
- * 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.
 
-.. index:: Licensing
+In the NewDelhi release,
 
-Security Notes
-==============
-ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.coreinfrastructure.org/en>`_.
-The goal of the Casablanca release is for all ONAP projects to be close to achieving a CII Passing badge.
+- 100% projects passed 95% of the OpenSSF badge
+- 94% passed the OpenSSF badge
+- 24% projects passed the OpenSSF Silver badge
+- 1 project passed the OpenSSF Gold badge
 
-- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
-- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
-
-Project specific details are in the :ref:`release notes<doc-releaserepos>` for each project.
+Project specific details are in the :ref:`release notes<component-release-notes>`
+for each component.
 
 .. index:: maturity
 
 ONAP Maturity Testing Notes
-===========================
-For the Casablanca release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics.
-
-The Integration team ran the 72 hours stability testing (100% passing rate) and full resilience testing (96.9% passing rate) at ONAP OpenLabs. More details in :ref:`ONAP Maturity Testing Notes <integration-s3p>`
+---------------------------
+For the 'NewDelhi' release, ONAP continues to improve in multiple areas of
+Scalability, Security, Stability and Performance (S3P) metrics.
 
-Licenses
-========
-ONAP Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_.
-ONAP Documentation is licensed under the `Creative Commons Attribution 4.0
-International License <http://creativecommons.org/licenses/by/4.0>`_.
+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>`.
-
-.. index:: Reporting Bugs
-
-How to Report a Bug
-===================
-There are 2 ways to report a bug in ONAP.
-
- * In case you are familiar within ONAP, you can directly report a bug by
-   creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_.
-
- * If you don't know you are facing a bug or have a question, post your
-   question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
-   You will need a Linux Foundation ID to login and post your question.
-   Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+ONAP+Technical+Community#JoiningtheONAPTechnicalCommunity-WhereDoIStart?>`_.
-
-To properly report a bug in Jira, you may want to consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
-
-
-.. Include files referenced by link in the toctree as hidden
-
-.. toctree::
-   :hidden:
-
-   releaserepos.rst
-   repolist.rst
+----------------------------
+Known Issues and limitations are documented in each
+:ref:`project Release Notes <component-release-notes>`.