docs/documentation.rst

   1
   2 .. _onap-documentation:
   3
   4 ONAP Documentation
   5 ==================
   6
   7 Welcome to the Open Network Automation Platform (ONAP) documentation site for the Casablanca Release!
   8
   9 Please find some guidance here on the content of the Casablanca Release documentation for ONAP:
  10
  11  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  12  | Main documentation areas                              |   Description                                                                                 |
  13  +=======================================================+===============================================================================================+
  14  | :ref:`ONAP Overview <getting-started>`                | ONAP Overview provides generic and high-level guidance on the mission and main                |
  15  |                                                       | functionalities of ONAP. Basic guidelines on license details, limitations and                 |
  16  |                                                       | security references support understanding the solution.                                       |
  17  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  18  | :ref:`ONAP Architecture <ONAP-architecture>`          | The ONAP architecture and its functional elements are described in details                    |
  19  |                                                       | here. We can learn how the two main frameworks, namely the Design-time                        |
  20  |                                                       | framework and the Run-time framework cooperate and how the Microservices,                     |
  21  |                                                       | Common services and the ONAP Portal support the certain functions.                            |
  22  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  23  | :ref:`Setting Up ONAP <installing-onap>`              | Installation guidelines and requirements help the very first set up of an                     |
  24  |                                                       | ONAP environment. The ONAP Operations Manager Cloud setup Guide and the                       |
  25  |                                                       | ONAP Operations Manager Quick Start Guide support the deployment and installation activities. |
  26  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  27  | :ref:`Developer Guides <ONAP_developer_guides>`       | Developers contributing to the ONAP development can find crucial information                  |
  28  |                                                       | in the Developer Guides. The reader can search among the developers’ topics                   |
  29  |                                                       | in alphabetical order.                                                                        |
  30  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  31  | :ref:`User Guides <user-guides>`                      | The User Guides provide details on the ONAP portal, which portal integrates                   |
  32  |                                                       | numerous different ONAP applications at one place. Platform operations are                    |
  33  |                                                       | supported with ONAP Operations Quick Start Guide and with an ONAP Operations                  |
  34  |                                                       | User Guide. The instantiation and the management of resources and the services                |
  35  |                                                       | are supported with a Service Design Guide and with guidelines on Service Deployment.          |
  36  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  37  | :ref:`VNF/PNF Requirements and Guidelines <vnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs              |
  38  |                                                       | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines            |
  39  |                                                       | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. |
  40  +-------------------------------------------------------+-----------------------------------------------------------------------------------------------+
  41 You can reach the complete Casablanca Release documentation from the Navigation bar on the left.
  42