| .. 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 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 |
| * - :ref:`AAF<onap-aaf-authz:master_index>` |
| - AAF Architecture, APIs and Guides |
| * - :ref:`Secret Management Service<onap-aaf-sms:master_index>` |
| - Secret Management Service Architecture and API |
| |
| 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 |
| * - :ref:`ESR<onap-aai-esr-gui:master_index>` |
| - External System Registry GUI Documentation (to be removed ?) |
| * - :ref:`ESR<onap-aai-esr-server:master_index>` |
| - External System Registry Server Documentation (to be removed ?) |
| * - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>` |
| - Sparky - AAI Inventory UI Documentation (to be removed ?) |
| * - :ref:`AAI Event Client<onap-aai-event-client:master_index>` |
| - AAI Event Client Documentation (to be removed ?) |
| |
| APPC - Application Controller |
| ----------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`APPC<onap-appc:master_index>` |
| - APPC Architecture, APIs and Guides |
| * - :ref:`APPC Deployment<onap-appc-deployment:master_index>` |
| - 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 |
| * - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>` |
| - Common Controller Dashboard (To be removed ?) |
| * - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>` |
| - Platform Plugins (To be removed ?) |
| * - :ref:`APPS<onap-ccsdk-apps:master_index>` |
| - Apps optside ODL (To be removed ?) |
| |
| 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-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 |
| |
| DCAE - Data Collection, Analysis and Events |
| ------------------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`DCAE<onap-dcaegen2:master_index>` |
| - DCAE Architecture and Guides |
| |
| DMAAP - Data Management as a Platform |
| ------------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>` |
| - Bus Controller Documentation |
| * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>` |
| - Bus Controller API Documentation |
| * - :ref:`Data Router<onap-dmaap-datarouter:master_index>` |
| - Data Router Documentation |
| * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>` |
| - Message Router Documentation |
| |
| EXTAPI - External API Framework/NBI |
| ----------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>` |
| - External API Framework Documentation |
| |
| HOLMES - Holmes Alarm Correlation and Analysis |
| ---------------------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :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 |
| |
| LOGGING - Centralized Logging |
| ----------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`Logging<onap-logging-analytics:master_index>` |
| - ONAP Centralized Logging Documentation (to be deleted ?) |
| |
| MSB - Microservices Bus |
| ----------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`MSB<onap-msb-apigateway:master_index>` |
| - Microservices Bus Documentation |
| |
| MULTICLOUD - MultiCloud Framework |
| --------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`MULTICLOUD<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 |
| * - :ref:`MUSIC<onap-music:master_index>` |
| - MUSIC Architecture and Guides (To be deleted ?) |
| * - :ref:`Distributed KV Store<onap-music:master_index>` |
| - MUSIC Distribute KV Store Documents (To be deleted ?) |
| |
| 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 |
| |
| 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-certservice: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 |
| ------------------------- |
| |
| .. 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 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`Portal<onap-portal:master_index>` |
| - ONAP Portal Platform Documentation |
| |
| SDC - Service Design & Creation |
| ------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`SDC<onap-sdc:master_index>` |
| - Service Design & Creation Documentation |
| |
| SDNC - Software Defined Network Controller |
| ------------------------------------------ |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`SDCN<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:`SDNR<onap-ccsdk-features:master_index>` |
| - SDN-R Documentation (part of CCSDK) |
| |
| SO - Service Orchestration |
| -------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`SO<onap-so:master_index>` |
| - Service Orchestration Architecture, APIs and Guides |
| * - :ref:`SO Libraries<onap-so-libs:master_index>` |
| - Service Orchestration Build (To be deleted ?) |
| |
| UUI - Use Case User Interface |
| ----------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`UUI<onap-usecase-ui:master_index>` |
| - Usecase-UI Architecture, APIs and Guides |
| |
| VFC - Virtual Function Controller |
| --------------------------------- |
| |
| .. list-table:: |
| :widths: 20 80 |
| :header-rows: 1 |
| |
| * - Document |
| - Description |
| * - :ref:`VF-C<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 |