Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 8cb3a1912ea8052bfbae996fa2754fba40ef8f92 / . / docs / index.rst
blob: 64ff88783085312381447c53f7d0a538fef0aba4 [file] [log] [blame]
Eric Debeau38c451a2018-11-30 20:03:37 +0000[diff] [blame]1.. This work is licensed under a
2 Creative Commons Attribution 4.0 International License.
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]3
Rich Bennettd1f09492017-07-25 19:28:00 -0400[diff] [blame]4.. _master_index:
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]5
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]6Open Network Automation Platform
7================================
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]8
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]9Open Network Automation Platform (ONAP) is an open source project hosted by
10the Linux Foundation.
Rich Bennett1959f682018-06-14 10:50:31 -0400[diff] [blame]11
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]12ONAP provides a comprehensive platform for real-time, policy-driven service
13orchestration and automation. ONAP enables service providers and developers
14to rapidly automate the instantiation and configuration of physical and
15virtual network functions and to support complete life cycle management
16activities. By unifying the resources of open source members, ONAP enables
17the acceleration of the development of a vibrant ecosystem around a globally
18shared architecture and the implementation of network automation faster than
19any product could on its own.
20
Noemi Wagnerf50d63d2019-05-17 10:22:04 +0200[diff] [blame]21Please find some guidance here on the content of ONAP documentation:
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]22
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]23 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Eric Debeauddbab332019-10-14 13:42:57 +0000[diff] [blame]24 | Main documentation areas | Description |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]25 +=================================================================================+===============================================================================================+
Eric Debeauddbab332019-10-14 13:42:57 +0000[diff] [blame]26 | :ref:`Release Notes <release-notes>` | The Release Notes besides providing the basic information on the main release, also |
Noemi Wagner01fab8e2019-05-30 13:55:09 +0200[diff] [blame]27 | | presents link to the release information of each, specific ONAP component. |
28 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]29 | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main |
30 | | functionalities of ONAP. Basic guidelines on license details, limitations and |
31 | | security references support understanding the solution. |
32 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
33 | :ref:`ONAP Architecture <ONAP-architecture>` | The ONAP architecture and its functional elements are described in details |
34 | | here. We can learn how the two main frameworks, namely the Design-time |
35 | | framework and the Run-time framework cooperate and how the Microservices, |
36 | | Common services and the ONAP Portal support the certain functions. |
37 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
38 | :ref:`ONAP components and functionalities <doc_onap-developer_guide_projects>` | The ONAP components and functionalities are described in details here. |
39 | | We can learn what functionalities ONAP provides and how the certain components in ONAP |
40 | | operate together. |
41 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]42 | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform operation and adminstration cover the configuration and installation of ONAP, |
43 | | its management, monitoring and other operational tasks (integration, user management,...) |
44 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
45 | :ref:`User Guides <user-guides>` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, |
46 | | instantiation and their management using control loops |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]47 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
48 | :ref:`Developer Guides <ONAP_developer_guides>` | Developers contributing to the ONAP development can find crucial information |
49 | | in the Developer Guides. The reader can search among the developers’ topics |
50 | | in alphabetical order. |
51 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Noemi Wagnerf50d63d2019-05-17 10:22:04 +0200[diff] [blame]52 | :ref:`VNF/PNF Requirements and Guidelines <vnf_pnf_reqs>` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]53 | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines |
54 | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. |
55 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]56
Noemi Wagnerf50d63d2019-05-17 10:22:04 +0200[diff] [blame]57
Rich Bennett1959f682018-06-14 10:50:31 -0400[diff] [blame]58
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]59.. toctree::
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]60 :maxdepth: 1
61 :hidden:
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]62
Noemi Wagner2d7727c2019-01-08 09:55:19 +0100[diff] [blame]63 Home <self>
MatthewHarffy8e73d8b2017-09-14 15:29:34 +0100[diff] [blame]64 release/index
Noemi Wagner01fab8e2019-05-30 13:55:09 +0200[diff] [blame]65 guides/overview/index
Andrea Visnyei1a4fc332019-02-15 13:50:54 +0100[diff] [blame]66 guides/onap-developer/architecture/index
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]67 guides/onap-developer/developing/index
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]68 guides/onap-operator/index
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]69 guides/onap-user/index
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]70 guides/onap-developer/index
Bozawglanian, Hagop (hb755d)94362e52018-08-31 19:21:27 +0000[diff] [blame]71 guides/onap-provider/index