b6244f5b37
Migrate neutron agent extensions to neutron-lib. This includes both the common abstract object as well as the l2 and l3-specific objects for agent extensions. This functionality is used by neutron, neutron-fwaas, networking-sfc, and tap-as-a-service. Please note that this does not migrate the l3_agent_extensions_api to neutron-lib. This is because that specifically has a long dependency chain that ends up requiring agent/[linux,windows]/utils.py, which should be migrated separately. Change-Id: I7255a5ae6b706c09acecc0dea5dbd2febae0c282 Needed-By: I6d2cff03207924c7492c6136d4b21a9817769c67 Needed-By: If9235c1cf39b8ad2ef049e8154b82736e1f1d763 Needed-By: Ie8f0e70b11435d627f73e3fed45f946e863e90bc Needed-By: Ia5962acfd737b4b350b94591802928a5a4dc53fb
49 lines
1.8 KiB
Python
49 lines
1.8 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import abc
|
|
|
|
import six
|
|
|
|
|
|
@six.add_metaclass(abc.ABCMeta)
|
|
class AgentExtension(object):
|
|
"""Define stable abstract interface for agent extensions.
|
|
|
|
An agent extension extends the agent core functionality.
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def initialize(self, connection, driver_type):
|
|
"""Perform agent core resource extension initialization.
|
|
|
|
:param connection: RPC connection that can be reused by the extension
|
|
to define its RPC endpoints
|
|
:param driver_type: String that defines the agent type to the
|
|
extension. Can be used to choose the right backend
|
|
implementation.
|
|
|
|
Called after all extensions have been loaded.
|
|
No resource (port, policy, router, etc.) handling will be called before
|
|
this method.
|
|
"""
|
|
|
|
def consume_api(self, agent_api):
|
|
"""Consume the AgentAPI instance from the AgentExtensionsManager.
|
|
|
|
Allows an extension to gain access to resources internal to the
|
|
neutron agent and otherwise unavailable to the extension. Examples of
|
|
such resources include bridges, ports, and routers.
|
|
|
|
:param agent_api: An instance of an agent-specific API.
|
|
"""
|