Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / 65bec69096b0a2ef18cd72d87b89757da4ae1906 / . / docs / index.rst
blob: 93985b664913c8abe11b016055f0266b992c21f2 [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 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt65bec692022-08-11 13:05:18 +0200[diff] [blame^]24 | Documentation areas | Description |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]25 +=================================================================================+===============================================================================================+
thmsdtc0b8d0c2022-08-09 17:16:54 +0200[diff] [blame]26 | :ref:`ONAP 'Jakarta' Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,|
thmsdt671839c2022-05-03 09:44:01 +0200[diff] [blame]27 | | feature enhancements, or bug fixes. |
28 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt65bec692022-08-11 13:05:18 +0200[diff] [blame^]29 | :ref:`Component Release Notes <component-release-notes>` | The Component Release Notes are providing project specific information about recent changes, |
30 | | features, enhancements, or bug fixes. |
31 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
32 | :ref:`ONAP Release History <release-history>` | The list contains the name and date of previous ONAP releases. |
Noemi Wagner01fab8e2019-05-30 13:55:09 +0200[diff] [blame]33 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]34 | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main |
35 | | functionalities of ONAP. Basic guidelines on license details, limitations and |
36 | | security references support understanding the solution. |
37 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt21d59412022-08-02 13:28:17 +0200[diff] [blame]38 | :ref:`ONAP Architecture <ONAP-architecture>` | The ONAP Architecture and its functional elements are described in details here. You can learn|
39 | | how the two main frameworks, namely the Design-time framework and the Run-time framework |
40 | | cooperate and how the Microservices and Common services support certain functions. |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]41 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt21d59412022-08-02 13:28:17 +0200[diff] [blame]42 | :ref:`ONAP Components and Functionalities <doc_onap-developer_guide_projects>` | The ONAP Components and Functionalities are described in details here. You can learn what |
43 | | functionalities ONAP provides and how the certain components in ONAP operate together. |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]44 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt21d59412022-08-02 13:28:17 +0200[diff] [blame]45 | :ref:`Operations and Adminstration Guides <operation_guides>` | ONAP Platform Operations and Adminstration covers the configuration and installation of ONAP, |
46 | | its management, monitoring and other operational tasks (integration, user management, ...) |
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]47 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
48 | :ref:`User Guides <user-guides>` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, |
49 | | instantiation and their management using control loops |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]50 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt21d59412022-08-02 13:28:17 +0200[diff] [blame]51 | :ref:`Developer Guides <ONAP_developer_guides>` | Developers contributing to the ONAP development can find crucial information in the Developer |
52 | | Guides. You can search among the developers’ topics in alphabetical order. |
Noemi Wagner72e5f822019-05-10 15:16:47 +0200[diff] [blame]53 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt21d59412022-08-02 13:28:17 +0200[diff] [blame]54 | :ref:`Documentation Guides <ONAP_documentation_guides>` | People interested in the creation of ONAP documentation can find crucial information in the |
55 | | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is |
56 | | subject to be reviewed, updated and migrated to the ONAP Documentation Guide. |
thmsdt1b488832021-05-10 07:54:33 -0700[diff] [blame]57 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
thmsdt65bec692022-08-11 13:05:18 +0200[diff] [blame^]58 | :ref:`ONAP Security <onap-security-index>` | The current state of ONAP Security is described here. You can learn about discovered and fixed|
thmsdt6458ba72022-06-27 16:45:45 +0200[diff] [blame]59 | | vulnerabilities. |
60 +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
Aric Gardner0fb94b12020-01-28 15:21:34 -0500[diff] [blame]61
Thomas Kulik8f5dcf32022-06-30 12:27:52 +0000[diff] [blame]62
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]63.. toctree::
Noemi Wagnerf3d08c02018-11-30 10:22:09 +0100[diff] [blame]64 :maxdepth: 1
65 :hidden:
Rich Bennettac93e0e2017-07-19 01:36:52 -0400[diff] [blame]66
Noemi Wagner2d7727c2019-01-08 09:55:19 +0100[diff] [blame]67 Home <self>
thmsdt65bec692022-08-11 13:05:18 +0200[diff] [blame^]68
69.. toctree::
70 :maxdepth: 1
71 :hidden:
72 :caption: RELEASE
73
MatthewHarffy8e73d8b2017-09-14 15:29:34 +0100[diff] [blame]74 release/index
thmsdt65bec692022-08-11 13:05:18 +0200[diff] [blame^]75 release/component-release-notes
76 release/history
77
78.. toctree::
79 :maxdepth: 1
80 :hidden:
81 :caption: PLATFORM
82
83 platform/overview/index
84 platform/architecture/index
85 platform/components/index
86
87.. toctree::
88 :maxdepth: 1
89 :hidden:
90 :caption: GUIDES
91
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]92 guides/onap-operator/index
Rich Bennett5baea462017-09-13 03:19:19 -0400[diff] [blame]93 guides/onap-user/index
andreasgeissler55ae2d22019-12-11 13:29:28 +0100[diff] [blame]94 guides/onap-developer/index
thmsdt1b488832021-05-10 07:54:33 -0700[diff] [blame]95 guides/onap-documentation/index
thmsdt65bec692022-08-11 13:05:18 +0200[diff] [blame^]96
97.. toctree::
98 :maxdepth: 1
99 :hidden:
100 :caption: SECURITY
101
102 security/index
103