-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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.
.. _doc_onap-developer_guide_projects:
-Developing ONAP
-===============
+ONAP components and functionalities
+===================================
Additional developer level detail is provided for each project below.
Active and Available Inventory
:maxdepth: 2
:titlesonly:
- ../../../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
+| :ref:`aai aai-common<onap-aai-aai-common:master_index>`
+| :ref:`AAI-esr-gui<onap-aai-esr-gui:master_index>`
+| :ref:`aai esr-server<onap-aai-esr-server:master_index>`
+| :ref:`aai sparky-be<onap-aai-sparky-be:master_index>`
+| :ref:`aai event-clientrst<onap-aai-event-client:master_index>`
Application Controller
:maxdepth: 2
:titlesonly:
- ../../../submodules/appc/deployment.git/docs/index
- ../../../submodules/appc.git/docs/index
+| :ref:`appc deployment<onap-appc-deployment:master_index>`
+| :ref:`appc<onap-appc:master_index>`
-Closed Loop Automation Platform
--------------------------------
+Application Authorization Framework
+-----------------------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+| :ref:`aaf authz<onap-aaf-authz:master_index>`
+| :ref:`Secret Management Service<onap-aaf-sms:master_index>`
+
+Command Line Interface
+----------------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/clamp.git/docs/index
+:ref:`cli<onap-cli:master_index>`
+
+
+Control Loop Automation Management Platform
+-------------------------------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+:ref:`clamp<onap-clamp:master_index>`
Common Controller Software Development Kit
------------------------------------------
: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
+| :ref:`ccsdk distribution<onap-ccsdk-distribution:master_index>`
+| :ref:`ccsdk dashboard<onap-ccsdk-dashboard:master_index>`
+| :ref:`ccsdk platform plugins<onap-ccsdk-platform-plugins:master_index>`
+| :ref:`ccsdk apps<onap-ccsdk-apps:master_index>`
+| :ref:`ccsdk cds<onap-ccsdk-cds:master_index>`
Data Collection, Analysis, and Events
-------------------------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/dcaegen2.git/docs/index
+:ref:`dcaegen2<onap-dcaegen2:master_index>`
+
+Data Management as a Platform Data Bus Controller
+-------------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+| :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>`
+| :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>`
+
+Data Management as a Platform Data Router
+-----------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+:ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>`
Data Management as a Platform Message Router
--------------------------------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index
+:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>`
-Documentation
--------------
+External API Framework
+----------------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../how-to-use-docs/index.rst
+:ref:`externalapi nbi<onap-externalapi-nbi:master_index>`
Holmes
:maxdepth: 2
:titlesonly:
- Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index>
- Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index>
+| :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>`
+| :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>`
Integration
-----------
-* ONAP Amsterdam 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>`.
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
-Logging Enhancements Project
-----------------------------
+:ref:`integration<onap-integration:master_index>`
+
+Logging Analytics
+-----------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/logging-analytics.git/docs/index
+:ref:`logging-analytics<onap-logging-analytics:master_index>`
Micro Services Bus
------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/msb/apigateway.git/docs/index
- ../../../submodules/msb/swagger-sdk.git/docs/index
+:ref:`msb apigateway<onap-msb-apigateway:master_index>`
-.. Empty folders in this release
- ../../../submodules/msb/discovery.git/docs/index
- ../../../submodules/msb/java-sdk.git/docs/index
+:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>`
Modeling
:maxdepth: 2
:titlesonly:
- ../../../submodules/modeling/modelspec.git/docs/index
- ../../../submodules/modeling/toscaparsers.git/docs/index
+:ref:`modeling modelspec<onap-modeling-modelspec:master_index>`
+
+:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>`
MultiVIM Cloud
--------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/multicloud/framework.git/docs/index
+:ref:`multicloud framework<onap-multicloud-framework:master_index>`
-
-ONAP Command Line Interface
----------------------------
+Music
+-----
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/cli.git/docs/index
+:ref:`music<onap-music:master_index>`
+
+:ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>`
-ONAP Operations Manager (experimental)
---------------------------------------
+ONAP Operations Manager
+-----------------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/oom.git/docs/index
+| :ref:`oom<onap-oom:master_index>`
+| :ref:`oom/platform/cert-service<onap-oom-certservice:master_index>`
-ONAP Use Case User Interface
-----------------------------
+Optimization Framework
+----------------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/usecase-ui.git/docs/index
+| :ref:`optf has<onap-optf-has:master_index>`
+| :ref:`optf osdf<onap-optf-osdf:master_index>`
+| :ref:`optf cmso<onap-optf-cmso:master_index>`
Policy Framework
----------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/policy/engine.git/docs/index
+:ref:`policy parent<onap-policy-parent:master_index>`
+
+:ref:`policy engine<onap-policy-engine:master_index>`
Portal Platform
---------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/portal.git/docs/index
+:ref:`portal<onap-portal:master_index>`
Service Design & Creation
-------------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/sdc.git/docs/index
-
-.. 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
+:ref:`sdc<onap-sdc:master_index>`
Service Orchestration
---------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/so.git/docs/index
- ../../../submodules/so/libs.git/docs/index
+:ref:`so<onap-so:master_index>`
+
+:ref:`so libs<onap-so-libs:master_index>`
Software Defined Network Controller
-----------------------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/sdnc/oam.git/docs/index
-
-.. 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
+:ref:`sdnc oam<onap-sdnc-oam:master_index>`
-Virtual Function Controller
----------------------------
+Software Defined Network Controller for Radio (SDN-R)
+-----------------------------------------------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/vfc/nfvo/lcm.git/docs/index
+:ref:`ccsdk features<onap-ccsdk-features:master_index>`
-Virtual Infrastructure Deployment
----------------------------------
+Use Case User Interface
+-----------------------
.. toctree::
:maxdepth: 2
:titlesonly:
+:ref:`usecase-ui<onap-usecase-ui:master_index>`
- ../../../submodules/vid.git/docs/index
+Virtual Function Controller
+---------------------------
-.. Empty folders for this release
- ../../../submodules/vid/asdcclient.git/docs/index
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
-VNF Requirements
-----------------
+:ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>`
+
+Virtual Infrastructure Deployment
+---------------------------------
.. toctree::
:maxdepth: 2
:titlesonly:
- ../../../submodules/vnfrqts/guidelines.git/docs/index
- ../../../submodules/vnfrqts/requirements.git/docs/index
+:ref:`vid<onap-vid:master_index>`
VNF Software Development Kit
----------------------------
:maxdepth: 2
:titlesonly:
- ../../../submodules/vnfsdk/model.git/docs/index
+:ref:`vnfsdk model<onap-vnfsdk-model:master_index>`
Code Review / doc.git / blobdiff