X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=ec8050f24b5daf8d41d9e4165505de6ce63412b3;hb=8dc2fc3ee30a5c5c3ecbbf8b2333173d29247dd6;hp=213fb462c81b0fd93e0af95cd53280c28d111b87;hpb=4591bef2bcd4664db6d5f4188c60481b30b0a991;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 213fb462c..ec8050f24 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -7,416 +7,256 @@ .. _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 Project Documentation - -Project - ONAP Modeling ------------------------ - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`Model` - - ONAP Model Specification - * - :ref:`ETSI Catalog` - - ONAP ETSI Runtime Catalog Documentation - - -AAF - Application Authorization Framework ------------------------------------------ - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - (in Maintenance) `AAF (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` + * - Component + - Documentation + * - :ref:`aai/aai-common` - AAI Architecture, APIs and Guides - * - (in Maintenance) `ESR GUI (Latest) `_ - - External System Registry GUI Documentation - * - (in Maintenance) `ESR Server (Latest) `_ - - External System Registry Server Documentation - * - :ref:`AAI UI` - - Sparky - AAI Inventory UI Documentation - -APPC - Application Controller ------------------------------ - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - (in Maintenance) `APPC (Frankfurt) `_ - - APPC Architecture, APIs and Guides - * - (in Maintenance) `APPC Deployment (Frankfurt) `_ - - APPC Deployment Documentation + * - :ref:`aai/sparky-be` + - Sparky - AAI Inventory UI CCSDK - Common Controller Software Development Kit -------------------------------------------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`Distribution` + * - 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 - -CDS - Controller Design Studio ------------------------------- - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`CDS` - - 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 ` - - CLAMP Architecture and Guides - -CLI - Command Line Interface ----------------------------- - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`CLI ` - - CLI Documentation + * - :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: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`CPS ` - - CPS Documentation + * - 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: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`DCAE` - - DCAE Architecture and Guides + * - Component + - Documentation + * - :ref:`dcaegen2` + - 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` - - Bus Controller Documentation - * - :ref:`Data Router` - - Data Router Documentation - * - :ref:`Message Router` - - Message Router Documentation + * - Component + - Documentation + * - :ref:`dmaap/buscontroller` + - Bus Controller + * - :ref:`dmaap/datarouter` + - Data Router + * - :ref:`dmaap/messagerouter/messageservice` + - 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` - - External API Framework Documentation + * - Component + - Documentation + * - :ref:`holmes/rule-management` + - Architecture and APIs + * - :ref:`holmes/engine-management` + - Engine Management -HOLMES - Holmes Alarm Correlation and Analysis ----------------------------------------------- +INT - Integration +----------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`HOLMES` - - HOLMES Architecture and APIs - * - :ref:`Engine Management` - - HOLMES Engine Management Documentation + * - Component + - Documentation + * - :ref:`integration` + - Integration Project -LOGGING - Centralized Logging ------------------------------ +MOD - Modeling +-------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - (in Maintenance) `LOGGING (Latest) `_ - - ONAP Centralized Logging Documentation + * - Component + - Documentation + * - :ref:`modeling/etsicatalog` + - ETSI Runtime Catalog MSB - Microservices Bus ----------------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`MSB` - - Microservices Bus Documentation + * - 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: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`MULTICLOUD` + * - Component + - Documentation + * - :ref:`multicloud/framework` - MultiCloud Framework Architecture and Guides - -MUSIC - ONAP Multi-Site Integration ------------------------------------ - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - (in Maintenance) `MUSIC (Frankfurt) `_ - - MUSIC Architecture and Guides - * - (in Maintenance) `MUSIC KV (Latest) `_ - - MUSIC Distribute KV Store Documents - -OOF - Optimization Framework ----------------------------- - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`Homing and Allocation` - - ONAP policy-driven placement optimizing service documentation - * - :ref:`Optimization Service Design Framework` - - Optimization Service Design Framework documentation - * - :ref:`Change Management Schedule Optimization` - - Change Management Schedule Optimization documentation + * - :ref:`multicloud/k8s` + - Kubernetes Reference Deployment (KUD) OOM - ONAP Operations Manager ----------------------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`OOM` - - ONAP Operations Manager Documentation - * - :ref:`OOM Certification Service` - - ONAP CMPv2 certification support + * - Component + - Documentation + * - :ref:`oom` + - ONAP Operations Manager + * - :ref:`oom/offline-installer` + - 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` - - O-RAN Support in ONAP (part of CCSDK) + * - Component + - Documentation + * - :ref:`optf/has` + - Homing and Allocation + * - :ref:`optf/osdf` + - Optimization Service Design Framework POLICY - Policy Framework ------------------------- .. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`Policy` - - Policy Framework Documentation - -PORTAL - Portal Platform ------------------------- - -.. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`Portal` - - ONAP Portal Platform Documentation + * - Component + - Documentation + * - :ref:`policy/parent` + - Policy Framework SDC - Service Design & Creation ------------------------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`SDC` - - Service Design & Creation Documentation + * - Component + - Documentation + * - :ref:`sdc` + - Service Design & Creation SDNC - Software Defined Network Controller ------------------------------------------ .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`SDNC` + * - Component + - Documentation + * - :ref:`sdnc/oam` - 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` - - SDN-R Documentation (part of CCSDK) - SO - Service Orchestration -------------------------- .. list-table:: - :widths: 20 80 + :widths: auto :header-rows: 1 - * - Document - - Description - * - :ref:`SO` + * - Component + - Documentation + * - :ref:`so` - 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` + * - Component + - Documentation + * - :ref:`usecase-ui` - 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` + * - Component + - Documentation + * - :ref:`vfc/nfvo/lcm` - Virtual Function Controller Architecture, APIs and Guides -VID - Virtual Infrastructure Deployment ---------------------------------------- - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`VID` - - Virtual Infrastructure Deployment Architecture, APIs and Guides - -VNFSDK - VNF Software Development Kit -------------------------------------- - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`VnfSDK` - - VNF SDK Documentation and User Guides - -VVP - VNF Validation Platform ------------------------------ - -.. list-table:: - :widths: 20 80 - :header-rows: 1 - - * - Document - - Description - * - :ref:`VVP` - - VNF Validation Platform Documentation