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