From e3e3fc516361f83a35ca26282d5fe83364e92d4b Mon Sep 17 00:00:00 2001 From: Ayumu Ueha Date: Fri, 27 Jan 2023 13:09:44 +0000 Subject: [PATCH] Deprecate Legacy APIs excluding VIM feature This patch deprecates the Legacy APIs excluding VIM feature. * Emit a warning log when a Deprecated API is executed. * Add warning block to api-refs and docs related with deprecated Legacy feature. Implements: blueprint deprecate-legacy-apis Change-Id: Ie378d1000089401e3a0854b209654182da09e272 --- api-ref/source/v1/legacy.rst | 5 +++++ doc/source/admin/index.rst | 5 +++++ doc/source/cli/cli-legacy-event.rst | 5 +++++ doc/source/cli/cli-legacy-fc.rst | 5 +++++ doc/source/cli/cli-legacy-nfp.rst | 5 +++++ doc/source/cli/cli-legacy-nsd.rst | 5 +++++ doc/source/cli/cli-legacy-sfc.rst | 5 +++++ doc/source/cli/cli-legacy-vnf.rst | 5 +++++ doc/source/cli/cli-legacy-vnfd.rst | 5 +++++ doc/source/cli/cli-legacy-vnffg.rst | 5 +++++ doc/source/cli/cli-legacy-vnffgd.rst | 5 +++++ doc/source/cli/index.rst | 5 +++++ doc/source/contributor/event_logging.rst | 5 +++++ doc/source/contributor/monitor-api.rst | 5 +++++ .../contributor/policy_actions_framework.rst | 5 +++++ .../contributor/vnfd_template_description.rst | 6 ++++++ .../vnfd_template_parameterization.rst | 5 +++++ .../contributor/vnffgd_template_description.rst | 5 +++++ doc/source/contributor/zabbix-plugin.rst | 5 +++++ doc/source/install/legacy_getting_started.rst | 5 +++++ .../reference/block_storage_usage_guide.rst | 5 +++++ doc/source/reference/maintenance_usage_guide.rst | 5 +++++ .../reference/mistral_workflows_usage_guide.rst | 5 +++++ .../reference/reservation_policy_usage_guide.rst | 5 +++++ doc/source/user/alarm_monitoring_usage_guide.rst | 5 +++++ .../user/containerized_vnf_usage_guide.rst | 5 +++++ doc/source/user/dynamic_vnffg_usage_guide.rst | 5 +++++ .../enhanced_placement_awareness_usage_guide.rst | 5 +++++ doc/source/user/index.rst | 5 +++++ doc/source/user/introduction.rst | 5 +++++ doc/source/user/legacy_use_case_guide.rst | 4 ++++ doc/source/user/multisite_vim_usage_guide.rst | 5 +++++ doc/source/user/nsd_usage_guide.rst | 5 +++++ doc/source/user/placement_policy_usage_guide.rst | 5 +++++ doc/source/user/resources.rst | 5 +++++ doc/source/user/scale_usage_guide.rst | 5 +++++ doc/source/user/vnf_component_usage_guide.rst | 5 +++++ doc/source/user/vnffg_usage_guide.rst | 5 +++++ doc/source/user/vnffg_usage_guide_advanced.rst | 5 +++++ doc/source/user/vnfm_usage_guide.rst | 5 +++++ ...gacy-apis-excluding-vim-e7d1292ce1070839.yaml | 6 ++++++ tacker/wsgi.py | 16 ++++++++++++++++ 42 files changed, 222 insertions(+) create mode 100644 releasenotes/notes/deprecate-legacy-apis-excluding-vim-e7d1292ce1070839.yaml diff --git a/api-ref/source/v1/legacy.rst b/api-ref/source/v1/legacy.rst index ba0c41f2e..497f356c6 100644 --- a/api-ref/source/v1/legacy.rst +++ b/api-ref/source/v1/legacy.rst @@ -4,6 +4,11 @@ Legacy Tacker API ################# +.. warning:: + Legacy APIs excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. rest_expand_all:: .. include:: versions.inc diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 7746336b2..9e7a09492 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -24,6 +24,11 @@ The following list covers the commands for Tacker services available in These commands can be referenced by doing **openstack help** and the detail of individual command can be referred by **openstack help **. +.. warning:: + Legacy commands excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. code-block:: console openstack vnf create Create a VNF. diff --git a/doc/source/cli/cli-legacy-event.rst b/doc/source/cli/cli-legacy-event.rst index 2f3dc6dd6..58ae5248d 100644 --- a/doc/source/cli/cli-legacy-event.rst +++ b/doc/source/cli/cli-legacy-event.rst @@ -2,6 +2,11 @@ Event Management ================ +.. warning:: + Event Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This document describes how to manage Event with CLI in Tacker. Prerequisites diff --git a/doc/source/cli/cli-legacy-fc.rst b/doc/source/cli/cli-legacy-fc.rst index fb8b52029..1fd39f532 100644 --- a/doc/source/cli/cli-legacy-fc.rst +++ b/doc/source/cli/cli-legacy-fc.rst @@ -2,6 +2,11 @@ Flow Classifier Management ========================== +.. warning:: + Flow Classifier Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Flow Classifier (FC) is a part of Network Forwarding Path (NFP) in VNF Forwarding Graph (VNFFG). diff --git a/doc/source/cli/cli-legacy-nfp.rst b/doc/source/cli/cli-legacy-nfp.rst index cd4357378..f6c83308e 100644 --- a/doc/source/cli/cli-legacy-nfp.rst +++ b/doc/source/cli/cli-legacy-nfp.rst @@ -2,6 +2,11 @@ Network Forwarding Path Management ================================== +.. warning:: + Network Forwarding Path Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Network Forwarding Path (NFP) is composed of a Service Function Chain (SFC) and a Flow Classifier (FC) in VNF Forwarding Graph (VNFFG). diff --git a/doc/source/cli/cli-legacy-nsd.rst b/doc/source/cli/cli-legacy-nsd.rst index f1079cbdd..7bcf4b341 100644 --- a/doc/source/cli/cli-legacy-nsd.rst +++ b/doc/source/cli/cli-legacy-nsd.rst @@ -2,6 +2,11 @@ Network Service Descriptor Management ===================================== +.. warning:: + Network Service Descriptor Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + To enable dynamic composition of network services, NFV introduces Network Service Descriptors (NSDs) that specify the network service to be created. diff --git a/doc/source/cli/cli-legacy-sfc.rst b/doc/source/cli/cli-legacy-sfc.rst index 2645a0c19..c75549703 100644 --- a/doc/source/cli/cli-legacy-sfc.rst +++ b/doc/source/cli/cli-legacy-sfc.rst @@ -2,6 +2,11 @@ Service Function Chain (SFC) Management ======================================= +.. warning:: + Service Function Chain (SFC) Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Prerequisites ------------- diff --git a/doc/source/cli/cli-legacy-vnf.rst b/doc/source/cli/cli-legacy-vnf.rst index a3f7d2b5f..0668c6612 100644 --- a/doc/source/cli/cli-legacy-vnf.rst +++ b/doc/source/cli/cli-legacy-vnf.rst @@ -2,6 +2,11 @@ VNF Management ============== +.. warning:: + VNF Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. TODO(yoshito-ito): add the other patterns of update. This document describes how to manage VNF with CLI in Tacker. diff --git a/doc/source/cli/cli-legacy-vnfd.rst b/doc/source/cli/cli-legacy-vnfd.rst index 2b97589d3..8d09a3bcc 100644 --- a/doc/source/cli/cli-legacy-vnfd.rst +++ b/doc/source/cli/cli-legacy-vnfd.rst @@ -2,6 +2,11 @@ VNF Descriptor (VNFD) Management ================================ +.. warning:: + VNF Descriptor (VNFD) Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + The behavioural and deployment information of a VNF in Tacker is defined in a template known as VNF Descriptor (VNFD). The template is based on TOSCA standards and is written in YAML. diff --git a/doc/source/cli/cli-legacy-vnffg.rst b/doc/source/cli/cli-legacy-vnffg.rst index 5ac5e11d5..e88c9ab50 100644 --- a/doc/source/cli/cli-legacy-vnffg.rst +++ b/doc/source/cli/cli-legacy-vnffg.rst @@ -2,6 +2,11 @@ VNF Forwarding Graph (VNFFG) Management ======================================= +.. warning:: + VNF Forwarding Graph (VNFFG) Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. TODO(yoshito-ito): Update "Update VNFFG" operation after fixing the bug: * https://bugs.launchpad.net/python-tackerclient/+bug/1892152 diff --git a/doc/source/cli/cli-legacy-vnffgd.rst b/doc/source/cli/cli-legacy-vnffgd.rst index 4ab331df9..c724c904e 100644 --- a/doc/source/cli/cli-legacy-vnffgd.rst +++ b/doc/source/cli/cli-legacy-vnffgd.rst @@ -2,6 +2,11 @@ VNF Forwarding Graph Descriptor (VNFFGD) Management =================================================== +.. warning:: + VNF Forwarding Graph Descriptor (VNFFGD) Management commands are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + VNF Forwarding Graph (VNFFG) feature in Tacker is used to orchestrate and manage traffic through VNFs. In short, abstract VNFFG TOSCA definitions are rendered into Service Function Chains (SFCs) and Classifiers. The SFC makes up diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index b6ad79b64..5e05d3232 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -31,6 +31,11 @@ Operations for ETSI NFV-SOL implementation Operations for Legacy implementation ------------------------------------ +.. warning:: + Legacy CLI excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. toctree:: cli-legacy-vim diff --git a/doc/source/contributor/event_logging.rst b/doc/source/contributor/event_logging.rst index 41e18d756..e186b7419 100644 --- a/doc/source/contributor/event_logging.rst +++ b/doc/source/contributor/event_logging.rst @@ -7,6 +7,11 @@ Tacker Resource Events Usage Guide ================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Overview -------- diff --git a/doc/source/contributor/monitor-api.rst b/doc/source/contributor/monitor-api.rst index cf28827b5..6594d5cf0 100644 --- a/doc/source/contributor/monitor-api.rst +++ b/doc/source/contributor/monitor-api.rst @@ -1,6 +1,11 @@ Tacker Monitoring Framework ============================ +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This section will introduce tacker monitoring framework and describes the various actions that a user can take when a specific event occurs. diff --git a/doc/source/contributor/policy_actions_framework.rst b/doc/source/contributor/policy_actions_framework.rst index 55db5d04c..b7cf05d2c 100644 --- a/doc/source/contributor/policy_actions_framework.rst +++ b/doc/source/contributor/policy_actions_framework.rst @@ -1,6 +1,11 @@ Tacker Policy Framework ======================= +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This section will introduce framework for tacker policy actions. * Introduction diff --git a/doc/source/contributor/vnfd_template_description.rst b/doc/source/contributor/vnfd_template_description.rst index fd90579c0..6a426dd56 100644 --- a/doc/source/contributor/vnfd_template_description.rst +++ b/doc/source/contributor/vnfd_template_description.rst @@ -1,5 +1,11 @@ VNF Descriptor (VNFD) Template Guide ==================================== + +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Overview -------- diff --git a/doc/source/contributor/vnfd_template_parameterization.rst b/doc/source/contributor/vnfd_template_parameterization.rst index eae30e815..a271f908f 100644 --- a/doc/source/contributor/vnfd_template_parameterization.rst +++ b/doc/source/contributor/vnfd_template_parameterization.rst @@ -1,6 +1,11 @@ VNF Descriptor (VNFD) Template Parameterization =============================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Overview -------- diff --git a/doc/source/contributor/vnffgd_template_description.rst b/doc/source/contributor/vnffgd_template_description.rst index 7c948c9d6..2797b10e8 100644 --- a/doc/source/contributor/vnffgd_template_description.rst +++ b/doc/source/contributor/vnffgd_template_description.rst @@ -3,6 +3,11 @@ VNF Forwarding Graph Descriptor (VNFFGD) Template Guide Overview -------- +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This document explains VNFFGD template structure and its various fields based on TOSCA standards V1.0 [#f1]_. diff --git a/doc/source/contributor/zabbix-plugin.rst b/doc/source/contributor/zabbix-plugin.rst index cbf53d4f5..c04af6133 100644 --- a/doc/source/contributor/zabbix-plugin.rst +++ b/doc/source/contributor/zabbix-plugin.rst @@ -18,6 +18,11 @@ How to use Zabbix Plugin ======================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This document explains how Tacker VNFM's Zabbix-plugin works with Zabbix monitoring tool to provide application monitoring for VNF. diff --git a/doc/source/install/legacy_getting_started.rst b/doc/source/install/legacy_getting_started.rst index f7a7ebdf9..9e769d6e3 100644 --- a/doc/source/install/legacy_getting_started.rst +++ b/doc/source/install/legacy_getting_started.rst @@ -18,6 +18,11 @@ Getting Started with Legacy Tacker ================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Once Tacker is installed successfully, follow the steps given below to get started with Tacker and validate the installation. diff --git a/doc/source/reference/block_storage_usage_guide.rst b/doc/source/reference/block_storage_usage_guide.rst index 4177142d5..3cb454d2b 100644 --- a/doc/source/reference/block_storage_usage_guide.rst +++ b/doc/source/reference/block_storage_usage_guide.rst @@ -17,6 +17,11 @@ Orchestrating VNFs with attached Volumes ========================================= +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + To support persistent volumes to VNF, the TOSCA NFV profile supports a new type of nodes. Tacker has now the feature of parsing of those new nodes and creation of cinder volumes which are attached to the VDUs. diff --git a/doc/source/reference/maintenance_usage_guide.rst b/doc/source/reference/maintenance_usage_guide.rst index afdc21396..bf0b2fc08 100644 --- a/doc/source/reference/maintenance_usage_guide.rst +++ b/doc/source/reference/maintenance_usage_guide.rst @@ -17,6 +17,11 @@ VNF zero impact host maintenance ================================ +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Tacker allows you to maintenance host with VNF zero impact. Maintenance workflows will be performed in the ``Fenix`` service by creating a session which can do scaling, migrating VNFs and patch hosts. diff --git a/doc/source/reference/mistral_workflows_usage_guide.rst b/doc/source/reference/mistral_workflows_usage_guide.rst index 6e86093f5..030f728b7 100644 --- a/doc/source/reference/mistral_workflows_usage_guide.rst +++ b/doc/source/reference/mistral_workflows_usage_guide.rst @@ -17,6 +17,11 @@ Mistral workflows for Tacker ============================ +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + OpenStack Mistral already integrated with Tacker. The Tenant User or Operator can make use of tacker actions to create custom Mistral Workflows. This document describes the usage of OpenStackClient CLI to validate, create diff --git a/doc/source/reference/reservation_policy_usage_guide.rst b/doc/source/reference/reservation_policy_usage_guide.rst index f946e07ad..5352071b5 100644 --- a/doc/source/reference/reservation_policy_usage_guide.rst +++ b/doc/source/reference/reservation_policy_usage_guide.rst @@ -17,6 +17,11 @@ VNF scaling with reserved resources =================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Tacker allows you to configure reserved compute resources in reservation policy. The compute resources should be first reserved in the OpenStack ``Blazar`` service by creating leases which can then be configured in the diff --git a/doc/source/user/alarm_monitoring_usage_guide.rst b/doc/source/user/alarm_monitoring_usage_guide.rst index cdd95f60a..14335dca2 100644 --- a/doc/source/user/alarm_monitoring_usage_guide.rst +++ b/doc/source/user/alarm_monitoring_usage_guide.rst @@ -17,6 +17,11 @@ Alarm monitoring framework ========================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This document describes how to use alarm-based monitoring driver in Tacker. Sample TOSCA with monitoring policy diff --git a/doc/source/user/containerized_vnf_usage_guide.rst b/doc/source/user/containerized_vnf_usage_guide.rst index 954197dc8..f06a23c88 100644 --- a/doc/source/user/containerized_vnf_usage_guide.rst +++ b/doc/source/user/containerized_vnf_usage_guide.rst @@ -2,6 +2,11 @@ Experimenting containerized VNFs with Kubernetes VIM ==================================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + In the past, Tacker only supports creating virtual machine based VNF using Heat. This section covers how to deploy `containerized VNF` using Kubernetes VIM in Tacker. diff --git a/doc/source/user/dynamic_vnffg_usage_guide.rst b/doc/source/user/dynamic_vnffg_usage_guide.rst index b633db5e5..9267daa1e 100644 --- a/doc/source/user/dynamic_vnffg_usage_guide.rst +++ b/doc/source/user/dynamic_vnffg_usage_guide.rst @@ -16,6 +16,11 @@ A Use Case of VNFFG Update ========================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. TODO(h-asahina): check this use case still works. This guide walks you through a specific usecase in which you can leverage diff --git a/doc/source/user/enhanced_placement_awareness_usage_guide.rst b/doc/source/user/enhanced_placement_awareness_usage_guide.rst index 3f99ad38d..793277fd5 100644 --- a/doc/source/user/enhanced_placement_awareness_usage_guide.rst +++ b/doc/source/user/enhanced_placement_awareness_usage_guide.rst @@ -7,6 +7,11 @@ Enhanced Placement Awareness Usage Guide ======================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Overview -------- diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 7be6b94e3..3f7d86b03 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -45,6 +45,11 @@ Overview Use Case Guide -------------- +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + .. toctree:: :maxdepth: 1 diff --git a/doc/source/user/introduction.rst b/doc/source/user/introduction.rst index fb58fd56b..8998938e6 100644 --- a/doc/source/user/introduction.rst +++ b/doc/source/user/introduction.rst @@ -12,6 +12,11 @@ Now Tacker has two different architectures: * ETSI NFV-SOL based implementation * Legacy implementation +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + When Tacker project was originated to follow the ETSI NFV MANO standards in Liberty release, the standarding for "NFV Solutions (SOL)", which is the specifications for protocols and data models, was not yet defined. After the diff --git a/doc/source/user/legacy_use_case_guide.rst b/doc/source/user/legacy_use_case_guide.rst index 081bbac6a..0ba73a93e 100644 --- a/doc/source/user/legacy_use_case_guide.rst +++ b/doc/source/user/legacy_use_case_guide.rst @@ -2,6 +2,10 @@ Legacy Tacker Use Cases ======================= +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). VIM --- diff --git a/doc/source/user/multisite_vim_usage_guide.rst b/doc/source/user/multisite_vim_usage_guide.rst index a34977b72..6ac94c00d 100644 --- a/doc/source/user/multisite_vim_usage_guide.rst +++ b/doc/source/user/multisite_vim_usage_guide.rst @@ -17,6 +17,11 @@ Multisite VIM Usage =================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + A single Tacker controller node can be used to manage multiple OpenStack sites without having the need to deploy Tacker server on each of these sites. Tacker allows users to deploy VNFs in multiple OpenStack sites using the multisite VIM diff --git a/doc/source/user/nsd_usage_guide.rst b/doc/source/user/nsd_usage_guide.rst index 50ca9c820..b096e4b84 100644 --- a/doc/source/user/nsd_usage_guide.rst +++ b/doc/source/user/nsd_usage_guide.rst @@ -15,6 +15,11 @@ Orchestrating VNFs and VNFFG using Network Services Descriptor (NSD) ==================================================================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + To enable dynamic composition of network services, NFV introduces Network Service Descriptors (NSDs) that specify the network service to be created. In Network Function Virtualization (NFV), Network Service (NS) is a set of diff --git a/doc/source/user/placement_policy_usage_guide.rst b/doc/source/user/placement_policy_usage_guide.rst index fca5f6104..d531ee503 100644 --- a/doc/source/user/placement_policy_usage_guide.rst +++ b/doc/source/user/placement_policy_usage_guide.rst @@ -17,6 +17,11 @@ VDU Placement policy ==================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + OpenStack nova server groups can be used to control the affinity and anti-affinity scheduling policy for a group of VDU's. Below placement policies are supported:: diff --git a/doc/source/user/resources.rst b/doc/source/user/resources.rst index 56ab0a16e..8eab8256d 100644 --- a/doc/source/user/resources.rst +++ b/doc/source/user/resources.rst @@ -54,6 +54,11 @@ UserData Legacy Tacker Resources ----------------------- +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + NFVO ^^^^ diff --git a/doc/source/user/scale_usage_guide.rst b/doc/source/user/scale_usage_guide.rst index 065536c18..682c8fdda 100644 --- a/doc/source/user/scale_usage_guide.rst +++ b/doc/source/user/scale_usage_guide.rst @@ -17,6 +17,11 @@ VNF scaling =========== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + VNF resources in terms of CPU core and memory are hardcoded in the VNFD template through image flavor settings. This results in either provisioning VNF for typical usage or for maximum usage. The former leads to service diff --git a/doc/source/user/vnf_component_usage_guide.rst b/doc/source/user/vnf_component_usage_guide.rst index ddd86cf0b..ae594ee7f 100644 --- a/doc/source/user/vnf_component_usage_guide.rst +++ b/doc/source/user/vnf_component_usage_guide.rst @@ -2,6 +2,11 @@ VNF Component in Tacker ======================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This section will cover how to deploy `vnf component` in Tacker with the examples of how to write VNF descriptors. diff --git a/doc/source/user/vnffg_usage_guide.rst b/doc/source/user/vnffg_usage_guide.rst index 359b81dae..2be999323 100644 --- a/doc/source/user/vnffg_usage_guide.rst +++ b/doc/source/user/vnffg_usage_guide.rst @@ -17,6 +17,11 @@ VNF Forwarding Graph ==================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + VNF Forwarding Graph or VNFFG feature in Tacker is used to orchestrate and manage traffic through VNFs. In short, abstract VNFFG TOSCA definitions are rendered into Service Function Chains (SFCs) and Classifiers. The SFC makes diff --git a/doc/source/user/vnffg_usage_guide_advanced.rst b/doc/source/user/vnffg_usage_guide_advanced.rst index 768c90deb..afb1c9664 100644 --- a/doc/source/user/vnffg_usage_guide_advanced.rst +++ b/doc/source/user/vnffg_usage_guide_advanced.rst @@ -15,6 +15,11 @@ VNF Forwarding Graph Advanced Usage Guide ========================================= +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + This section cover some examples about advanced VNFFG usage guide in Tacker. Users should have some basic knowledge about VNFFG [#f1]_, before following this document. diff --git a/doc/source/user/vnfm_usage_guide.rst b/doc/source/user/vnfm_usage_guide.rst index 747cf8b47..e8fd1e187 100644 --- a/doc/source/user/vnfm_usage_guide.rst +++ b/doc/source/user/vnfm_usage_guide.rst @@ -18,6 +18,11 @@ VNF Manager User Guide ====================== +.. warning:: + Legacy Tacker features excluding VIM feature are deprecated + and will be removed in the first major release after the Tacker server + version 9.0.0 (2023.1 Antelope release). + Tacker VNF Manager (VNFM) component manages the life-cycle of a Virtual Network Function (VNF). VNFM takes care of deployment, monitoring, updating, scaling and removal of VNFs on a Virtual Infrastructure Manager (VIM). diff --git a/releasenotes/notes/deprecate-legacy-apis-excluding-vim-e7d1292ce1070839.yaml b/releasenotes/notes/deprecate-legacy-apis-excluding-vim-e7d1292ce1070839.yaml new file mode 100644 index 000000000..1832a5e8b --- /dev/null +++ b/releasenotes/notes/deprecate-legacy-apis-excluding-vim-e7d1292ce1070839.yaml @@ -0,0 +1,6 @@ +--- +deprecations: + - | + Legacy APIs excluding VIM feature are deprecated and will be removed in the + first major release after the Tacker server version 9.0.0 (2023.1 Antelope + release). diff --git a/tacker/wsgi.py b/tacker/wsgi.py index e2d3a237a..77d25fd4c 100644 --- a/tacker/wsgi.py +++ b/tacker/wsgi.py @@ -25,6 +25,7 @@ import socket import ssl import sys import time +from urllib import parse import eventlet.wsgi # eventlet.patcher.monkey_patch(all=False, socket=True, thread=True) @@ -148,6 +149,20 @@ def expected_errors(errors): return decorator +# TODO(ueha): Remove this along with the deprecated APIs in the first major +# Tacker release after version 9.0.0 (2023.1 Antelope release). +def deprecate_legacy_warning(req): + parts = parse.urlparse(req.url) + p = parts.path.split('/') + if 'vims' not in p[2]: + # Emit warning log if the request is Legacy API not related to VIM + LOG.warning( + 'The Legacy API interface has been deprecated. This API ' + f'(path={parts.path}) will be removed in the first major ' + 'release after the Tacker server version 9.0.0 (2023.1 Antelope ' + 'release).') + + class Server(object): """Server class to manage multiple WSGI sockets and applications.""" @@ -329,6 +344,7 @@ class Middleware(object): @webob.dec.wsgify def __call__(self, req): + deprecate_legacy_warning(req) response = self.process_request(req) if response: return response