X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=2afddb76429d92cee48451951a2f999c2ffe93ab;hb=1a16ca9a7e3a3dd948f741ff3d7ed4e800bfb6e5;hp=a45b3dc064ee541c46e16324032a712e8be5bb29;hpb=1bf0d36bcb82b159fdc8087c51d3454832051f46;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index a45b3dc06..2afddb764 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -1,14 +1,312 @@ -.. 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. +.. index:: Developer Guides + .. _doc_onap-developer_guide_projects: -Developing ONAP -=============== -Additional developer level detail is provided for each project and component below. +ONAP components and functionalities +=================================== +Additional developer level detail is provided for each project below. + +Active and Available Inventory +------------------------------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`aai aai-common` +| :ref:`AAI-esr-gui` +| :ref:`aai esr-server` +| :ref:`aai sparky-be` +| :ref:`aai event-clientrst` + + +Application Controller +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`appc deployment` +| :ref:`appc` + +Application Authorization Framework +----------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`aaf authz` +| :ref:`Secret Management Service` + +Command Line Interface +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`cli` + + +Control Loop Automation Management Platform +------------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`clamp` + +Common Controller Software Development Kit +------------------------------------------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`ccsdk distribution` +| :ref:`ccsdk dashboard` +| :ref:`ccsdk platform plugins` +| :ref:`ccsdk apps` +| :ref:`ccsdk cds` + +Data Collection, Analysis, and Events +------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`dcaegen2` + +Data Management as a Platform Data Bus Controller +------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +| :ref:`dmaap dbcapi` +| :ref:`dmaap buscontroller` + +Data Management as a Platform Data Router +----------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +:ref:`dmaap datarouter` + +Data Management as a Platform Message Router +-------------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`dmaap messagerouter messageservice` + +External API Framework +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`externalapi nbi` + + +Holmes +------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`Alarm Correlation and Analysis` +| :ref:`Architecture and APIs` + +Integration +----------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +:ref:`integration` + +Logging Analytics +----------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`logging-analytics` + +Micro Services Bus +------------------ + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`msb apigateway` + +:ref:`msb swagger-sdk` + + +Modeling +-------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`modeling modelspec` + +:ref:`modeling etsicatalog` + +MultiVIM Cloud +-------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`multicloud framework` + +Music +----- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`music` + +:ref:`music distributed-kv-store` + +ONAP Operations Manager +----------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`oom` +| :ref:`oom/platform/cert-service` + +Optimization Framework +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +| :ref:`optf has` +| :ref:`optf osdf` +| :ref:`optf cmso` + +Policy Framework +---------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`policy parent` + +:ref:`policy engine` + +Portal Platform +--------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`portal` + +Service Design & Creation +------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`sdc` + +Service Orchestration +--------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`so` + +:ref:`so libs` + +Software Defined Network Controller +----------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`sdnc oam` + +Software Defined Network Controller for Radio (SDN-R) +----------------------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`ccsdk features` + +Use Case User Interface +----------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`usecase-ui` + +Virtual Function Controller +--------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + +:ref:`vfc nfvo lcm` + +Virtual Infrastructure Deployment +--------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + +:ref:`vid` + +VNF Software Development Kit +---------------------------- .. toctree:: :maxdepth: 2 + :titlesonly: - ../../../../../release/repolist.rst +:ref:`vnfsdk model`