¡@

Home 

OpenStack Study: l3_rpc_agent_api.py

OpenStack Index

**** CubicPower OpenStack Study ****

# Copyright (c) 2013 OpenStack Foundation.

#

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

from neutron.common import constants

from neutron.common import topics

from neutron.common import utils

from neutron import manager

from neutron.openstack.common import log as logging

from neutron.openstack.common.rpc import proxy

from neutron.plugins.common import constants as service_constants

LOG = logging.getLogger(__name__)

**** CubicPower OpenStack Study ****

class L3AgentNotifyAPI(proxy.RpcProxy):

"""API for plugin to notify L3 agent."""

BASE_RPC_API_VERSION = '1.0'

**** CubicPower OpenStack Study ****

    def __init__(self, topic=topics.L3_AGENT):

        super(L3AgentNotifyAPI, self).__init__(

            topic=topic, default_version=self.BASE_RPC_API_VERSION)

**** CubicPower OpenStack Study ****

    def _notification_host(self, context, method, payload, host):

        """Notify the agent that is hosting the router."""

        LOG.debug(_('Nofity agent at %(host)s the message '

                    '%(method)s'), {'host': host,

                                    'method': method})

        self.cast(

            context, self.make_msg(method,

                                   payload=payload),

            topic='%s.%s' % (topics.L3_AGENT, host))

**** CubicPower OpenStack Study ****

    def _agent_notification(self, context, method, router_ids,

                            operation, data):

        """Notify changed routers to hosting l3 agents."""

        adminContext = context.is_admin and context or context.elevated()

        plugin = manager.NeutronManager.get_service_plugins().get(

            service_constants.L3_ROUTER_NAT)

        for router_id in router_ids:

            l3_agents = plugin.get_l3_agents_hosting_routers(

                adminContext, [router_id],

                admin_state_up=True,

                active=True)

            for l3_agent in l3_agents:

                LOG.debug(_('Notify agent at %(topic)s.%(host)s the message '

                            '%(method)s'),

                          {'topic': l3_agent.topic,

                           'host': l3_agent.host,

                           'method': method})

                self.cast(

                    context, self.make_msg(method,

                                           routers=[router_id]),

                    topic='%s.%s' % (l3_agent.topic, l3_agent.host),

                    version='1.1')

**** CubicPower OpenStack Study ****

    def _notification(self, context, method, router_ids, operation, data):

        """Notify all the agents that are hosting the routers."""

        plugin = manager.NeutronManager.get_service_plugins().get(

            service_constants.L3_ROUTER_NAT)

        if not plugin:

            LOG.error(_('No plugin for L3 routing registered. Cannot notify '

                        'agents with the message %s'), method)

            return

        if utils.is_extension_supported(

                plugin, constants.L3_AGENT_SCHEDULER_EXT_ALIAS):

            adminContext = (context.is_admin and

                            context or context.elevated())

            plugin.schedule_routers(adminContext, router_ids)

            self._agent_notification(

                context, method, router_ids, operation, data)

        else:

            self.fanout_cast(

                context, self.make_msg(method,

                                       routers=router_ids),

                topic=topics.L3_AGENT)

**** CubicPower OpenStack Study ****

    def _notification_fanout(self, context, method, router_id):

        """Fanout the deleted router to all L3 agents."""

        LOG.debug(_('Fanout notify agent at %(topic)s the message '

                    '%(method)s on router %(router_id)s'),

                  {'topic': topics.L3_AGENT,

                   'method': method,

                   'router_id': router_id})

        self.fanout_cast(

            context, self.make_msg(method,

                                   router_id=router_id),

            topic=topics.L3_AGENT)

**** CubicPower OpenStack Study ****

    def agent_updated(self, context, admin_state_up, host):

        self._notification_host(context, 'agent_updated',

                                {'admin_state_up': admin_state_up},

                                host)

**** CubicPower OpenStack Study ****

    def router_deleted(self, context, router_id):

        self._notification_fanout(context, 'router_deleted', router_id)

**** CubicPower OpenStack Study ****

    def routers_updated(self, context, router_ids, operation=None, data=None):

        if router_ids:

            self._notification(context, 'routers_updated', router_ids,

                               operation, data)

**** CubicPower OpenStack Study ****

    def router_removed_from_agent(self, context, router_id, host):

        self._notification_host(context, 'router_removed_from_agent',

                                {'router_id': router_id}, host)

**** CubicPower OpenStack Study ****

    def router_added_to_agent(self, context, router_ids, host):

        self._notification_host(context, 'router_added_to_agent',

                                router_ids, host)

L3AgentNotify = L3AgentNotifyAPI()