diff options
Diffstat (limited to 'docs/guides/onap-developer')
| -rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 565 | ||||
| -rw-r--r-- | docs/guides/onap-developer/index.rst | 1 | ||||
| -rw-r--r-- | docs/guides/onap-developer/tutorials/index.rst | 13 |
3 files changed, 340 insertions, 239 deletions
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 0e14800f7..14c9a85f8 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -9,303 +9,416 @@ 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<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 ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - -| :ref:`appc deployment<onap-appc-deployment:master_index>` -| :ref:`appc<onap-appc:master_index>` - -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: - -: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 ------------------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: +Here you will find the detailed documentation of projects, +ONAP components and functionalities -| :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>` -| :ref:`ccsdk oran<onap-ccsdk-oran:master_index>` +Project - ONAP Integration +-------------------------- -Data Collection, Analysis, and Events -------------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`Integration<onap-integration:master_index>` + - ONAP Integration Project Documentation -:ref:`dcaegen2<onap-dcaegen2:master_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-modeling-modelspec:master_index>` + - ONAP Model Specification + * - :ref:`ETSI Catalog<onap-modeling-etsicatalog:master_index>` + - ONAP ETSI Runtime Catalog Documentation -| :ref:`dmaap dbcapi<onap-dmaap-dbcapi:master_index>` -| :ref:`dmaap buscontroller<onap-dmaap-buscontroller:master_index>` -Data Management as a Platform Data Router +AAF - Application Authorization Framework ----------------------------------------- -.. toctree:: - :maxdepth: 1 - :titlesonly: - -:ref:`dmaap datarouter<onap-dmaap-datarouter:master_index>` - -Data Management as a Platform Message Router --------------------------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - -:ref:`dmaap messagerouter messageservice<onap-dmaap-messagerouter-messageservice:master_index>` - -External API Framework ----------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - -:ref:`externalapi nbi<onap-externalapi-nbi:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`AAF<onap-aaf-authz:master_index>` + - AAF Architecture, APIs and Guides + * - :ref:`Secret Management Service<onap-aaf-sms:master_index>` + - Secret Management Service Architecture and API + +AAI - Active and Available Inventory +------------------------------------ + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`AAI<onap-aai-aai-common:master_index>` + - AAI Architecture, APIs and Guides + * - :ref:`ESR<onap-aai-esr-gui:master_index>` + - External System Registry GUI Documentation (to be removed ?) + * - :ref:`ESR<onap-aai-esr-server:master_index>` + - External System Registry Server Documentation (to be removed ?) + * - :ref:`AAI Inventory UI<onap-aai-sparky-be:master_index>` + - Sparky - AAI Inventory UI Documentation (to be removed ?) + * - :ref:`AAI Event Client<onap-aai-event-client:master_index>` + - AAI Event Client Documentation (to be removed ?) + +APPC - Application Controller +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`APPC<onap-appc:master_index>` + - APPC Architecture, APIs and Guides + * - :ref:`APPC Deployment<onap-appc-deployment:master_index>` + - APPC Deployment Documentation + +CCSDK - Common Controller Software Development Kit +-------------------------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`Distribution<onap-ccsdk-distribution:master_index>` + - TOSCA Orchestration Plugin, Directed Graph Support + * - :ref:`Dashboard<onap-ccsdk-dashboard:master_index>` + - Common Controller Dashboard (To be removed ?) + * - :ref:`Platform Plugins<onap-ccsdk-platform-plugins:master_index>` + - Platform Plugins (To be removed ?) + * - :ref:`APPS<onap-ccsdk-apps:master_index>` + - Apps optside ODL (To be removed ?) + +CDS - Controller Design Studio +------------------------------ +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Holmes ------- + * - Document + - Description + * - :ref:`CDS<onap-ccsdk-cds:master_index>` + - Controller Design Studio Architecture and Guides (part of CCSDK) -.. toctree:: - :maxdepth: 2 - :titlesonly: +CLAMP - Control Loop Automation Management Platform +--------------------------------------------------- -| :ref:`Alarm Correlation and Analysis<onap-holmes-engine-management:master_index>` -| :ref:`Architecture and APIs<onap-holmes-rule-management:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Integration ------------ + * - Document + - Description + * - :ref:`CLAMP <onap-clamp:master_index>` + - CLAMP Architecture and Guides -.. toctree:: - :maxdepth: 1 - :titlesonly: +CLI - Command Line Interface +---------------------------- -:ref:`integration<onap-integration:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Logging Analytics ------------------ + * - Document + - Description + * - :ref:`CLI <onap-cli:master_index>` + - CLI Documentation -.. toctree:: - :maxdepth: 2 - :titlesonly: +DCAE - Data Collection, Analysis and Events +------------------------------------------- -:ref:`logging-analytics<onap-logging-analytics:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Micro Services Bus ------------------- + * - Document + - Description + * - :ref:`DCAE<onap-dcaegen2:master_index>` + - DCAE Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +DMAAP - Data Management as a Platform +------------------------------------- -:ref:`msb apigateway<onap-msb-apigateway:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`Bus Controller<onap-dmaap-buscontroller:master_index>` + - Bus Controller Documentation + * - :ref:`Bus Controller API<onap-dmaap-dbcapi:master_index>` + - Bus Controller API Documentation + * - :ref:`Data Router<onap-dmaap-datarouter:master_index>` + - Data Router Documentation + * - :ref:`Message Router<onap-dmaap-messagerouter-messageservice:master_index>` + - Message Router Documentation + +EXTAPI - External API Framework/NBI +----------------------------------- -:ref:`msb swagger-sdk<onap-msb-swagger-sdk:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 + * - Document + - Description + * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>` + - External API Framework Documentation -Modeling --------- +HOLMES - Holmes Alarm Correlation and Analysis +---------------------------------------------- -.. toctree:: - :maxdepth: 2 - :titlesonly: +.. list-table:: + :widths: 20 80 + :header-rows: 1 -:ref:`modeling modelspec<onap-modeling-modelspec:master_index>` + * - Document + - Description + * - :ref:`HOLMES<onap-holmes-rule-management:master_index>` + - HOLMES Architecture and APIs + * - :ref:`Engine Management<onap-holmes-engine-management:master_index>` + - HOLMES Engine Management Documentation -:ref:`modeling etsicatalog<onap-modeling-etsicatalog:master_index>` +LOGGING - Centralized Logging +----------------------------- -MultiVIM Cloud --------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`Logging<onap-logging-analytics:master_index>` + - ONAP Centralized Logging Documentation (to be deleted ?) -:ref:`multicloud framework<onap-multicloud-framework:master_index>` +MSB - Microservices Bus +----------------------- -Music ------ +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`MSB<onap-msb-apigateway:master_index>` + - Microservices Bus Documentation -:ref:`music<onap-music:master_index>` +MULTICLOUD - MultiCloud Framework +--------------------------------- -:ref:`music distributed-kv-store<onap-music-distributed-kv-store:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -ONAP Operations Manager ------------------------ + * - Document + - Description + * - :ref:`MULTICLOUD<onap-multicloud-framework:master_index>` + - MultiCloud Framework Architecture and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +MUSIC - ONAP Multi-Site Integration +----------------------------------- -| :ref:`oom<onap-oom:master_index>` -| :ref:`CMPv2 CertService<onap-oom-certservice:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Optimization Framework ----------------------- + * - Document + - Description + * - :ref:`MUSIC<onap-music:master_index>` + - MUSIC Architecture and Guides (To be deleted ?) + * - :ref:`Distributed KV Store<onap-music:master_index>` + - MUSIC Distribute KV Store Documents (To be deleted ?) -.. toctree:: - :maxdepth: 2 - :titlesonly: +OOF - Optimization Framework +---------------------------- -| :ref:`optf has<onap-optf-has:master_index>` -| :ref:`optf osdf<onap-optf-osdf:master_index>` -| :ref:`optf cmso<onap-optf-cmso:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`Homing and Allocation<onap-optf-has:master_index>` + - ONAP policy-driven placement optimizing service documentation + * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>` + - Optimization Service Design Framework documentation + * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>` + - Change Management Schedule Optimization documentation + +OOM - ONAP Operations Manager +----------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`OOM<onap-oom:master_index>` + - ONAP Operations Manager Documentation + * - :ref:`OOM Certification Service<onap-oom-certservice:master_index>` + - ONAP CMPv2 certification support + +ORAN - Open-RAN Support in ONAP +------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`ORAN<onap-ccsdk-oran:master_index>` + - O-RAN Support in ONAP (part of CCSDK) + +POLICY - Policy Framework +------------------------- -Policy Framework ----------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`Policy<onap-policy-parent:master_index>` + - Policy Framework Documentation -:ref:`policy parent<onap-policy-parent:master_index>` +PORTAL - Portal Platform +------------------------ -Portal Platform ---------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`Portal<onap-portal:master_index>` + - ONAP Portal Platform Documentation -:ref:`portal<onap-portal:master_index>` +SDC - Service Design & Creation +------------------------------- -Service Design & Creation -------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`SDC<onap-sdc:master_index>` + - Service Design & Creation Documentation -:ref:`sdc<onap-sdc:master_index>` +SDNC - Software Defined Network Controller +------------------------------------------ -Service Orchestration ---------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -.. toctree:: - :maxdepth: 2 - :titlesonly: + * - Document + - Description + * - :ref:`SDCN<onap-sdnc-oam:master_index>` + - SDNC Architecture, APIs and Guides -:ref:`so<onap-so:master_index>` +SDNR - Software Defined Network Controller for Radio +---------------------------------------------------- -:ref:`so libs<onap-so-libs:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Software Defined Network Controller ------------------------------------ + * - Document + - Description + * - :ref:`SDNR<onap-ccsdk-features:master_index>` + - SDN-R Documentation (part of CCSDK) -.. toctree:: - :maxdepth: 2 - :titlesonly: +SO - Service Orchestration +-------------------------- -:ref:`sdnc oam<onap-sdnc-oam:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Software Defined Network Controller for Radio (SDN-R) ------------------------------------------------------ + * - Document + - Description + * - :ref:`SO<onap-so:master_index>` + - Service Orchestration Architecture, APIs and Guides + * - :ref:`SO Libraries<onap-so-libs:master_index>` + - Service Orchestration Build (To be deleted ?) -.. toctree:: - :maxdepth: 2 - :titlesonly: +UUI - Use Case User Interface +----------------------------- -:ref:`ccsdk features<onap-ccsdk-features:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Use Case User Interface ------------------------ + * - Document + - Description + * - :ref:`UUI<onap-usecase-ui:master_index>` + - Usecase-UI Architecture, APIs and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +VFC - Virtual Function Controller +--------------------------------- -:ref:`usecase-ui<onap-usecase-ui:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Virtual Function Controller ---------------------------- + * - Document + - Description + * - :ref:`VF-C<onap-vfc-nfvo-lcm:master_index>` + - Virtual Function Controller Architecture, APIs and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +VID - Virtual Infrastructure Deployment +--------------------------------------- -:ref:`vfc nfvo lcm<onap-vfc-nfvo-lcm:master_index>` +.. list-table:: + :widths: 20 80 + :header-rows: 1 -Virtual Infrastructure Deployment ---------------------------------- + * - Document + - Description + * - :ref:`VID<onap-vid:master_index>` + - Virtual Infrastructure Deployment Architecture, APIs and Guides -.. toctree:: - :maxdepth: 2 - :titlesonly: +VNFSDK - VNF Software Development Kit +------------------------------------- +.. list-table:: + :widths: 20 80 + :header-rows: 1 -:ref:`vid<onap-vid:master_index>` + * - Document + - Description + * - :ref:`VnfSDK<onap-vnfsdk-model:master_index>` + - 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 -:ref:`vnfsdk model<onap-vnfsdk-model:master_index>` + * - Document + - Description + * - :ref:`VVP<onap-vvp-documentation:master_index>` + - VNF Validation Platform Documentation diff --git a/docs/guides/onap-developer/index.rst b/docs/guides/onap-developer/index.rst index 221f7ca0d..0d2418ba5 100644 --- a/docs/guides/onap-developer/index.rst +++ b/docs/guides/onap-developer/index.rst @@ -12,7 +12,6 @@ understand or contribute to the ONAP open source. .. toctree:: :maxdepth: 1 - tutorials/index how-to-use-docs/index apiref/index diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst index 1d090fabe..a181644bc 100644 --- a/docs/guides/onap-developer/tutorials/index.rst +++ b/docs/guides/onap-developer/tutorials/index.rst @@ -5,17 +5,6 @@ Tutorials ========= .. note:: - Until this section is migrated to gerrit/readthedocs, use the links below. + This is an empty document as placeholder for future tutorials. -.. caution:: - The tutorials may refer to earlier versions of software - and have not been certified on the latest Casablanca Release. - -* `Automatically Creating a Netconf Mount in APPC from SDNC <https://wiki.onap.org/x/JYUx>`_ - -* `Clearwater vIMS Onboarding and Instantiation <https://wiki.onap.org/x/RJp9>`_ - -* `How to use SLI-API for SDNC Model, Directed Graph and Adapter prototyping <https://wiki.onap.org/x/0wCW>`_ - -* `Setting up a Nexus Proxy <https://wiki.onap.org/x/_y70>`_ |