diff options
Diffstat (limited to 'docs/guides')
-rw-r--r-- | docs/guides/onap-developer/apiref/index.rst | 3 | ||||
-rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 3 | ||||
-rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 59 | ||||
-rw-r--r-- | docs/guides/onap-operator/cloud_site/openstack/index.rst | 2 | ||||
-rw-r--r-- | docs/guides/onap-operator/onap_backup_restore.rst | 11 | ||||
-rw-r--r-- | docs/guides/onap-operator/platformoperations.rst | 4 | ||||
-rw-r--r-- | docs/guides/onap-user/design/index.rst | 2 | ||||
-rw-r--r-- | docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst | 9 | ||||
-rw-r--r-- | docs/guides/onap-user/instantiate/instantiation/vid1/index.rst (renamed from docs/guides/onap-user/instantiate/instantiation/vid/index.rst) | 2 | ||||
-rw-r--r-- | docs/guides/onap-user/instantiate/instantiation/vid2/index.rst | 13 | ||||
-rw-r--r-- | docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst | 2 | ||||
-rw-r--r-- | docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst | 2 |
12 files changed, 74 insertions, 38 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 9a8970eca..c251416f4 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -20,7 +20,7 @@ User Interfaces :maxdepth: 1 :titlesonly: -* :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>` +* :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:master_index>` * :ref:`Portal<onap-portal:offeredapis>` * :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>` * :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>` @@ -51,6 +51,7 @@ Common Services * :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>` * :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>` * :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>` +* :ref:`CPS - Configuration Persistence Service<onap-cps:design>` * :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>` * :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>` * :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>` diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index 93b4dc68a..8b22da02f 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -30,7 +30,7 @@ User Interfaces :titlesonly: | :ref:`APPC CDT Application Controller Design Tool<onap-appc:appc_lcm_api_guide>` -| :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:architecture>` +| :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:architecture>` | :ref:`CLI - Command Line Interface<onap-cli:architecture>` | :ref:`PORTAL<onap-portal:architecture>` | :ref:`SDC - Service Design and Creation<onap-sdc:architecture>` @@ -62,6 +62,7 @@ Common Services | :ref:`AAF - Application Authorization Framework<onap-aaf-authz:master_index>` | :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>` | :ref:`AAI ESR<onap-aai-esr-gui:architecture>` +| :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>` | :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>` | :ref:`ExtAPI - External API NBI<onap-externalapi-nbi:architecture>` | :ref:`Logging Framework -<onap-logging-analytics:logging_user_guide>` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index f0136dc5e..99fbb66cd 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -48,8 +48,8 @@ AAF - Application Authorization Framework * - Document - Description - * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_ - - AAF Architecture, APIs and Guides + * - :ref:`AAF (Latest)<onap-aaf-authz:master_index>` + - (unmaintained) AAF Architecture, APIs and Guides AAI - Active and Available Inventory ------------------------------------ @@ -62,11 +62,11 @@ AAI - Active and Available Inventory - Description * - :ref:`AAI<onap-aai-aai-common:master_index>` - AAI Architecture, APIs and Guides - * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_ - - External System Registry GUI Documentation - * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_ - - External System Registry Server Documentation - * - (in Maintenance) :ref:`AAI UI<onap-aai-sparky-be:master_index>` + * - :ref:`ESR GUI (Latest)<onap-aai-esr-gui:master_index>` + - (unmaintained) External System Registry GUI Documentation + * - :ref:`ESR Server (Latest)<onap-aai-esr-server:master_index>` + - (unmaintained) External System Registry Server Documentation + * - :ref:`AAI UI<onap-aai-sparky-be:master_index>` - Sparky - AAI Inventory UI Documentation APPC - Application Controller @@ -78,10 +78,10 @@ APPC - Application Controller * - Document - Description - * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_ - - APPC Architecture, APIs and Guides - * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_ - - APPC Deployment Documentation + * - :ref:`APPC (Frankfurt)<onap-appc:master_index>` + - (unmaintained) APPC Architecture, APIs and Guides + * - :ref:`APPC Deployment (Frankfurt)<onap-appc-deployment:master_index>` + - (unmaintained) APPC Deployment Documentation CCSDK - Common Controller Software Development Kit -------------------------------------------------- @@ -116,7 +116,7 @@ CLAMP - Control Loop Automation Management Platform * - Document - Description - * - :ref:`CLAMP <onap-clamp:master_index>` + * - :ref:`CLAMP <onap-policy-clamp:master_index>` - CLAMP Architecture and Guides CLI - Command Line Interface @@ -131,6 +131,18 @@ CLI - Command Line Interface * - :ref:`CLI <onap-cli:master_index>` - CLI Documentation +CPS - Configuration Persistence Service +--------------------------------------- + +.. list-table:: + :widths: 20 80 + :header-rows: 1 + + * - Document + - Description + * - :ref:`CPS <onap-cps:master_index>` + - CPS Documentation + DCAE - Data Collection, Analysis and Events ------------------------------------------- @@ -143,8 +155,8 @@ DCAE - Data Collection, Analysis and Events * - :ref:`DCAE<onap-dcaegen2:master_index>` - DCAE Architecture and Guides -DMAAP - Data Management as a Platform -------------------------------------- +DMAAP - Data Movement as a Platform +----------------------------------- .. list-table:: :widths: 20 80 @@ -194,8 +206,8 @@ LOGGING - Centralized Logging * - Document - Description - * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_ - - ONAP Centralized Logging Documentation + * - :ref:`LOGGING (Latest)<onap-logging-analytics:master_index>` + - (unmaintained) ONAP Centralized Logging Documentation MSB - Microservices Bus ----------------------- @@ -230,10 +242,10 @@ MUSIC - ONAP Multi-Site Integration * - Document - Description - * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_ - - MUSIC Architecture and Guides - * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_ - - MUSIC Distribute KV Store Documents + * - :ref:`MUSIC (Frankfurt)<onap-music:master_index>` + - (unmaintained) MUSIC Architecture and Guides + * - :ref:`MUSIC KV (Latest)<onap-music-distributed-kv-store:master_index>` + - (unmaintained) MUSIC Distribute KV Store Documents OOF - Optimization Framework ---------------------------- @@ -264,6 +276,9 @@ OOM - ONAP Operations Manager - ONAP Operations Manager Documentation * - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>` - ONAP CMPv2 certification support + * - :ref:`OOM Offline Installer<onap-oom-offline-installer:master_index>` + - OOM Offline Installer + ORAN - Open-RAN Support in ONAP ------------------------------- @@ -298,8 +313,8 @@ PORTAL - Portal Platform * - Document - Description - * - :ref:`Portal<onap-portal:master_index>` - - ONAP Portal Platform Documentation + * - :ref:`Portal (Guilin)<onap-portal:master_index>` + - (unmaintained) ONAP Portal Platform Documentation SDC - Service Design & Creation ------------------------------- diff --git a/docs/guides/onap-operator/cloud_site/openstack/index.rst b/docs/guides/onap-operator/cloud_site/openstack/index.rst index 7d77c188f..0bceedac9 100644 --- a/docs/guides/onap-operator/cloud_site/openstack/index.rst +++ b/docs/guides/onap-operator/cloud_site/openstack/index.rst @@ -161,7 +161,7 @@ to delete the pod: :: - kubectl -n onap delete onap-so-so-bpmn-infra-79fdf6f9d5-t8qr4 + kubectl -n onap delete po onap-so-so-bpmn-infra-79fdf6f9d5-t8qr4 Then, wait for the pod to restart. To check: diff --git a/docs/guides/onap-operator/onap_backup_restore.rst b/docs/guides/onap-operator/onap_backup_restore.rst index bffd16c12..a564d6a1e 100644 --- a/docs/guides/onap-operator/onap_backup_restore.rst +++ b/docs/guides/onap-operator/onap_backup_restore.rst @@ -1,6 +1,6 @@ .. This work is licensed under a Creative Commons Attribution 4.0 .. International License. http://creativecommons.org/licenses/by/4.0 -.. Copyright © 2017-2020 Aarna Networks, Inc. +.. Copyright 2017-2020 Aarna Networks, Inc. .. Links .. Github web page to download the latest version of velero open source tool @@ -11,6 +11,13 @@ Backup and Restore Solution ########################### +.. warning:: + This description is not covering the Backup & Restore procedure of the full + ONAP platform, but gives examples for the usage of Velero. + The ONAP community will focus on Disaster Recovery including B&R + in the coming releases. + + Problem Statement and Requirement (User Story) ============================================== @@ -855,7 +862,7 @@ Disaster recovery Using Schedules and Restore-Only Mode -If you periodically back up your cluster’s resources, you are able to return to a previous state in case of some unexpected mishap, such as a service outage. +If you periodically back up your cluster resources, you are able to return to a previous state in case of some unexpected mishap, such as a service outage. Cluster migration ~~~~~~~~~~~~~~~~~ diff --git a/docs/guides/onap-operator/platformoperations.rst b/docs/guides/onap-operator/platformoperations.rst index 3d4f8a614..cb989c73d 100644 --- a/docs/guides/onap-operator/platformoperations.rst +++ b/docs/guides/onap-operator/platformoperations.rst @@ -83,10 +83,6 @@ To backup and restore ONAP component specific databases you can follow the below onap_backup_restore.rst -.. note:: - Refer to the wiki page for further details: - `Legacy Backup and Restore Solution <https://wiki.onap.org/display/DW/Backup+and+Restore+Solution%3A+ONAP-OOM>`_ - ONAP Multisite Deployment ------------------------- diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst index 186777b0d..b2eb28c5b 100644 --- a/docs/guides/onap-user/design/index.rst +++ b/docs/guides/onap-user/design/index.rst @@ -112,7 +112,7 @@ The following section provide links to the projects: - :ref:`VNF LifeCycle Command templating<onap-appc:master_index>` - :ref:`Workflow Design<onap-sdc:workflow>` - :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>` -- :ref:`Control Loop Automation Management<onap-clamp:master_index>` +- :ref:`Control Loop Automation Management<onap-policy-clamp:master_index>` .. |image1| image:: media/Design-Overview.png diff --git a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst index 9e06c4318..4e8dcab86 100644 --- a/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/service_instance/index.rst @@ -41,8 +41,10 @@ Service Instantiation ONAP will collect and assign all required parameters/values by itself. - .. Note:: **Macro** method is not (yet) available via ONAP VID - nor via extAPI/NBI +.. Note:: + VID supports the "macro" flow orchestration in a ModernUI, which can be enabled by the system operator. + + **Macro** method is not (yet) available via extAPI/NBI. With "A La Carte" method ------------------------ @@ -50,7 +52,7 @@ With "A La Carte" method .. toctree:: :maxdepth: 1 - using ONAP VID Portal <../vid/index.rst> + using ONAP VID Portal <../vid1/index.rst> using ONAP NBI REST API (TM Forum) <../nbi/index.rst> using ONAP SO REST API <../so1/index.rst> @@ -60,4 +62,5 @@ With "Macro" method .. toctree:: :maxdepth: 1 + using ONAP VID Portal <../vid2/index.rst> using ONAP SO REST API <../so2/index.rst> diff --git a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst index 9b367f9cf..4157dd6bd 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vid/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vid1/index.rst @@ -10,4 +10,4 @@ A La Carte mode Service Instantiation via ONAP VID Portal :maxdepth: 1 :titlesonly: -:ref:`vidgit docs instantiaterst<onap-vid:instantiate>` +:ref:`Instantiate Service, VNF, VF modules and Network<onap-vid:instantiate>` diff --git a/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst b/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst new file mode 100644 index 000000000..35006d315 --- /dev/null +++ b/docs/guides/onap-user/instantiate/instantiation/vid2/index.rst @@ -0,0 +1,13 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2019 ONAP Contributors. All rights reserved. + + +Macro mode Service Instantiation via ONAP VID Portal +========================================================= + +.. toctree:: + :maxdepth: 1 + :titlesonly: + +:ref:`Instantiate Service, “Macro” mode (PNF example)<onap-vid:instantiatemacro>` diff --git a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst index 0fb9f1147..e12932a5d 100644 --- a/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/virtual_link_instance/index.rst @@ -44,7 +44,7 @@ With "A La Carte" method .. toctree:: :maxdepth: 1 - using ONAP VID Portal <../vid/index.rst> + using ONAP VID Portal <../vid1/index.rst> using ONAP SO REST API <../so1/index.rst> With "Macro" method diff --git a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst index a020f9aeb..ccf036c2f 100644 --- a/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst +++ b/docs/guides/onap-user/instantiate/instantiation/vnf_instance/index.rst @@ -53,7 +53,7 @@ With "A La Carte" method .. toctree:: :maxdepth: 1 - using ONAP VID Portal <../vid/index.rst> + using ONAP VID Portal <../vid1/index.rst> using ONAP SO REST API <../so1/index.rst> With "Macro" method |