From 65bec69096b0a2ef18cd72d87b89757da4ae1906 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 11 Aug 2022 13:05:18 +0200 Subject: improve navigation and readability Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: Ib4f8246d548a77885c5f6c5457ce2c3b20e275b6 --- docs/platform/components/index.rst | 262 +++++++++++++++++++++++++++++++++++++ 1 file changed, 262 insertions(+) create mode 100644 docs/platform/components/index.rst (limited to 'docs/platform/components') diff --git a/docs/platform/components/index.rst b/docs/platform/components/index.rst new file mode 100644 index 000000000..ec8050f24 --- /dev/null +++ b/docs/platform/components/index.rst @@ -0,0 +1,262 @@ +.. This work is licensed under a Creative Commons Attribution +.. 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +.. index:: Developer Guides + +.. _doc_onap-developer_guide_projects: + +ONAP Components and Functionalities +=================================== +Here you will find the detailed documentation of maintained projects, +ONAP components and functionalities. + +AAI - Active and Available Inventory +------------------------------------ + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`aai/aai-common` + - AAI Architecture, APIs and Guides + * - :ref:`aai/sparky-be` + - Sparky - AAI Inventory UI + +CCSDK - Common Controller Software Development Kit +-------------------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`ccsdk/apps` + - Micro Services for CCSDK + * - :ref:`ccsdk/cds` + - Controller Design Studio Architecture and Guides + * - :ref:`ccsdk/distribution` + - TOSCA Orchestration Plugin, Directed Graph Support + * - :ref:`ccsdk/features` + - Software Defined Network Controller for Radio (SDNR) + * - :ref:`ccsdk/oran` + - O-RAN Support in ONAP + +CPS - Configuration Persistence Service +--------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`cps` + - CPS Global + * - :ref:`cps/cps-temporal` + - CPS Temporal + * - :ref:`cps/ncmp/dmi-plugin` + - CPS DMI Plugin + +DCAE - Data Collection, Analysis and Events +------------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`dcaegen2` + - DCAE (Gen2) Architecture and Guides + +DMAAP - Data Movement as a Platform +----------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`dmaap/buscontroller` + - Bus Controller + * - :ref:`dmaap/datarouter` + - Data Router + * - :ref:`dmaap/messagerouter/messageservice` + - Message Router + +HOLMES - Alarm Correlation and Analysis +---------------------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`holmes/rule-management` + - Architecture and APIs + * - :ref:`holmes/engine-management` + - Engine Management + +INT - Integration +----------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`integration` + - Integration Project + +MOD - Modeling +-------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`modeling/etsicatalog` + - ETSI Runtime Catalog + +MSB - Microservices Bus +----------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`msb/apigateway` + - Microservices Bus + * - :ref:`msb/discovery` + - + * - :ref:`msb/java-sdk` + - + * - :ref:`msb/swagger-sdk` + - Swagger Software Development Kit + +MULTICLOUD - MultiCloud Framework +--------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`multicloud/framework` + - MultiCloud Framework Architecture and Guides + * - :ref:`multicloud/k8s` + - Kubernetes Reference Deployment (KUD) + +OOM - ONAP Operations Manager +----------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`oom` + - ONAP Operations Manager + * - :ref:`oom/offline-installer` + - OOM Offline Installer + +OOF - Optimization Framework +---------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`optf/has` + - Homing and Allocation + * - :ref:`optf/osdf` + - Optimization Service Design Framework + +POLICY - Policy Framework +------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`policy/parent` + - Policy Framework + +SDC - Service Design & Creation +------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`sdc` + - Service Design & Creation + +SDNC - Software Defined Network Controller +------------------------------------------ + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`sdnc/oam` + - SDNC Architecture, APIs and Guides + +SO - Service Orchestration +-------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`so` + - Service Orchestration Architecture, APIs and Guides + +UUI - Usecase User Interface +----------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`usecase-ui` + - Usecase-UI Architecture, APIs and Guides + +VFC - Virtual Function Controller +--------------------------------- + +.. list-table:: + :widths: auto + :header-rows: 1 + + * - Component + - Documentation + * - :ref:`vfc/nfvo/lcm` + - Virtual Function Controller Architecture, APIs and Guides + -- cgit 1.2.3-korg