ONAP components and functionalities
===================================
-Additional developer level detail is provided for each project below.
-
-Active and Available Inventory
-------------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
-| :ref:`aai aai-common<onap-aai-aai-common:master_index>`
-| :ref:`AAI-esr-gui<onap-aai-esr-gui:master_index>`
-| :ref:`aai esr-server<onap-aai-esr-server:master_index>`
-| :ref:`aai sparky-be<onap-aai-sparky-be:master_index>`
-| :ref:`aai event-clientrst<onap-aai-event-client:master_index>`
-
-
-Application Controller
-----------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
-| :ref:`appc deployment<onap-appc-deployment:master_index>`
-| :ref:`appc<onap-appc:master_index>`
-
-Application Authorization Framework
------------------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
-| :ref:`aaf authz<onap-aaf-authz:master_index>`
-| :ref:`Secret Management Service<onap-aaf-sms:master_index>`
-
-Command Line Interface
-----------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
-:ref:`cli<onap-cli:master_index>`
-
-
-Control Loop Automation Management Platform
--------------------------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
-:ref:`clamp<onap-clamp:master_index>`
-
-Common Controller Software Development Kit
-------------------------------------------
+Here you will find the detailed documentation of projects,
+ONAP components and functionalities
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+Project - ONAP Integration
+--------------------------
-| :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
-| :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
-| :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
-| :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
-| :ref:`ccsdk cds<onap-ccsdk-cds:master_index>`
-| :ref:`ccsdk oran<onap-ccsdk-oran:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Data Collection, Analysis, and Events
--------------------------------------
+ * - Document
+ - Description
+ * - :ref:`Integration<onap-integration:master_index>`
+ - ONAP Integration Project Documentation
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
-:ref:`dcaegen2<onap-dcaegen2:master_index>`
+Project - ONAP Modeling
+-----------------------
-Data Management as a Platform Data Bus Controller
--------------------------------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 1
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`Model<onap-modeling-modelspec:master_index>`
+ - ONAP Model Specification
+ * - :ref:`ETSI Catalog<onap-modeling-etsicatalog:master_index>`
+ - ONAP ETSI Runtime Catalog Documentation
-| :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
-| :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>`
-Data Management as a Platform Data Router
+AAF - Application Authorization Framework
-----------------------------------------
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
-:ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`
-
-Data Management as a Platform Message Router
---------------------------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
+ - AAF Architecture, APIs and Guides
+
+AAI - Active and Available Inventory
+------------------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`AAI<onap-aai-aai-common:master_index>`
+ - AAI Architecture, APIs and Guides
+ * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
+ - External System Registry GUI Documentation
+ * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
+ - External System Registry Server Documentation
+ * - :ref:`AAI UI<onap-aai-sparky-be:master_index>`
+ - Sparky - AAI Inventory UI Documentation
+
+APPC - Application Controller
+-----------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
+ - APPC Architecture, APIs and Guides
+ * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
+ - APPC Deployment Documentation
+
+CCSDK - Common Controller Software Development Kit
+--------------------------------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
+ - TOSCA Orchestration Plugin, Directed Graph Support
+
+CDS - Controller Design Studio
+------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
+ * - Document
+ - Description
+ * - :ref:`CDS<onap-ccsdk-cds:master_index>`
+ - Controller Design Studio Architecture and Guides (part of CCSDK)
-External API Framework
-----------------------
+CLAMP - Control Loop Automation Management Platform
+---------------------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-:ref:`externalapi nbi<onap-externalapi-nbi:master_index>`
+ * - Document
+ - Description
+ * - :ref:`CLAMP <onap-policy-clamp:master_index>`
+ - CLAMP Architecture and Guides
+CLI - Command Line Interface
+----------------------------
-Holmes
-------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`CLI <onap-cli:master_index>`
+ - CLI Documentation
-| :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
-| :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`
+CPS - Configuration Persistence Service
+---------------------------------------
-Integration
------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 1
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`CPS <onap-cps:master_index>`
+ - CPS Documentation
-:ref:`integration<onap-integration:master_index>`
+DCAE - Data Collection, Analysis and Events
+-------------------------------------------
-Logging Analytics
------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`DCAE<onap-dcaegen2:master_index>`
+ - DCAE Architecture and Guides
-:ref:`logging-analytics<onap-logging-analytics:master_index>`
+DMAAP - Data Management as a Platform
+-------------------------------------
-Micro Services Bus
-------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>`
+ - Bus Controller Documentation
+ * - :ref:`Data Router<onap-dmaap-datarouter:master_index>`
+ - Data Router Documentation
+ * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>`
+ - Message Router Documentation
-:ref:`msb apigateway<onap-msb-apigateway:master_index>`
+EXTAPI - External API Framework/NBI
+-----------------------------------
-:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+ * - Document
+ - Description
+ * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
+ - External API Framework Documentation
-Modeling
---------
+HOLMES - Holmes Alarm Correlation and Analysis
+----------------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-:ref:`modeling modelspec<onap-modeling-modelspec:master_index>`
+ * - Document
+ - Description
+ * - :ref:`HOLMES<onap-holmes-rule-management:master_index>`
+ - HOLMES Architecture and APIs
+ * - :ref:`Engine Management<onap-holmes-engine-management:master_index>`
+ - HOLMES Engine Management Documentation
-:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`
+LOGGING - Centralized Logging
+-----------------------------
-MultiVIM Cloud
---------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
+ - ONAP Centralized Logging Documentation
-:ref:`multicloud framework<onap-multicloud-framework:master_index>`
+MSB - Microservices Bus
+-----------------------
-Music
------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`MSB<onap-msb-apigateway:master_index>`
+ - Microservices Bus Documentation
-:ref:`music<onap-music:master_index>`
+MULTICLOUD - MultiCloud Framework
+---------------------------------
-:ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-ONAP Operations Manager
------------------------
+ * - Document
+ - Description
+ * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
+ - MultiCloud Framework Architecture and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+MUSIC - ONAP Multi-Site Integration
+-----------------------------------
-| :ref:`oom<onap-oom:master_index>`
-| :ref:`CMPv2 CertService<onap-oom-certservice:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Optimization Framework
-----------------------
+ * - Document
+ - Description
+ * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
+ - MUSIC Architecture and Guides
+ * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
+ - MUSIC Distribute KV Store Documents
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+OOF - Optimization Framework
+----------------------------
-| :ref:`optf has<onap-optf-has:master_index>`
-| :ref:`optf osdf<onap-optf-osdf:master_index>`
-| :ref:`optf cmso<onap-optf-cmso:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`Homing and Allocation<onap-optf-has:master_index>`
+ - ONAP policy-driven placement optimizing service documentation
+ * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>`
+ - Optimization Service Design Framework documentation
+ * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>`
+ - Change Management Schedule Optimization documentation
+
+OOM - ONAP Operations Manager
+-----------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`OOM<onap-oom:master_index>`
+ - ONAP Operations Manager Documentation
+ * - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>`
+ - ONAP CMPv2 certification support
+
+ORAN - Open-RAN Support in ONAP
+-------------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
+ - O-RAN Support in ONAP (part of CCSDK)
+
+POLICY - Policy Framework
+-------------------------
-Policy Framework
-----------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`Policy<onap-policy-parent:master_index>`
+ - Policy Framework Documentation
-:ref:`policy parent<onap-policy-parent:master_index>`
+PORTAL - Portal Platform
+------------------------
-Portal Platform
----------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`Portal<onap-portal:master_index>`
+ - ONAP Portal Platform Documentation
-:ref:`portal<onap-portal:master_index>`
+SDC - Service Design & Creation
+-------------------------------
-Service Design & Creation
--------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`SDC<onap-sdc:master_index>`
+ - Service Design & Creation Documentation
-:ref:`sdc<onap-sdc:master_index>`
+SDNC - Software Defined Network Controller
+------------------------------------------
-Service Orchestration
----------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`SDNC<onap-sdnc-oam:master_index>`
+ - SDNC Architecture, APIs and Guides
-:ref:`so<onap-so:master_index>`
+SDNR - Software Defined Network Controller for Radio
+----------------------------------------------------
-:ref:`so libs<onap-so-libs:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Software Defined Network Controller
------------------------------------
+ * - Document
+ - Description
+ * - :ref:`SDN-R<onap-ccsdk-features:master_index>`
+ - SDN-R Documentation (part of CCSDK)
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+SO - Service Orchestration
+--------------------------
-:ref:`sdnc oam<onap-sdnc-oam:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Software Defined Network Controller for Radio (SDN-R)
------------------------------------------------------
+ * - Document
+ - Description
+ * - :ref:`SO<onap-so:master_index>`
+ - Service Orchestration Architecture, APIs and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+UUI - Use Case User Interface
+-----------------------------
-:ref:`ccsdk features<onap-ccsdk-features:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Use Case User Interface
------------------------
+ * - Document
+ - Description
+ * - :ref:`UUI<onap-usecase-ui:master_index>`
+ - Usecase-UI Architecture, APIs and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+VFC - Virtual Function Controller
+---------------------------------
-:ref:`usecase-ui<onap-usecase-ui:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Virtual Function Controller
----------------------------
+ * - Document
+ - Description
+ * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
+ - Virtual Function Controller Architecture, APIs and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+VID - Virtual Infrastructure Deployment
+---------------------------------------
-:ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Virtual Infrastructure Deployment
----------------------------------
+ * - Document
+ - Description
+ * - :ref:`VID<onap-vid:master_index>`
+ - Virtual Infrastructure Deployment Architecture, APIs and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+VNFSDK - VNF Software Development Kit
+-------------------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-:ref:`vid<onap-vid:master_index>`
+ * - Document
+ - Description
+ * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
+ - VNF SDK Documentation and User Guides
-VNF Software Development Kit
-----------------------------
+VVP - VNF Validation Platform
+-----------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-:ref:`vnfsdk model<onap-vnfsdk-model:master_index>`
+ * - Document
+ - Description
+ * - :ref:`VVP<onap-vvp-documentation:master_index>`
+ - VNF Validation Platform Documentation
Code Review / doc.git / blobdiff