1 .. This work is licensed under a
2 Creative Commons Attribution 4.0 International License.
8 .. please disable below in the release version
10 .. warning:: **WORK IN PROGRESS**
12 .. figure:: _static/exclamation-triangle.svg
17 This is a development version of ONAP documentation. It continually
18 develops as the contributing projects develop. Even if you read a specific
19 release name here, the content may cover a future ONAP release.
21 **The official release documentation for ONAP 'Kohn' can be found**
22 `[here] <https://docs.onap.org/en/kohn/>`__
26 .. please disable above in the release version
28 Open Network Automation Platform
29 ================================
31 Open Network Automation Platform (ONAP) is an open source project hosted by
34 ONAP provides a comprehensive platform for real-time, policy-driven service
35 orchestration and automation. ONAP enables service providers and developers
36 to rapidly automate the instantiation and configuration of physical and
37 virtual network functions and to support complete life cycle management
38 activities. By unifying the resources of open source members, ONAP enables
39 the acceleration of the development of a vibrant ecosystem around a globally
40 shared architecture and the implementation of network automation faster than
41 any product could on its own.
43 -------------------------------------------------------------------------------
45 :ref:`'Kohn' Release Notes <onap-release-notes>`
46 ------------------------------------------------
48 .. figure:: _static/file.svg
53 General information about the new ONAP release and recent changes, feature
54 enhancements, or bug fixes.
58 :ref:`Component Release Notes <component-release-notes>`
59 --------------------------------------------------------
61 .. figure:: _static/files.svg
66 Project specific information about recent changes, features, enhancements, or
71 :ref:`Release History <release-history>`
72 ----------------------------------------
74 .. figure:: _static/clock-history.svg
79 Names and release dates of previous ONAP versions.
83 -------------------------------------------------------------------------------
85 :ref:`Use Cases, Blueprints, Requirements <usecases_entry>`
86 -----------------------------------------------------------
88 .. figure:: _static/bullseye.svg
93 ONAP covers a wide range of use cases for Communication Service Providers (CSP)
94 and the open source networking industry. Read about the latest verified use
95 cases, functional requirements and blueprints to achieve your goals.
99 -------------------------------------------------------------------------------
101 :ref:`Overview <overview>`
102 --------------------------
104 .. figure:: _static/eye.svg
109 A high-level guidance on the mission and main functionalities of ONAP. Basic
110 guidelines on license details, limitations and security references support
111 understanding the solution.
115 :ref:`Architecture <ONAP-architecture>`
116 ---------------------------------------
118 .. figure:: _static/columns-gap.svg
123 A general description of functional ONAP components and how they interact.
124 Covers the design-time and runtime framework, ONAP microservices and common
129 :ref:`Components and Functionalities <doc_onap-developer_guide_projects>`
130 -------------------------------------------------------------------------
132 .. figure:: _static/diagram-3.svg
137 A individual description of every ONAP component and its features.
141 -------------------------------------------------------------------------------
143 :ref:`Operations and Administration Guides <operation_guides>`
144 --------------------------------------------------------------
146 .. figure:: _static/person-gear.svg
151 The installation of ONAP, its management, monitoring and other operational
152 tasks like integration or user management are covered here.
156 :ref:`Developer Guides <ONAP_developer_guides>`
157 -----------------------------------------------
159 .. figure:: _static/code-slash.svg
164 Developers contributing to the ONAP development can find information here.
168 :ref:`Documentation Guides <ONAP_documentation_guides>`
169 -------------------------------------------------------
171 .. figure:: _static/filetype-rst.svg
176 A guide to set up a documentation development environment, documentation style
177 guides, tips and templates are provided here.
181 -------------------------------------------------------------------------------
183 :ref:`Vulnerabilities and Advisories <onap-security-index>`
184 -----------------------------------------------------------
186 .. figure:: _static/shield.svg
191 Describes the current state of ONAP Security. Learn about discovered and fixed
192 vulnerabilities and how to report them.
207 release/component-release-notes
222 platform/overview/index
223 platform/architecture/index
224 platform/components/index
231 guides/onap-operator/index
232 guides/onap-developer/index
233 guides/onap-documentation/index