X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fguides%2Fonap-developer%2Fdeveloping%2Findex.rst;h=403f1ff1fb9df351c5785b7a5c63206842c6c23a;hb=15f3917911bc6778758739301c4246e84de3ee5d;hp=1e04d182292ba1d731e8507ca2e9f381f7305ace;hpb=38c451a3c205d208830e9a8bfdc6f767a773ac94;p=doc.git diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 1e04d1822..403f1ff1f 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -7,355 +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: - - ../../../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 +Project - ONAP Integration +-------------------------- -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 ----------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`Integration` + - ONAP Integration Project Documentation - ../../../submodules/cli.git/docs/index - - -Closed Loop Automation Platform -------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/clamp.git/docs/index - -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 - -.. 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/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 -------------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../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 - -Documentation -------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../how-to-use-docs/index.rst - +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - (in Maintenance) `AAF (Frankfurt) `_ + - AAF Architecture, APIs and Guides + +AAI - Active and Available Inventory +------------------------------------ + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`AAI` + - AAI Architecture, APIs and Guides + * - (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 + +APPC - Application Controller +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - (in Maintenance) `APPC (Frankfurt) `_ + - APPC Architecture, APIs and Guides + * - (in Maintenance) `APPC Deployment (Frankfurt) `_ + - 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 +------------------------------ -External API 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/externalapi/nbi.git/docs/index +CLAMP - Control Loop Automation Management Platform +--------------------------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Holmes ------- + * - Document + - Description + * - :ref:`CLAMP ` + - CLAMP Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +CLI - Command Line Interface +---------------------------- - Alarm Correlation and Analysis <../../../submodules/holmes/engine-management.git/docs/index> - Architecture and APIs <../../../submodules/holmes/rule-management.git/docs/index> +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Integration ------------ + * - Document + - Description + * - :ref:`CLI ` + - CLI Documentation -* ONAP Casablanca release content is specified within a list of project - artifact versions available in the form of - a :ref:`manifest`. +DCAE - Data Collection, Analysis and Events +------------------------------------------- -* To install the whole ONAP (from a complete demo solution perspective) - refer to :ref:`Setting Up ONAP `. +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Logging Analytics ------------------ + * - Document + - Description + * - :ref:`DCAE` + - DCAE Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +DMAAP - Data Management as a Platform +------------------------------------- - ../../../submodules/logging-analytics.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 +----------------------------------- -Micro Services Bus ------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`EXTAPI` + - External API Framework Documentation - ../../../submodules/msb/apigateway.git/docs/index - ../../../submodules/msb/swagger-sdk.git/docs/index +HOLMES - Holmes Alarm Correlation and Analysis +---------------------------------------------- -.. Empty folders in this release - ../../../submodules/msb/discovery.git/docs/index - ../../../submodules/msb/java-sdk.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 + * - Document + - Description + * - :ref:`HOLMES` + - HOLMES Architecture and APIs + * - :ref:`Engine Management` + - HOLMES Engine Management Documentation -Modeling --------- +LOGGING - Centralized Logging +----------------------------- -.. 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 + * - (in Maintenance) `LOGGING (Latest) `_ + - ONAP Centralized Logging Documentation -MultiVIM Cloud --------------- +MSB - Microservices Bus +----------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/multicloud/framework.git/docs/index + * - Document + - Description + * - :ref:`MSB` + - Microservices Bus Documentation -Music ------ +MULTICLOUD - MultiCloud Framework +--------------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/music.git/docs/index - ../../../submodules/music/distributed-kv-store.git/docs/index + * - Document + - Description + * - :ref:`MULTICLOUD` + - MultiCloud Framework Architecture and Guides -ONAP Operations Manager ------------------------ +MUSIC - ONAP Multi-Site Integration +----------------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/oom.git/docs/index + * - Document + - Description + * - (in Maintenance) `MUSIC (Frankfurt) `_ + - MUSIC Architecture and Guides + * - (in Maintenance) `MUSIC KV (Latest) `_ + - MUSIC Distribute KV Store Documents -Optimization Framework ----------------------- +OOF - Optimization Framework +---------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. 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 +------------------------------- - ../../../submodules/optf/has.git/docs/index - ../../../submodules/optf/osdf.git/docs/index - ../../../submodules/optf/cmso.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Policy Framework ----------------- + * - Document + - Description + * - :ref:`ORAN` + - O-RAN Support in ONAP (part of CCSDK) -.. toctree:: - :maxdepth: 2 - :titlesonly: +POLICY - Policy Framework +------------------------- - ../../../submodules/policy/engine.git/docs/index - ../../../submodules/policy/apex-pdp.git/docs/index - ../../../submodules/policy/distribution.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Portal Platform ---------------- + * - Document + - Description + * - :ref:`Policy` + - Policy Framework Documentation -.. toctree:: - :maxdepth: 2 - :titlesonly: +PORTAL - Portal Platform +------------------------ - ../../../submodules/portal.git/docs/index +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Service Design & Creation -------------------------- + * - Document + - Description + * - :ref:`Portal` + - ONAP Portal Platform Documentation -.. toctree:: - :maxdepth: 2 - :titlesonly: +SDC - Service Design & Creation +------------------------------- - ../../../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:`SDC` + - Service Design & Creation Documentation -Service Orchestration ---------------------- +SDNC - Software Defined Network Controller +------------------------------------------ -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/so.git/docs/index - ../../../submodules/so/libs.git/docs/index + * - Document + - Description + * - :ref:`SDNC` + - SDNC Architecture, APIs and Guides -Software Defined Network Controller ------------------------------------ +SDNR - Software Defined Network Controller for Radio +---------------------------------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 - ../../../submodules/sdnc/oam.git/docs/index + * - Document + - Description + * - :ref:`SDN-R` + - SDN-R Documentation (part of CCSDK) -.. 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 +SO - Service Orchestration +-------------------------- -Use Case User Interface ------------------------ +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`SO` + - Service Orchestration Architecture, APIs and Guides + * - :ref:`SO Libraries` + - ONAP SO/libs Documentation - ../../../submodules/usecase-ui.git/docs/index +UUI - Use Case User Interface +----------------------------- -User Interface Applications ---------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`UUI` + - Usecase-UI Architecture, APIs and Guides - ../../../submodules/ui/dmaapbc.git/docs/index +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