docs/index.rst

   1 .. This work is licensed under a
   2    Creative Commons Attribution 4.0 International License.
   3
   4 .. _master_index:
   5
   6
   7
   8 .. please disable below in the release version
   9 ..
  10 .. warning:: **WORK IN PROGRESS**
  11
  12     .. figure:: _static/exclamation-triangle.svg
  13         :align: left
  14         :scale: 760%
  15         :figwidth: 120px
  16
  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.
  20
  21     **The official release documentation for ONAP 'London' can be found**
  22     `[here] <https://docs.onap.org/en/london/>`__
  23
  24 |
  25
  26 ..
  27 .. please disable above in the release version
  28
  29 Open Network Automation Platform
  30 ================================
  31
  32 Open Network Automation Platform (ONAP) is an open source project hosted by
  33 the Linux Foundation.
  34
  35 ONAP provides a comprehensive platform for real-time, policy-driven service
  36 orchestration and automation. ONAP enables service providers and developers
  37 to rapidly automate the instantiation and configuration of physical and
  38 virtual network functions and to support complete life cycle management
  39 activities. By unifying the resources of open source members, ONAP enables
  40 the acceleration of the development of a vibrant ecosystem around a globally
  41 shared architecture and the implementation of network automation faster than
  42 any product could on its own.
  43
  44 -------------------------------------------------------------------------------
  45
  46 :ref:`'London' Release Notes <onap-release-notes>`
  47 --------------------------------------------------
  48
  49 .. figure:: _static/file.svg
  50     :align: left
  51     :scale: 300%
  52     :figwidth: 50px
  53
  54 General information about the new ONAP release and recent changes, feature
  55 enhancements, or bug fixes.
  56
  57 |
  58
  59 :ref:`Component Release Notes <component-release-notes>`
  60 --------------------------------------------------------
  61
  62 .. figure:: _static/files.svg
  63     :align: left
  64     :scale: 300%
  65     :figwidth: 50px
  66
  67 Project specific information about recent changes, features, enhancements, or
  68 bug fixes.
  69
  70 |
  71
  72 :ref:`Release History <release-history>`
  73 ----------------------------------------
  74
  75 .. figure:: _static/clock-history.svg
  76     :align: left
  77     :scale: 300%
  78     :figwidth: 50px
  79
  80 Names and release dates of previous ONAP versions.
  81
  82 |
  83
  84 -------------------------------------------------------------------------------
  85
  86 :ref:`Use Cases, Blueprints, Requirements <usecases_entry>`
  87 -----------------------------------------------------------
  88
  89 .. figure:: _static/bullseye.svg
  90     :align: left
  91     :scale: 300%
  92     :figwidth: 50px
  93
  94 ONAP covers a wide range of use cases for Communication Service Providers (CSP)
  95 and the open source networking industry. Read about the latest verified use
  96 cases, functional requirements and blueprints to achieve your goals.
  97
  98 |
  99
 100 -------------------------------------------------------------------------------
 101
 102 :ref:`Overview <overview>`
 103 --------------------------
 104
 105 .. figure:: _static/eye.svg
 106     :align: left
 107     :scale: 300%
 108     :figwidth: 50px
 109
 110 A high-level guidance on the mission and main functionalities of ONAP. Basic
 111 guidelines on license details, limitations and security references support
 112 understanding the solution.
 113
 114 |
 115
 116 :ref:`Architecture <ONAP-architecture>`
 117 ---------------------------------------
 118
 119 .. figure:: _static/columns-gap.svg
 120     :align: left
 121     :scale: 300%
 122     :figwidth: 50px
 123
 124 A general description of functional ONAP components and how they interact.
 125 Covers the design-time and runtime framework, ONAP microservices and common
 126 services.
 127
 128 |
 129
 130 :ref:`Components and Functionalities <doc_onap-developer_guide_projects>`
 131 -------------------------------------------------------------------------
 132
 133 .. figure:: _static/diagram-3.svg
 134     :align: left
 135     :scale: 300%
 136     :figwidth: 50px
 137
 138 A individual description of every ONAP component and its features.
 139
 140 |
 141
 142 -------------------------------------------------------------------------------
 143
 144 :ref:`Operations and Administration Guides <operation_guides>`
 145 --------------------------------------------------------------
 146
 147 .. figure:: _static/person-gear.svg
 148     :align: left
 149     :scale: 300%
 150     :figwidth: 50px
 151
 152 The installation of ONAP, its management, monitoring and other operational
 153 tasks like integration or user management are covered here.
 154
 155 |
 156
 157 :ref:`Developer Guides <ONAP_developer_guides>`
 158 -----------------------------------------------
 159
 160 .. figure:: _static/code-slash.svg
 161     :align: left
 162     :scale: 300%
 163     :figwidth: 50px
 164
 165 Developers contributing to the ONAP development can find information here.
 166
 167 |
 168
 169 :ref:`Documentation Guides <ONAP_documentation_guides>`
 170 -------------------------------------------------------
 171
 172 .. figure:: _static/filetype-rst.svg
 173     :align: left
 174     :scale: 300%
 175     :figwidth: 50px
 176
 177 A guide to set up a documentation development environment, documentation style
 178 guides, tips and templates are provided here.
 179
 180 |
 181
 182 -------------------------------------------------------------------------------
 183
 184 :ref:`Vulnerabilities and Advisories <onap-security-index>`
 185 -----------------------------------------------------------
 186
 187 .. figure:: _static/shield.svg
 188     :align: left
 189     :scale: 300%
 190     :figwidth: 50px
 191
 192 Describes the current state of ONAP Security. Learn about discovered and fixed
 193 vulnerabilities and how to report them.
 194
 195
 196 .. toctree::
 197    :maxdepth: 1
 198    :hidden:
 199
 200    Home <self>
 201
 202 .. toctree::
 203    :maxdepth: 1
 204    :hidden:
 205    :caption: RELEASE
 206
 207    release/index
 208    release/component-release-notes
 209    release/history
 210
 211 .. toctree::
 212    :maxdepth: 1
 213    :hidden:
 214    :caption: USE CASES
 215
 216    usecases/index
 217
 218 .. toctree::
 219    :maxdepth: 1
 220    :hidden:
 221    :caption: PLATFORM
 222
 223    platform/overview/index
 224    platform/architecture/index
 225    platform/components/index
 226
 227 .. toctree::
 228    :maxdepth: 1
 229    :hidden:
 230    :caption: GUIDES
 231
 232    guides/onap-operator/index
 233    guides/onap-developer/index
 234    guides/onap-documentation/index
 235
 236 .. toctree::
 237    :maxdepth: 1
 238    :hidden:
 239    :caption: SECURITY
 240
 241    security/index