X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=1e3c751da552d9f2003d81fa89ad80baa803683d;hb=f4243bd9acd4bdf16c5d49a275abe238fedf3ce2;hp=7bbda267b53f9f963771d1e1ba19d5895e9f080e;hpb=220be63fa1cb572cafa673e785db85b9cf48b510;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 7bbda267b..1e3c751da 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -9,342 +9,456 @@ ONAP components and functionalities =================================== -Additional developer level detail is provided for each project below. - -Active and Available Inventory ------------------------------- - -.. toctree:: - :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 - ../../../submodules/aai/event-client.git/docs/index.rst - - -Application Controller ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/appc/deployment.git/docs/index - ../../../submodules/appc.git/docs/index - -Application Authorization Framework ------------------------------------ - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/aaf/authz.git/docs/index - Secret Management Service <../../../submodules/aaf/sms.git/docs/index> - -Command Line Interface ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/cli.git/docs/index - - -Control Loop Automation Management Platform -------------------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: +Here you will find the detailed documentation of projects, +ONAP components and functionalities - ../../../submodules/clamp.git/docs/index +Project - ONAP Integration +-------------------------- -Common Controller Software Development Kit ------------------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/ccsdk/distribution.git/docs/index - ../../../submodules/ccsdk/dashboard.git/docs/index - ../../../submodules/ccsdk/platform/plugins.git/docs/index - ../../../submodules/ccsdk/apps.git/docs/index - ../../../submodules/ccsdk/cds.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/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 -------------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`Integration` + - ONAP Integration Project Documentation - ../../../submodules/dcaegen2.git/docs/index +Project - ONAP Modeling +----------------------- -Data Management as a Platform Data Bus Controller -------------------------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 1 - :titlesonly: + * - Document + - Description + * - :ref:`Model` + - ONAP Model Specification + * - :ref:`ETSI Catalog` + - ONAP ETSI Runtime Catalog Documentation - ../../../submodules/dmaap/dbcapi.git/docs/index - ../../../submodules/dmaap/buscontroller.git/docs/index -Data Management as a Platform Data Router +AAF - Application Authorization Framework ----------------------------------------- -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../submodules/dmaap/datarouter.git/docs/index - -Data Management as a Platform Message Router --------------------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/dmaap/messagerouter/messageservice.git/docs/index - -Development Tools ------------------ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../submodules/integration/devtool.git/docs/source/index - - -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 ------------ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - ../../../submodules/integration.git/docs/index - -Logging Analytics ------------------ - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/logging-analytics.git/docs/index - -Micro Services Bus ------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`AAF` +======= + * - (in Maintenance) `AAF (Frankfurt) `_ +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + - AAF Architecture, APIs and Guides +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`Secret Management Service` + - Secret Management Service Architecture and API +======= +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + +AAI - Active and Available Inventory +------------------------------------ + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`AAI` + - AAI Architecture, APIs and Guides +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`ESR` + - External System Registry GUI Documentation (to be removed ?) + * - :ref:`ESR` + - External System Registry Server Documentation (to be removed ?) + * - :ref:`AAI Inventory UI` + - Sparky - AAI Inventory UI Documentation (to be removed ?) + * - :ref:`AAI Event Client` + - AAI Event Client Documentation (to be removed ?) +======= + * - (in Maintenance) `ESR GUI (Latest) `_ + - External System Registry GUI Documentation + * - (in Maintenance) `ESR Server (Latest) `_ + - External System Registry Server Documentation + * - (in Maintenance) :ref:`AAI UI` + - Sparky - AAI Inventory UI Documentation +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + +APPC - Application Controller +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`APPC` +======= + * - (in Maintenance) `APPC (Frankfurt) `_ +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + - APPC Architecture, APIs and Guides +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`APPC Deployment` +======= + * - (in Maintenance) `APPC Deployment (Frankfurt) `_ +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + - APPC Deployment Documentation + +CCSDK - Common Controller Software Development Kit +-------------------------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`Distribution` + - TOSCA Orchestration Plugin, Directed Graph Support + * - :ref:`Dashboard` + - Common Controller Dashboard (To be removed ?) + * - :ref:`Platform Plugins` + - Platform Plugins (To be removed ?) + * - :ref:`APPS` + - Apps optside ODL (To be removed ?) + +CDS - Controller Design Studio +------------------------------ -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/msb/apigateway.git/docs/index - ../../../submodules/msb/swagger-sdk.git/docs/index + * - Document + - Description + * - :ref:`CDS` + - Controller Design Studio Architecture and Guides (part of CCSDK) -.. Empty folders in this release - ../../../submodules/msb/discovery.git/docs/index - ../../../submodules/msb/java-sdk.git/docs/index +CLAMP - Control Loop Automation Management Platform +--------------------------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Modeling --------- + * - Document + - Description + * - :ref:`CLAMP ` + - CLAMP Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +CLI - Command Line Interface +---------------------------- - ../../../submodules/modeling/modelspec.git/docs/index - ../../../submodules/modeling/etsicatalog.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -MultiVIM Cloud --------------- + * - Document + - Description + * - :ref:`CLI ` + - CLI Documentation -.. toctree:: - :maxdepth: 2 - :titlesonly: +DCAE - Data Collection, Analysis and Events +------------------------------------------- - ../../../submodules/multicloud/framework.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Music ------ + * - Document + - Description + * - :ref:`DCAE` + - DCAE Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +DMAAP - Data Management as a Platform +------------------------------------- - ../../../submodules/music.git/docs/index - ../../../submodules/music/distributed-kv-store.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`Bus Controller` + - Bus Controller Documentation + * - :ref:`Bus Controller API` + - Bus Controller API Documentation + * - :ref:`Data Router` + - Data Router Documentation + * - :ref:`Message Router` + - Message Router Documentation + +EXTAPI - External API Framework/NBI +----------------------------------- -ONAP Operations Manager +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`EXTAPI` + - External API Framework Documentation + +HOLMES - Holmes Alarm Correlation and Analysis +---------------------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`HOLMES` + - HOLMES Architecture and APIs + * - :ref:`Engine Management` + - HOLMES Engine Management Documentation + +LOGGING - Centralized Logging +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`Logging` + - ONAP Centralized Logging Documentation (to be deleted ?) +======= + * - (in Maintenance) `LOGGING (Latest) `_ + - ONAP Centralized Logging Documentation +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + +MSB - Microservices Bus ----------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/oom.git/docs/index - -Optimization Framework ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/optf/has.git/docs/index - ../../../submodules/optf/osdf.git/docs/index - ../../../submodules/optf/cmso.git/docs/index + * - Document + - Description + * - :ref:`MSB` + - Microservices Bus Documentation -Policy Framework ----------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: +MULTICLOUD - MultiCloud Framework +--------------------------------- - ../../../submodules/policy/parent.git/docs/index - ../../../submodules/policy/engine.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Portal Platform ---------------- + * - Document + - Description + * - :ref:`MULTICLOUD` + - MultiCloud Framework Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +MUSIC - ONAP Multi-Site Integration +----------------------------------- - ../../../submodules/portal.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + * - :ref:`MUSIC` + - MUSIC Architecture and Guides (To be deleted ?) + * - :ref:`Distributed KV Store` + - MUSIC Distribute KV Store Documents (To be deleted ?) +======= + * - (in Maintenance) `MUSIC (Frankfurt) `_ + - MUSIC Architecture and Guides + * - (in Maintenance) `MUSIC KV (Latest) `_ + - MUSIC Distribute KV Store Documents +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + +OOF - Optimization Framework +---------------------------- -Service Design & Creation +.. 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 + +OOM - ONAP Operations Manager +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`OOM` + - ONAP Operations Manager Documentation + * - :ref:`OOM Certification Service` + - ONAP CMPv2 certification support + +ORAN - Open-RAN Support in ONAP +------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`ORAN` + - O-RAN Support in ONAP (part of CCSDK) + +POLICY - Policy Framework ------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/sdc.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. 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 + * - Document + - Description + * - :ref:`Policy` + - Policy Framework Documentation -Service Orchestration ---------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/so.git/docs/index - ../../../submodules/so/libs.git/docs/index - -Software Defined Network Controller ------------------------------------ +PORTAL - Portal Platform +------------------------ -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/sdnc/oam.git/docs/index + * - Document + - Description + * - :ref:`Portal` + - ONAP Portal Platform Documentation -.. 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 +SDC - Service Design & Creation +------------------------------- -Software Defined Network Controller for Radio (SDN-R) ------------------------------------------------------ +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`SDC` + - Service Design & Creation Documentation - ../../../submodules/ccsdk/features.git/docs/index - -Use Case User Interface ------------------------ - -.. toctree:: - :maxdepth: 2 - :titlesonly: +SDNC - Software Defined Network Controller +------------------------------------------ - ../../../submodules/usecase-ui.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`SDNC` + - 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 + :header-rows: 1 + + * - Document + - Description + * - :ref:`SO` + - Service Orchestration Architecture, APIs and Guides + * - :ref:`SO Libraries` +<<<<<<< HEAD (2d25f5 Merge "Update release notes list to Guilin release Update Mu) + - Service Orchestration Build (To be deleted ?) +======= + - ONAP SO/libs Documentation +>>>>>>> CHANGE (8787af Added links to older release docs for maintained components) + +UUI - Use Case User Interface +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`UUI` + - Usecase-UI Architecture, APIs and Guides + +VFC - Virtual Function Controller +--------------------------------- -Virtual Function Controller ---------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`VF-C` + - Virtual Function Controller Architecture, APIs and Guides - ../../../submodules/vfc/nfvo/lcm.git/docs/index +VID - Virtual Infrastructure Deployment +--------------------------------------- -Virtual Infrastructure Deployment ---------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`VID` + - Virtual Infrastructure Deployment Architecture, APIs and Guides +VNFSDK - VNF Software Development Kit +------------------------------------- - ../../../submodules/vid.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. Empty folders for this release - ../../../submodules/vid/asdcclient.git/docs/index + * - Document + - Description + * - :ref:`VnfSDK` + - VNF SDK Documentation and User Guides -VNF Software Development Kit ----------------------------- +VVP - VNF Validation Platform +----------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/vnfsdk/model.git/docs/index + * - Document + - Description + * - :ref:`VVP` + - VNF Validation Platform Documentation