diff options
Diffstat (limited to 'docs/guides')
7 files changed, 43 insertions, 50 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 8ae5aab45..53b075b8f 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -35,9 +35,9 @@ Platform Components DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst> Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst> Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst> + SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/offeredapis.html> SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst> VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst> - NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst> Common Services --------------- @@ -46,13 +46,15 @@ Common Services :maxdepth: 1 :titlesonly: - AAI - Active and Available Inventory Common <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst> - AAI - Active and Available Inventory ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst> - DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst> + AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst> + AAI ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst> + DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst> + ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst> Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst> MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst> - MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst> - Music <../../../submodules/music.git/docs/offeredapis.rst> + Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst> + MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst> + OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst> VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst> SDK diff --git a/docs/guides/onap-developer/architecture/blueprint-enr.rst b/docs/guides/onap-developer/architecture/blueprint-enr.rst index 404f7d0df..a3018a195 100644 --- a/docs/guides/onap-developer/architecture/blueprint-enr.rst +++ b/docs/guides/onap-developer/architecture/blueprint-enr.rst @@ -1,5 +1,5 @@ ONAP Blueprint Enrichment -~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------- The ONAP Beijing release includes four functional enhancements in the areas of manually triggered scaling, change management, and hardware @@ -9,7 +9,7 @@ applicable to any use case; however, to showcase them in a concrete manner, they have been incorporated into VoLTE and vCPE blueprints. Manually Triggered Scaling -^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~ Scale-out and scale-in are two primary benefits of NFV. Scaling can be triggered manually (e.g., by a user or OSS/BSS) or automatically via a @@ -41,7 +41,7 @@ APPC over DMaaP, where APPC picks it up and executes the configuration scale out action on the requested VNF. Change Management -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ NFV will bring with it an era of continuous, incremental changes instead of periodic step-function software upgrades, in addition to a constant @@ -69,7 +69,7 @@ the SDN-C controller in terms of running the pre-check, post-check and upgrade through Ansible playbooks. Hardware Platform Awareness (HPA) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Many VNFs have specific hardware requirements to achieve their performance and security goals. These hardware requirements may range diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index 9bd6d0512..de921a884 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -587,7 +587,7 @@ faster than any one product could on its own. .. |image3| image:: media/ONAP-oom.png :width: 2.28472in :height: 2.30625in -.. |image4| image:: media/ONAP-closedloop.jpeg +.. |image4| image:: media/ONAP-closedloop.png :width: 6in :height: 2.6in .. |image5| image:: media/ONAP-vcpe.png diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 331248c2f..d856ee4a1 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -1,4 +1,5 @@ -.. 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. @@ -33,6 +34,16 @@ Application Controller ../../../submodules/appc/deployment.git/docs/index ../../../submodules/appc.git/docs/index +Command Line Interface +---------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/cli.git/docs/index + + Closed Loop Automation Platform ------------------------------- @@ -119,8 +130,8 @@ Integration * ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`. * To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`. -Logging Enhancements Project ----------------------------- +Logging Analytics +----------------- .. toctree:: :maxdepth: 2 @@ -171,18 +182,8 @@ Music ../../../submodules/music.git/docs/index - -ONAP Command Line Interface ---------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/cli.git/docs/index - -ONAP Operations Manager (experimental) --------------------------------------- +ONAP Operations Manager +----------------------- .. toctree:: :maxdepth: 2 @@ -190,15 +191,6 @@ ONAP Operations Manager (experimental) ../../../submodules/oom.git/docs/index -ONAP Use Case User Interface ----------------------------- - -.. toctree:: - :maxdepth: 2 - :titlesonly: - - ../../../submodules/usecase-ui.git/docs/index - Policy Framework ---------------- @@ -262,6 +254,15 @@ Software Defined Network Controller ../../../submodules/sdnc/parent.git/docs/index ../../../submodules/sdnc/plugins.git/docs/index +Use Case User Interface +----------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/usecase-ui.git/docs/index + User Interface Applications --------------------------- diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index dc7d02bfe..d905a79c8 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -30,7 +30,7 @@ The various installations can be found here: .. toctree:: :maxdepth: 1 :titlesonly: - + onap_oom.rst onap_heat.rst onap_individual.rst diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst index 065dcfd29..a3a1b5bc7 100644 --- a/docs/guides/onap-developer/settingup/onap_individual.rst +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -4,10 +4,6 @@ .. Copyright 2017-2018 ONAP -.. contents:: - :depth: 2 -.. - .. index:: Setting Up ONAP individual components diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst index 28dd6ceba..7cb0d93a8 100644 --- a/docs/guides/onap-developer/settingup/onap_oom.rst +++ b/docs/guides/onap-developer/settingup/onap_oom.rst @@ -3,14 +3,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 ONAP - -.. contents:: - :depth: 2 -.. - .. index:: Setting Up Full ONAP using Containers - ========================================= **Setting Up Full ONAP using Containers** ========================================= @@ -25,21 +19,21 @@ components using containers. You must use the following version for the various sofware components. - =========== ======= + =========== ========= Software Version - =========== ======= + =========== ========= Kubernetes 1.8.10 Helm 2.8.2 kubectl 1.8.10 Docker 17.03.x - =========== ======= + =========== ========= Creation of Kubernetes cluster is described here: .. toctree:: :maxdepth: 1 :titlesonly: - + ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst |