docs/index.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3
   4 .. _master_index:
   5
   6 Open Network Automation Platform
   7 ================================
   8
   9 Open Network Automation Platform (ONAP) is an open source project hosted by
  10 the Linux Foundation.
  11
  12 ONAP provides a comprehensive platform for real-time, policy-driven service
  13 orchestration and automation. ONAP enables service providers and developers
  14 to rapidly automate the instantiation and configuration of physical and
  15 virtual network functions and to support complete life cycle management
  16 activities. By unifying the resources of open source members, ONAP enables
  17 the acceleration of the development of a vibrant ecosystem around a globally
  18 shared architecture and the implementation of network automation faster than
  19 any product could on its own.
  20
  21 Please find some guidance here on the content of the Dublin Release documentation for ONAP:
  22
  23  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  24  | Main documentation areas                                                        | Description                                                                                   |
  25  +=================================================================================+===============================================================================================+
  26  | :ref:`ONAP Overview <overview>`                                                 | ONAP Overview provides generic and high-level guidance on the mission and main                |
  27  |                                                                                 | functionalities of ONAP. Basic guidelines on license details, limitations and                 |
  28  |                                                                                 | security references support understanding the solution.                                       |
  29  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  30  | :ref:`ONAP Architecture <ONAP-architecture>`                                    | The ONAP architecture and its functional elements are described in details                    |
  31  |                                                                                 | here. We can learn how the two main frameworks, namely the Design-time                        |
  32  |                                                                                 | framework and the Run-time framework cooperate and how the Microservices,                     |
  33  |                                                                                 | Common services and the ONAP Portal support the certain functions.                            |
  34  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  35  | :ref:`ONAP components and functionalities <doc_onap-developer_guide_projects>`  | The ONAP components and functionalities are described in details here.                        |
  36  |                                                                                 | We can learn what functionalities ONAP provides and how the certain components in ONAP        |
  37  |                                                                                 | operate together.                                                                             |
  38  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  39  | :ref:`Setting Up ONAP <installing-onap>`                                        | Installation guidelines and requirements help the very first set up of an                     |
  40  |                                                                                 | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the                       |
  41  |                                                                                 | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. |
  42  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  43  | :ref:`Developer Guides <ONAP_developer_guides>`                                 | Developers contributing to the ONAP development can find crucial information                  |
  44  |                                                                                 | in the Developer Guides. The reader can search among the developers’ topics                   |
  45  |                                                                                 | in alphabetical order.                                                                        |
  46  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  47  | :ref:`User Guides <user-guides>`                                                | The User Guides provide details on the ONAP portal, which portal integrates                   |
  48  |                                                                                 | numerous different ONAP applications at one place. Platform operations are                    |
  49  |                                                                                 | supported with ONAP Operations Quick Start Guide and with an ONAP Operations                  |
  50  |                                                                                 | User Guide. The instantiation and the management of resources and the services                |
  51  |                                                                                 | are supported with a Service Design Guide and with guidelines on Service Deployment.          |
  52  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  53  | :ref:`VNF/PNF Requirements and Guidelines <vnf_reqs>`                           | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs              |
  54  |                                                                                 | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines            |
  55  |                                                                                 | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. |
  56  +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  57
  58 You can reach the complete set of Dublin Release documentation from the Navigation bar on the left.
  59
  60 .. toctree::
  61    :maxdepth: 1
  62    :hidden:
  63
  64    Home <self>
  65    guides/overview/index
  66    release/index
  67    guides/onap-developer/architecture/index
  68    guides/onap-developer/developing/index
  69    guides/onap-developer/settingup/index
  70    guides/onap-developer/index
  71    guides/onap-user/index
  72    guides/onap-provider/index