X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=ac398ca8953986c7e422670fe20d508202301da1;hb=392f71178636b8bd135165a3c45826321296d33e;hp=41e3c70c1ca4e00ba67c1ae13e5b7ec9e3bb5f27;hpb=52b5c09262b614e10bc223dd1811f81760a3337e;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 41e3c70c1..ac398ca89 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -7,341 +7,408 @@ .. _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 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 Model Specification + * - :ref:`ETSI Catalog` + - 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` + - 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` + - 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` + - 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 ` + - 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 ` + - 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` + - 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`. - -* To install the whole ONAP (from a complete demo solution perspective) - refer to :ref:`Setting Up ONAP `. - -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` + - 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 +----------------------------------- -.. 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` + - 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` + - HOLMES Architecture and APIs + * - :ref:`Engine Management` + - 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` + - 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` + - 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 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 +------------------------------- -Service Design & Creation -------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`ORAN` + - 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` + - 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 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` + - 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` + - 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` + - 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` + - 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` + - 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` + - 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` + - 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` + - 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` + - VNF Validation Platform Documentation