.. _doc_onap-developer_guide_projects:
-ONAP components and functionalities
+ONAP Components and Functionalities
===================================
-Here you will find the detailed documentation of projects,
-ONAP components and functionalities
-
-Project - ONAP Integration
---------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`Integration<onap-integration:master_index>`
- - ONAP Integration Project Documentation
-
-Project - ONAP Modeling
------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - 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
-
-
-AAF - Application Authorization Framework
------------------------------------------
-
-.. 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
+Here you will find the detailed documentation of maintained projects,
+ONAP components and functionalities.
AAI - Active and Available Inventory
------------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`AAI<onap-aai-aai-common:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`aai/aai-common<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
+ * - :ref:`aai/sparky-be<onap-aai-sparky-be:master_index>`
+ - Sparky - AAI Inventory UI
CCSDK - Common Controller Software Development Kit
--------------------------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`Distribution<onap-ccsdk-distribution:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`ccsdk/apps<onap-ccsdk-apps:master_index>`
+ - Micro Services for CCSDK
+ * - :ref:`ccsdk/cds<onap-ccsdk-cds:master_index>`
+ - Controller Design Studio Architecture and Guides
+ * - :ref:`ccsdk/distribution<onap-ccsdk-distribution:master_index>`
- TOSCA Orchestration Plugin, Directed Graph Support
-
-CDS - Controller Design Studio
-------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`CDS<onap-ccsdk-cds:master_index>`
- - Controller Design Studio Architecture and Guides (part of CCSDK)
-
-CLAMP - Control Loop Automation Management Platform
----------------------------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`CLAMP <onap-policy-clamp:master_index>`
- - CLAMP Architecture and Guides
-
-CLI - Command Line Interface
-----------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`CLI <onap-cli:master_index>`
- - CLI Documentation
+ * - :ref:`ccsdk/features<onap-ccsdk-features:master_index>`
+ - Software Defined Network Controller for Radio (SDNR)
+ * - :ref:`ccsdk/oran<onap-ccsdk-oran:master_index>`
+ - O-RAN Support in ONAP
CPS - Configuration Persistence Service
---------------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`CPS <onap-cps:master_index>`
- - CPS Documentation
+ * - Component
+ - Documentation
+ * - :ref:`cps<onap-cps:master_index>`
+ - CPS Global
+ * - :ref:`cps/cps-temporal<onap-cps-cps-temporal:master_index>`
+ - CPS Temporal
+ * - :ref:`cps/ncmp/dmi-plugin<onap-cps-ncmp-dmi-plugin:master_index>`
+ - CPS DMI Plugin
DCAE - Data Collection, Analysis and Events
-------------------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`DCAE<onap-dcaegen2:master_index>`
- - DCAE Architecture and Guides
+ * - Component
+ - Documentation
+ * - :ref:`dcaegen2<onap-dcaegen2:master_index>`
+ - DCAE (Gen2) Architecture and Guides
-DMAAP - Data Management as a Platform
--------------------------------------
+DMAAP - Data Movement as a Platform
+-----------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - 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
+ * - Component
+ - Documentation
+ * - :ref:`dmaap/buscontroller<onap-dmaap-buscontroller:master_index>`
+ - Bus Controller
+ * - :ref:`dmaap/datarouter<onap-dmaap-datarouter:master_index>`
+ - Data Router
+ * - :ref:`dmaap/messagerouter/messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
+ - Message Router
-EXTAPI - External API Framework/NBI
------------------------------------
+HOLMES - Alarm Correlation and Analysis
+----------------------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
- - External API Framework Documentation
+ * - Component
+ - Documentation
+ * - :ref:`holmes/rule-management<onap-holmes-rule-management:master_index>`
+ - Architecture and APIs
+ * - :ref:`holmes/engine-management<onap-holmes-engine-management:master_index>`
+ - Engine Management
-HOLMES - Holmes Alarm Correlation and Analysis
-----------------------------------------------
+INT - Integration
+-----------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - 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
+ * - Component
+ - Documentation
+ * - :ref:`integration<onap-integration:master_index>`
+ - Integration Project
-LOGGING - Centralized Logging
------------------------------
+MOD - Modeling
+--------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
- - ONAP Centralized Logging Documentation
+ * - Component
+ - Documentation
+ * - :ref:`modeling/etsicatalog<onap-modeling-etsicatalog:master_index>`
+ - ETSI Runtime Catalog
MSB - Microservices Bus
-----------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`MSB<onap-msb-apigateway:master_index>`
- - Microservices Bus Documentation
+ * - Component
+ - Documentation
+ * - :ref:`msb/apigateway<onap-msb-apigateway:master_index>`
+ - Microservices Bus
+ * - :ref:`msb/discovery<onap-msb-discovery:master_index>`
+ - <to be revised>
+ * - :ref:`msb/java-sdk<onap-msb-java-sdk:master_index>`
+ - <to be revised>
+ * - :ref:`msb/swagger-sdk<onap-msb-swagger-sdk:master_index>`
+ - Swagger Software Development Kit
MULTICLOUD - MultiCloud Framework
---------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`multicloud/framework<onap-multicloud-framework:master_index>`
- MultiCloud Framework Architecture and Guides
-
-MUSIC - ONAP Multi-Site Integration
------------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - 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
-
-OOF - Optimization Framework
-----------------------------
-
-.. 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
+ * - :ref:`multicloud/k8s<onap-multicloud-k8s:master_index>`
+ - Kubernetes Reference Deployment (KUD)
OOM - ONAP Operations Manager
-----------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
: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
+ * - Component
+ - Documentation
+ * - :ref:`oom<onap-oom:master_index>`
+ - ONAP Operations Manager
+ * - :ref:`oom/offline-installer<onap-oom-offline-installer:master_index>`
+ - OOM Offline Installer
-ORAN - Open-RAN Support in ONAP
--------------------------------
+OOF - Optimization Framework
+----------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
- - O-RAN Support in ONAP (part of CCSDK)
+ * - Component
+ - Documentation
+ * - :ref:`optf/has<onap-optf-has:master_index>`
+ - Homing and Allocation
+ * - :ref:`optf/osdf<onap-optf-osdf:master_index>`
+ - Optimization Service Design Framework
POLICY - Policy Framework
-------------------------
.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`Policy<onap-policy-parent:master_index>`
- - Policy Framework Documentation
-
-PORTAL - Portal Platform
-------------------------
-
-.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`Portal<onap-portal:master_index>`
- - ONAP Portal Platform Documentation
+ * - Component
+ - Documentation
+ * - :ref:`policy/parent<onap-policy-parent:master_index>`
+ - Policy Framework
SDC - Service Design & Creation
-------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`SDC<onap-sdc:master_index>`
- - Service Design & Creation Documentation
+ * - Component
+ - Documentation
+ * - :ref:`sdc<onap-sdc:master_index>`
+ - Service Design & Creation
SDNC - Software Defined Network Controller
------------------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`SDNC<onap-sdnc-oam:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`sdnc/oam<onap-sdnc-oam:master_index>`
- SDNC Architecture, APIs and Guides
-SDNR - Software Defined Network Controller for Radio
-----------------------------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`SDN-R<onap-ccsdk-features:master_index>`
- - SDN-R Documentation (part of CCSDK)
-
SO - Service Orchestration
--------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`SO<onap-so:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`so<onap-so:master_index>`
- Service Orchestration Architecture, APIs and Guides
-UUI - Use Case User Interface
+UUI - Usecase User Interface
-----------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`UUI<onap-usecase-ui:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`usecase-ui<onap-usecase-ui:master_index>`
- Usecase-UI Architecture, APIs and Guides
VFC - Virtual Function Controller
---------------------------------
.. list-table::
- :widths: 20 80
+ :widths: auto
:header-rows: 1
- * - Document
- - Description
- * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>`
+ * - Component
+ - Documentation
+ * - :ref:`vfc/nfvo/lcm<onap-vfc-nfvo-lcm:master_index>`
- Virtual Function Controller Architecture, APIs and Guides
-VID - Virtual Infrastructure Deployment
----------------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`VID<onap-vid:master_index>`
- - Virtual Infrastructure Deployment Architecture, APIs and Guides
-
-VNFSDK - VNF Software Development Kit
--------------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
- - VNF SDK Documentation and User Guides
-
-VVP - VNF Validation Platform
------------------------------
-
-.. list-table::
- :widths: 20 80
- :header-rows: 1
-
- * - Document
- - Description
- * - :ref:`VVP<onap-vvp-documentation:master_index>`
- - VNF Validation Platform Documentation
Code Review / doc.git / blobdiff