From eb41a48ecf1b9231bb98459ffb1929c160491aa9 Mon Sep 17 00:00:00 2001 From: Michal Jagiello Date: Fri, 6 May 2022 12:12:11 +0000 Subject: Fix broken links in doc Jenkins verify job is failing due to invalid links on the doc Issue-ID: INT-2108 Signed-off-by: Michal Jagiello Change-Id: I3015eb02533a3c2f9115d82f8d5b9c68f7043a40 --- docs/docs_5G_Configuration_over_NETCONF.rst | 2 +- docs/docs_scaleout.rst | 5 ++--- docs/docs_vFW_CNF_CDS.rst | 22 +++++++++++----------- docs/docs_vfwHPA.rst | 5 +---- docs/docs_vfw_edgex_k8s.rst | 2 +- docs/docs_vipsec.rst | 2 -- 6 files changed, 16 insertions(+), 22 deletions(-) diff --git a/docs/docs_5G_Configuration_over_NETCONF.rst b/docs/docs_5G_Configuration_over_NETCONF.rst index 4b737d04f..d8701a655 100644 --- a/docs/docs_5G_Configuration_over_NETCONF.rst +++ b/docs/docs_5G_Configuration_over_NETCONF.rst @@ -24,7 +24,7 @@ This use case is intended to be applicable for 5G base stations and other nodes How to Use ~~~~~~~~~~ -Set up certificate in SDNC using +Set up certificate in SDNC using As this usecase is extention of PnP PNF flow so run PnP usecase following running this usecase follow link diff --git a/docs/docs_scaleout.rst b/docs/docs_scaleout.rst index 42b0eb59b..7c1c4f3f9 100644 --- a/docs/docs_scaleout.rst +++ b/docs/docs_scaleout.rst @@ -79,9 +79,8 @@ A section like that is required in that override file openStackKeystoneVersion: "KEYSTONE_V3" The values that must be changed according to your lab are all "openStack******" parameters + dcaeCollectorIp + nfsIpAddress -To know how to encrypt the openstack passwords, please look at these guides: -https://docs.onap.org/en/dublin/submodules/oom.git/docs/oom_quickstart_guide.html -https://docs.onap.org/en/elalto/submodules/oom.git/docs/oom_quickstart_guide.html +To know how to encrypt the openstack passwords, please look at the guide here: +https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html Initialize the Customer and Owning entities =========================================== diff --git a/docs/docs_vFW_CNF_CDS.rst b/docs/docs_vFW_CNF_CDS.rst index e6d4249a4..4ac979e35 100644 --- a/docs/docs_vFW_CNF_CDS.rst +++ b/docs/docs_vFW_CNF_CDS.rst @@ -73,9 +73,9 @@ Since Honolulu release vFW CNF use case supports three different scenarios where - Scenario 1: simple deployment of vFW CNF instance - Scenario 2: deployment of vFW CNF instance with enrichment of the Helm deployment with profiling mechanism -- Scenario 3: deployment of vFW CNF instance with Day2 configuration applied and CNF status checked as a part of a config-deploy operation +- Scenario 3: deployment of vFW CNF instance with Day2 configuration applied and CNF status checked as a part of a config-deploy operation -The 3rd scenario presents the most comprehensive way of managing the CNF in ONAP, including Day 0/1/2 operations. It shows also how to combine in the Day2 operation information for the AAI and SDNC MDSAL. All scenarios can be supported by execution of the dedicated Healthcheck workflow `3-5 Verification of the CNF Status`_. +The 3rd scenario presents the most comprehensive way of managing the CNF in ONAP, including Day 0/1/2 operations. It shows also how to combine in the Day2 operation information for the AAI and SDNC MDSAL. All scenarios can be supported by execution of the dedicated Healthcheck workflow `3-5 Verification of the CNF Status`_. Modeling of Onboarding Package/Helm ................................... @@ -1618,7 +1618,7 @@ where and should be replaced with following keyword - cds-blueprints-processor, cds-blueprints-processor - multicloud-k8s, multicloud-k8s -- network-name-gen, network-name-gen, +- network-name-gen, network-name-gen, **Debug log** @@ -1733,7 +1733,7 @@ Examplary output of Status API is shown below (full result of test vFW CNF helm **** -Since Honolulu release vFW CNF Use Case is equipped with dedicated mechanisms for verification of the CNF status automatically, during the instantiation. The process utilizes the k8sPlugin Status and Healthcheck APIs that both are natively exposed in the CDS and can be executed from the script execution functionality in the CDS. +Since Honolulu release vFW CNF Use Case is equipped with dedicated mechanisms for verification of the CNF status automatically, during the instantiation. The process utilizes the k8sPlugin Status and Healthcheck APIs that both are natively exposed in the CDS and can be executed from the script execution functionality in the CDS. .. figure:: files/vFW_CNF_CDS/healthcheck.png :scale: 60 % @@ -1862,11 +1862,11 @@ Future development areas for CNF support: - Upgrade of the vFW CNF similar to Helm Upgrade through the SDC and SO - Use multicloud/k8S API v2 (EMCO) -Some of the features from the list above are covered by the Jakarta roadmap described in `REQ-890`_. +Some of the features from the list above are covered by the Jakarta roadmap described in `REQ-890`_. -.. _ONAP Deployment Guide: https://docs.onap.org/projects/onap-oom/en/guilin/oom_quickstart_guide.html -.. _CDS Documentation: https://docs.onap.org/projects/onap-ccsdk-cds/en/guilin/index.html +.. _ONAP Deployment Guide: https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html +.. _CDS Documentation: https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/ .. _vLB use-case: https://wiki.onap.org/pages/viewpage.action?pageId=71838898 .. _vFW_CNF_CDS Model: https://git.onap.org/demo/tree/heat/vFW_CNF_CDS/templates?h=guilin .. _vFW_CNF_CDS Automation: https://git.onap.org/demo/tree/heat/vFW_CNF_CDS/automation?h=guilin @@ -1874,7 +1874,7 @@ Some of the features from the list above are covered by the Jakarta roadmap desc .. _vFW CBA Model: https://git.onap.org/ccsdk/cds/tree/components/model-catalog/blueprint-model/service-blueprint/vFW?h=elalto .. _vFW_Helm Model: https://git.onap.org/multicloud/k8s/tree/kud/demo/firewall?h=elalto .. _vFW_NextGen: https://git.onap.org/demo/tree/heat/vFW_NextGen?h=elalto -.. _vFW EDGEX K8S: https://docs.onap.org/en/elalto/submodules/integration.git/docs/docs_vfw_edgex_k8s.html +.. _vFW EDGEX K8S: https://docs.onap.org/projects/onap-integration/en/latest/docs_vfw_edgex_k8s.html .. _vFW EDGEX K8S In ONAP Wiki: https://wiki.onap.org/display/DW/Deploying+vFw+and+EdgeXFoundry+Services+on+Kubernets+Cluster+with+ONAP .. _KUD github: https://github.com/onap/multicloud-k8s/tree/honolulu/kud/hosting_providers/baremetal .. _KUD in Wiki: https://wiki.onap.org/display/DW/Kubernetes+Baremetal+deployment+setup+instructions @@ -1890,10 +1890,10 @@ Some of the features from the list above are covered by the Jakarta roadmap desc .. _REQ-458: https://jira.onap.org/browse/REQ-458 .. _REQ-627: https://jira.onap.org/browse/REQ-627 .. _REQ-890: https://jira.onap.org/browse/REQ-890 -.. _Python SDK: https://docs.onap.org/projects/onap-integration/en/guilin/integration-tooling.html?highlight=python-sdk#python-onapsdk +.. _Python SDK: https://docs.onap.org/projects/onap-integration/en/latest/integration-tooling.html#python-onapsdk .. _KUD Jenkins ci/cd verification: https://jenkins.onap.org/job/multicloud-k8s-master-kud-deployment-verify-shell/ -.. _K8s cloud site config: https://docs.onap.org/en/guilin/guides/onap-operator/cloud_site/k8s/index.html -.. _SO Monitoring: https://docs.onap.org/projects/onap-so/en/guilin/developer_info/Working_with_so_monitoring.html +.. _K8s cloud site config: https://docs.onap.org/en/latest/guides/onap-operator/cloud_site/k8s/index.html +.. _SO Monitoring: https://docs.onap.org/projects/onap-so/en/latest/developer_info/Working_with_so_monitoring.html .. _Data Dictionary: https://git.onap.org/demo/tree/heat/vFW_CNF_CDS/templates/cba-dd.json?h=guilin .. _Helm Healer: https://git.onap.org/oom/offline-installer/tree/tools/helm-healer.sh?h=frankfurt .. _infra_workload: https://docs.onap.org/projects/onap-multicloud-framework/en/latest/specs/multicloud_infra_workload.html?highlight=multicloud diff --git a/docs/docs_vfwHPA.rst b/docs/docs_vfwHPA.rst index c37754d55..737b4fd5d 100644 --- a/docs/docs_vfwHPA.rst +++ b/docs/docs_vfwHPA.rst @@ -29,11 +29,8 @@ This tutorial covers enhancements 1 to 5 in Background of https://wiki.onap.org/ Setting Up and Installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Some fixes for HPA support were made subsequent to the release of the Casablanca images. Several updated docker images need to be used to utilize the fixes. The details of the docker images that need to be used and the issues that are fixed are described at this link https://wiki.onap.org/display/DW/Docker+image+updates+for+HPA+vFW+testing -Instructions for updating the manifest of ONAP docker images can be found here: https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/#deploying-an-updated-docker-manifest - -Install OOM ONAP using the deploy script in the integration repo. Instructions for this can be found in this link https://wiki.onap.org/display/DW/OOM+Component. When the installation is complete (all the pods are either in running or completed state) Do the following; +Install OOM ONAP using the deploy script in the integration repo. Instructions for this can be found in this link https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html. When the installation is complete (all the pods are either in running or completed state) Do the following; 1. Check that all the required components were deployed; diff --git a/docs/docs_vfw_edgex_k8s.rst b/docs/docs_vfw_edgex_k8s.rst index 2a8c42372..256d65948 100644 --- a/docs/docs_vfw_edgex_k8s.rst +++ b/docs/docs_vfw_edgex_k8s.rst @@ -274,7 +274,7 @@ the lab where we tested). This will cause multicloud to add the tenant to the k8s cloud region and then, similarly to #10 in the -`vFW HPA casablanca official documentation `_, +`vFW HPA casablanca official documentation `_, the service-subscription can be added to that object. **NOTE:** use same name cloud-region and cloud-owner name diff --git a/docs/docs_vipsec.rst b/docs/docs_vipsec.rst index f50326f60..db9e894ad 100644 --- a/docs/docs_vipsec.rst +++ b/docs/docs_vipsec.rst @@ -24,8 +24,6 @@ The deploy steps look just alike the one for vFW with HPA use case. It is also u Setting Up and Installation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Instructions for updating the manifest of ONAP docker images can be found here: https://onap.readthedocs.io/en/casablanca/submodules/integration.git/docs/#deploying-an-updated-docker-manifest - Install OOM ONAP using the deploy script in the integration repo. Instructions for this can be found in this link https://wiki.onap.org/display/DW/OOM+Component. When the installation is complete (all the pods are either in running or completed state) Do the following; -- cgit 1.2.3-korg