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:`Overview <overview>`
  86 --------------------------
  87
  88 .. figure:: _static/eye.svg
  89     :align: left
  90     :scale: 300%
  91     :figwidth: 50px
  92
  93 A high-level guidance on the mission and main functionalities of ONAP. Basic
  94 guidelines on license details, limitations and security references support
  95 understanding the solution.
  96
  97 |
  98
  99 :ref:`Architecture <ONAP-architecture>`
 100 ---------------------------------------
 101
 102 .. figure:: _static/columns-gap.svg
 103     :align: left
 104     :scale: 300%
 105     :figwidth: 50px
 106
 107 A general description of functional ONAP components and how they interact.
 108 Covers the design-time and runtime framework, ONAP microservices and common
 109 services.
 110
 111 |
 112
 113 :ref:`Components and Functionalities <doc_onap-developer_guide_projects>`
 114 -------------------------------------------------------------------------
 115
 116 .. figure:: _static/diagram-3.svg
 117     :align: left
 118     :scale: 300%
 119     :figwidth: 50px
 120
 121 A individual description of every ONAP component and its features.
 122
 123 |
 124
 125 -------------------------------------------------------------------------------
 126
 127 :ref:`Operations and Administration Guides <operation_guides>`
 128 --------------------------------------------------------------
 129
 130 .. figure:: _static/person-gear.svg
 131     :align: left
 132     :scale: 300%
 133     :figwidth: 50px
 134
 135 The installation of ONAP, its management, monitoring and other operational
 136 tasks like integration or user management are covered here.
 137
 138 |
 139
 140 :ref:`User Guides <user-guides>`
 141 --------------------------------
 142
 143 .. figure:: _static/person.svg
 144     :align: left
 145     :scale: 300%
 146     :figwidth: 50px
 147
 148 The User Guides focus on tasks to administer services using ONAP, covering
 149 service design, instantiation and management using control loops.
 150
 151 |
 152
 153 :ref:`Developer Guides <ONAP_developer_guides>`
 154 -----------------------------------------------
 155
 156 .. figure:: _static/code-slash.svg
 157     :align: left
 158     :scale: 300%
 159     :figwidth: 50px
 160
 161 Developers contributing to the ONAP development can find information here.
 162
 163 |
 164
 165 :ref:`Documentation Guides <ONAP_documentation_guides>`
 166 -------------------------------------------------------
 167
 168 .. figure:: _static/filetype-rst.svg
 169     :align: left
 170     :scale: 300%
 171     :figwidth: 50px
 172
 173 A guide to set up a documentation development environment, documentation style
 174 guides, tips and templates are provided here.
 175
 176 |
 177
 178 -------------------------------------------------------------------------------
 179
 180 :ref:`Vulnerabilities and Advisories <onap-security-index>`
 181 -----------------------------------------------------------
 182
 183 .. figure:: _static/shield.svg
 184     :align: left
 185     :scale: 300%
 186     :figwidth: 50px
 187
 188 Describes the current state of ONAP Security. Learn about discovered and fixed
 189 vulnerabilities and how to report them.
 190
 191
 192 .. toctree::
 193    :maxdepth: 1
 194    :hidden:
 195
 196    Home <self>
 197
 198 .. toctree::
 199    :maxdepth: 1
 200    :hidden:
 201    :caption: RELEASE
 202
 203    release/index
 204    release/component-release-notes
 205    release/history
 206
 207 .. toctree::
 208    :maxdepth: 1
 209    :hidden:
 210    :caption: PLATFORM
 211
 212    platform/overview/index
 213    platform/architecture/index
 214    platform/components/index
 215
 216 .. toctree::
 217    :maxdepth: 1
 218    :hidden:
 219    :caption: GUIDES
 220
 221    guides/onap-operator/index
 222    guides/onap-user/index
 223    guides/onap-developer/index
 224    guides/onap-documentation/index
 225
 226 .. toctree::
 227    :maxdepth: 1
 228    :hidden:
 229    :caption: SECURITY
 230
 231    security/index