openstack/tacker
Code Issues Proposed changes

Merge "Deprecate Legacy APIs excluding VIM feature"

Browse Source
This commit is contained in:
Zuul 2023-02-21 05:17:09 +00:00 committed by Gerrit Code Review
commit dd668b866e
42 changed files with 222 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api-ref/source/v1/legacy.rst
View File

@ -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

5
doc/source/admin/index.rst
View File

@ -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 <command-name>**.
.. 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.

5
doc/source/cli/cli-legacy-event.rst
View File

@ -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

5
doc/source/cli/cli-legacy-fc.rst
View File

@ -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).

5
doc/source/cli/cli-legacy-nfp.rst
View File

@ -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).

5
doc/source/cli/cli-legacy-nsd.rst
View File

@ -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.

5
doc/source/cli/cli-legacy-sfc.rst
View File

@ -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
-------------

5
doc/source/cli/cli-legacy-vnf.rst
View File

@ -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.

5
doc/source/cli/cli-legacy-vnfd.rst
View File

@ -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.

5
doc/source/cli/cli-legacy-vnffg.rst
View File

@ -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

5
doc/source/cli/cli-legacy-vnffgd.rst
View File

@ -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

5
doc/source/cli/index.rst
View File

@ -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

5
doc/source/contributor/event_logging.rst
View File

@ -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
--------

5
doc/source/contributor/monitor-api.rst
View File

@ -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.

5
doc/source/contributor/policy_actions_framework.rst
View File

@ -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

6
doc/source/contributor/vnfd_template_description.rst
View File

@ -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
--------

5
doc/source/contributor/vnfd_template_parameterization.rst
View File

@ -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
--------

5
doc/source/contributor/vnffgd_template_description.rst
View File

@ -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]_.

5
doc/source/contributor/zabbix-plugin.rst
View File

@ -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.

5
doc/source/install/legacy_getting_started.rst
View File

@ -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.

5
doc/source/reference/block_storage_usage_guide.rst
View File

@ -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.

5
doc/source/reference/maintenance_usage_guide.rst
View File

@ -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.

5
doc/source/reference/mistral_workflows_usage_guide.rst
View File

@ -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

5
doc/source/reference/reservation_policy_usage_guide.rst
View File

@ -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

5
doc/source/user/alarm_monitoring_usage_guide.rst
View File

@ -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

5
doc/source/user/containerized_vnf_usage_guide.rst
View File

@ -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.

5
doc/source/user/dynamic_vnffg_usage_guide.rst
View File

@ -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

5
doc/source/user/enhanced_placement_awareness_usage_guide.rst
View File

@ -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
--------

5
doc/source/user/index.rst
View File

@ -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

5
doc/source/user/introduction.rst
View File

@ -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

4
doc/source/user/legacy_use_case_guide.rst
View File

@ -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
---

5
doc/source/user/multisite_vim_usage_guide.rst
View File

@ -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

5
doc/source/user/nsd_usage_guide.rst
View File

@ -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

5
doc/source/user/placement_policy_usage_guide.rst
View File

@ -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::

5
doc/source/user/resources.rst
View File

@ -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
^^^^

5
doc/source/user/scale_usage_guide.rst
View File

@ -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

5
doc/source/user/vnf_component_usage_guide.rst
View File

@ -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.

5
doc/source/user/vnffg_usage_guide.rst
View File

@ -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

5
doc/source/user/vnffg_usage_guide_advanced.rst
View File

@ -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.

5
doc/source/user/vnfm_usage_guide.rst
View File

@ -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).

6
releasenotes/notes/deprecate-legacy-apis-excluding-vim-e7d1292ce1070839.yaml Normal file
View File

@ -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).

16
tacker/wsgi.py
View File

@ -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