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