.. _doc_onap-developer_guide_projects:
-Developing ONAP
-===============
-Additional developer level detail is provided for each project below.
+ONAP components and functionalities
+===================================
+Here you will find the detailed documentation of projects,
+ONAP components and functionalities
-Active and Available Inventory
-------------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+Project - ONAP Integration
+--------------------------
- ../../../submodules/aai/aai-common.git/docs/index
- AAI-esr-gui <../../../submodules/aai/esr-gui.git/docs/index>
- ../../../submodules/aai/esr-server.git/docs/index
- ../../../submodules/aai/sparky-be.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+ * - Document
+ - Description
+ * - :ref:`Integration<onap-integration:master_index>`
+ - ONAP Integration Project Documentation
-Application Controller
-----------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+Project - ONAP Modeling
+-----------------------
- ../../../submodules/appc/deployment.git/docs/index
- ../../../submodules/appc.git/docs/index
+.. 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) Documentation can be found in previous ONAP releases
+ - AAF Architecture, APIs and Guides
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - 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
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - External System Registry GUI Documentation
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - External System Registry Server Documentation
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - Sparky - AAI Inventory UI Documentation
+
+APPC - Application Controller
+-----------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - APPC Architecture, APIs and Guides
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - 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
+------------------------------
-Application Authorization Framework
------------------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`CDS<onap-ccsdk-cds:master_index>`
+ - Controller Design Studio Architecture and Guides (part of CCSDK)
- ../../../submodules/aaf/authz.git/docs/index
+CLAMP - Control Loop Automation Management Platform
+---------------------------------------------------
-Command Line Interface
-----------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`CLAMP <onap-clamp:master_index>`
+ - CLAMP Architecture and Guides
- ../../../submodules/cli.git/docs/index
+CLI - Command Line Interface
+----------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Closed Loop Automation Platform
--------------------------------
+ * - Document
+ - Description
+ * - :ref:`CLI <onap-cli:master_index>`
+ - CLI Documentation
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+DCAE - Data Collection, Analysis and Events
+-------------------------------------------
- ../../../submodules/clamp.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Common Controller Software Development Kit
-------------------------------------------
+ * - Document
+ - Description
+ * - :ref:`DCAE<onap-dcaegen2:master_index>`
+ - DCAE Architecture and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/ccsdk/distribution.git/docs/index
- ../../../submodules/ccsdk/dashboard.git/docs/index
-
-.. Being consolidated in ccsdk distribution
- ../../../submodules/ccsdk/platform/blueprints.git/docs/index
- ../../../submodules/ccsdk/platform/nbapi.git/docs/index
- ../../../submodules/ccsdk/storage/esaas.git/docs/index
- ../../../submodules/ccsdk/storage/pgaas.git/docs/index
- ../../../submodules/ccsdk/utils.git/docs/index
- ../../../submodules/ccsdk/parent.git/docs/index
- ../../../submodules/ccsdk/platform/plugins.git/docs/index
- ../../../submodules/ccsdk/sli/adaptors.git/docs/index
- ../../../submodules/ccsdk/sli/core.git/docs/index
- ../../../submodules/ccsdk/sli/northbound.git/docs/index
- ../../../submodules/ccsdk/sli/plugins.git/docs/index
-
-Data Collection, Analysis, and Events
+DMAAP - Data Management as a Platform
-------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/dcaegen2.git/docs/index
-
-Data Management as a Platform Message Router
---------------------------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
-
-Documentation
--------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../how-to-use-docs/index.rst
-
-
-External API Framework
-----------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/externalapi/nbi.git/docs/index
-
-
-Holmes
-------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
- Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
-
-Integration
------------
-
-* ONAP Beijing release content is specified within a list of project
- artifact versions available in the form of
- a :ref:`manifest<doc-release-manifest>`.
-
-* To install the whole ONAP (from a complete demo solution perspective)
- refer to :ref:`Setting Up ONAP <demo-installing-running-onap-requirements>`.
-
-Logging Analytics
------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/logging-analytics.git/docs/index
-
-Micro Services Bus
-------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/msb/apigateway.git/docs/index
- ../../../submodules/msb/swagger-sdk.git/docs/index
-
-.. Empty folders in this release
- ../../../submodules/msb/discovery.git/docs/index
- ../../../submodules/msb/java-sdk.git/docs/index
-
-
-Modeling
---------
+.. 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
+-----------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/modeling/modelspec.git/docs/index
- ../../../submodules/modeling/toscaparsers.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>`
+ - External API Framework Documentation
-MultiVIM Cloud
---------------
+HOLMES - Holmes Alarm Correlation and Analysis
+----------------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/multicloud/framework.git/docs/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
-Music
------
+LOGGING - Centralized Logging
+-----------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/music.git/docs/index
+ * - Document
+ - Description
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - ONAP Centralized Logging Documentation
-ONAP Operations Manager
+MSB - Microservices Bus
-----------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/oom.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`MSB<onap-msb-apigateway:master_index>`
+ - Microservices Bus Documentation
-Optimization Framework
-----------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+MULTICLOUD - MultiCloud Framework
+---------------------------------
- ../../../submodules/optf/has.git/docs/index
- ../../../submodules/optf/osdf.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Policy Framework
-----------------
+ * - Document
+ - Description
+ * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>`
+ - MultiCloud Framework Architecture and Guides
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+MUSIC - ONAP Multi-Site Integration
+-----------------------------------
- ../../../submodules/policy/engine.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Portal Platform
----------------
+ * - Document
+ - Description
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - MUSIC Architecture and Guides
+ * - (in Maintenance) Documentation can be found in previous ONAP releases
+ - MUSIC Distribute KV Store Documents
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+OOF - Optimization Framework
+----------------------------
- ../../../submodules/portal.git/docs/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-certservice:master_index>`
+ - ONAP CMPv2 certification support
+
+ORAN - Open-RAN Support in ONAP
+-------------------------------
-Service Design & Creation
--------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+ * - Document
+ - Description
+ * - :ref:`ORAN<onap-ccsdk-oran:master_index>`
+ - O-RAN Support in ONAP (part of CCSDK)
- ../../../submodules/sdc.git/docs/index
+POLICY - Policy Framework
+-------------------------
-.. Empty folders for this release
- ../../../submodules/sdc/jtosca.git/docs/index
- ../../../submodules/sdc/sdc-distribution-client.git/docs/index
- ../../../submodules/sdc/sdc-docker-base.git/docs/index
- ../../../submodules/sdc/sdc-titan-cassandra.git/docs/index
- ../../../submodules/sdc/sdc-tosca.git/docs/index
- ../../../submodules/sdc/sdc-workflow-designer.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Service Orchestration
----------------------
+ * - Document
+ - Description
+ * - :ref:`Policy<onap-policy-parent:master_index>`
+ - Policy Framework Documentation
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+PORTAL - Portal Platform
+------------------------
- ../../../submodules/so.git/docs/index
- ../../../submodules/so/libs.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-Software Defined Network Controller
------------------------------------
+ * - Document
+ - Description
+ * - :ref:`Portal<onap-portal:master_index>`
+ - ONAP Portal Platform Documentation
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+SDC - Service Design & Creation
+-------------------------------
- ../../../submodules/sdnc/oam.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-.. Empty folders for this release
- ../../../submodules/sdnc/adaptors.git/docs/index
- ../../../submodules/sdnc/architecture.git/docs/index
- ../../../submodules/sdnc/core.git/docs/index
- ../../../submodules/sdnc/features.git/docs/index
- ../../../submodules/sdnc/northbound.git/docs/index
- ../../../submodules/sdnc/parent.git/docs/index
- ../../../submodules/sdnc/plugins.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`SDC<onap-sdc:master_index>`
+ - Service Design & Creation Documentation
-Use Case User Interface
------------------------
+SDNC - Software Defined Network Controller
+------------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/usecase-ui.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`SDCN<onap-sdnc-oam:master_index>`
+ - SDNC Architecture, APIs and Guides
-User Interface Applications
----------------------------
+SDNR - Software Defined Network Controller for Radio
+----------------------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/ui/dmaapbc.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`SDNR<onap-ccsdk-features:master_index>`
+ - SDN-R Documentation (part of CCSDK)
-Virtual Function Controller
----------------------------
+SO - Service Orchestration
+--------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/vfc/nfvo/lcm.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`SO<onap-so:master_index>`
+ - Service Orchestration Architecture, APIs and Guides
-Virtual Infrastructure Deployment
----------------------------------
+UUI - Use Case User Interface
+-----------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+ * - Document
+ - Description
+ * - :ref:`UUI<onap-usecase-ui:master_index>`
+ - Usecase-UI Architecture, APIs and Guides
- ../../../submodules/vid.git/docs/index
+VFC - Virtual Function Controller
+---------------------------------
-.. Empty folders for this release
- ../../../submodules/vid/asdcclient.git/docs/index
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
-VNF Requirements
-----------------
+ * - 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
+---------------------------------------
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/vnfrqts/guidelines.git/docs/index
- ../../../submodules/vnfrqts/requirements.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`VID<onap-vid:master_index>`
+ - Virtual Infrastructure Deployment Architecture, APIs and Guides
-VNF Software Development Kit
-----------------------------
+VNFSDK - VNF Software Development Kit
+-------------------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/vnfsdk/model.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>`
+ - VNF SDK Documentation and User Guides
-VNF Validation Project
------------------------
+VVP - VNF Validation Platform
+-----------------------------
-.. toctree::
- :maxdepth: 2
- :titlesonly:
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
- ../../../submodules/vvp/documentation.git/docs/index
+ * - Document
+ - Description
+ * - :ref:`VVP<onap-vvp-documentation:master_index>`
+ - VNF Validation Platform Documentation
Code Review / doc.git / blobdiff