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