docs/index.rst

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