.. This work is licensed under a
   Creative Commons Attribution 4.0 International License.

.. _master_index:



.. please disable below in the release version
..
.. warning:: **WORK IN PROGRESS**

    .. figure:: _static/exclamation-triangle.svg
        :align: left
        :scale: 760%
        :figwidth: 120px

    This is a development version of ONAP documentation. It continually
    develops as the contributing projects develop. Even if you read a specific
    release name here, the content may cover a future ONAP release.

    **The official release documentation for ONAP 'Montreal' can be found**
    `[here] <https://docs.onap.org/en/montreal/>`__


|

..
.. please disable above in the release version

Open Network Automation Platform
================================

Open Network Automation Platform (ONAP) is an open source project hosted by
the Linux Foundation.

ONAP provides a comprehensive platform for real-time, policy-driven service
orchestration and automation. ONAP enables service providers and developers
to rapidly automate the instantiation and configuration of physical and
virtual network functions and to support complete life cycle management
activities. By unifying the resources of open source members, ONAP enables
the acceleration of the development of a vibrant ecosystem around a globally
shared architecture and the implementation of network automation faster than
any product could on its own.

-------------------------------------------------------------------------------

:ref:`'Montreal' Release Notes <onap-release-notes>`
----------------------------------------------------

.. figure:: _static/file.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

General information about the new ONAP release and recent changes, feature
enhancements, or bug fixes.

|

:ref:`Component Release Notes <component-release-notes>`
--------------------------------------------------------

.. figure:: _static/files.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

Project specific information about recent changes, features, enhancements, or
bug fixes.

|

:ref:`Release History <release-history>`
----------------------------------------

.. figure:: _static/clock-history.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

Names and release dates of previous ONAP versions.

|

-------------------------------------------------------------------------------

:ref:`Use Cases, Blueprints, Requirements <usecases_entry>`
-----------------------------------------------------------

.. figure:: _static/bullseye.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

ONAP covers a wide range of use cases for Communication Service Providers (CSP)
and the open source networking industry. Read about the latest verified use
cases, functional requirements and blueprints to achieve your goals.

|

-------------------------------------------------------------------------------

:ref:`Overview <overview>`
--------------------------

.. figure:: _static/eye.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

A high-level guidance on the mission and main functionalities of ONAP. Basic
guidelines on license details, limitations and security references support
understanding the solution.

|

:ref:`Architecture <ONAP-architecture>`
---------------------------------------

.. figure:: _static/columns-gap.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

A general description of functional ONAP components and how they interact.
Covers the design-time and runtime framework, ONAP microservices and common
services.

|

:ref:`Components and Functionalities <doc_onap-developer_guide_projects>`
-------------------------------------------------------------------------

.. figure:: _static/diagram-3.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

A individual description of every ONAP component and its features.

|

-------------------------------------------------------------------------------

:ref:`Operations and Administration Guides <operation_guides>`
--------------------------------------------------------------

.. figure:: _static/person-gear.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

The installation of ONAP, its management, monitoring and other operational
tasks like integration or user management are covered here.

|

:ref:`Developer Guides <ONAP_developer_guides>`
-----------------------------------------------

.. figure:: _static/code-slash.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

Developers contributing to the ONAP development can find information here.

|

:ref:`Documentation Guides <ONAP_documentation_guides>`
-------------------------------------------------------

.. figure:: _static/filetype-rst.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

A guide to set up a documentation development environment, documentation style
guides, tips and templates are provided here.

|

-------------------------------------------------------------------------------

:ref:`Vulnerabilities and Advisories <onap-security-index>`
-----------------------------------------------------------

.. figure:: _static/shield.svg
    :align: left
    :scale: 300%
    :figwidth: 50px

Describes the current state of ONAP Security. Learn about discovered and fixed
vulnerabilities and how to report them.


.. toctree::
   :maxdepth: 1
   :hidden:

   Home <self>

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: RELEASE

   release/index
   release/component-release-notes
   release/history

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: USE CASES

   usecases/index

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: PLATFORM

   platform/overview/index
   platform/architecture/index
   platform/components/index

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: GUIDES

   guides/onap-operator/index
   guides/onap-developer/index
   guides/onap-documentation/index

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: SECURITY

   security/index