¡@

Home 

OpenStack Study: ryu_neutron_agent.py

OpenStack Index

**** CubicPower OpenStack Study ****

#!/usr/bin/env python

# Copyright 2012 Isaku Yamahata

# Based on openvswitch agent.

#

# Copyright 2011 VMware, Inc.

# All Rights Reserved.

#

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

# @author: Isaku Yamahata

import httplib

import socket

import sys

import time

import eventlet

from oslo.config import cfg

from ryu.app import client

from ryu.app import conf_switch_key

from ryu.app import rest_nw_id

from neutron.agent.linux import ip_lib

from neutron.agent.linux import ovs_lib

from neutron.agent.linux.ovs_lib import VifPort

from neutron.agent import rpc as agent_rpc

from neutron.agent import securitygroups_rpc as sg_rpc

from neutron.common import config as logging_config

from neutron.common import exceptions as n_exc

from neutron.common import topics

from neutron import context as q_context

from neutron.extensions import securitygroup as ext_sg

from neutron.openstack.common import log

from neutron.openstack.common.rpc import dispatcher

from neutron.plugins.ryu.common import config # noqa

LOG = log.getLogger(__name__)

# This is copied of nova.flags._get_my_ip()

# Agent shouldn't depend on nova module

**** CubicPower OpenStack Study ****

def _get_my_ip():

    """Return the actual ip of the local machine.

    This code figures out what source address would be used if some traffic

    were to be sent out to some well known address on the Internet. In this

    case, a Google DNS server is used, but the specific address does not

    matter much.  No traffic is actually sent.

    """

    csock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)

    csock.connect(('8.8.8.8', 80))

    (addr, _port) = csock.getsockname()

    csock.close()

    return addr

**** CubicPower OpenStack Study ****

def _get_ip_from_nic(nic):

    ip_wrapper = ip_lib.IPWrapper()

    dev = ip_wrapper.device(nic)

    addrs = dev.addr.list(scope='global')

    for addr in addrs:

        if addr['ip_version'] == 4:

            return addr['cidr'].split('/')[0]

**** CubicPower OpenStack Study ****

def _get_ip(cfg_ip_str, cfg_interface_str):

    ip = None

    try:

        ip = getattr(cfg.CONF.OVS, cfg_ip_str)

    except (cfg.NoSuchOptError, cfg.NoSuchGroupError):

        pass

    if ip:

        return ip

    iface = None

    try:

        iface = getattr(cfg.CONF.OVS, cfg_interface_str)

    except (cfg.NoSuchOptError, cfg.NoSuchGroupError):

        pass

    if iface:

        ip = _get_ip_from_nic(iface)

        if ip:

            return ip

        LOG.warning(_('Could not get IPv4 address from %(nic)s: %(cfg)s'),

                    {'nic': iface, 'cfg': cfg_interface_str})

    return _get_my_ip()

**** CubicPower OpenStack Study ****

def _get_tunnel_ip():

    return _get_ip('tunnel_ip', 'tunnel_interface')

**** CubicPower OpenStack Study ****

def _get_ovsdb_ip():

    return _get_ip('ovsdb_ip', 'ovsdb_interface')

**** CubicPower OpenStack Study ****

class OVSBridge(ovs_lib.OVSBridge):

**** CubicPower OpenStack Study ****

    def __init__(self, br_name, root_helper):

        ovs_lib.OVSBridge.__init__(self, br_name, root_helper)

        self.datapath_id = None

**** CubicPower OpenStack Study ****

    def find_datapath_id(self):

        self.datapath_id = self.get_datapath_id()

**** CubicPower OpenStack Study ****

    def set_manager(self, target):

        self.run_vsctl(["set-manager", target])

**** CubicPower OpenStack Study ****

    def get_ofport(self, name):

        return self.db_get_val("Interface", name, "ofport")

**** CubicPower OpenStack Study ****

    def _get_ports(self, get_port):

        ports = []

        port_names = self.get_port_name_list()

        for name in port_names:

            if self.get_ofport(name) < 0:

                continue

            port = get_port(name)

            if port:

                ports.append(port)

        return ports

**** CubicPower OpenStack Study ****

    def _get_external_port(self, name):

        # exclude vif ports

        external_ids = self.db_get_map("Interface", name, "external_ids")

        if external_ids:

            return

        # exclude tunnel ports

        options = self.db_get_map("Interface", name, "options")

        if "remote_ip" in options:

            return

        ofport = self.get_ofport(name)

        return VifPort(name, ofport, None, None, self)

**** CubicPower OpenStack Study ****

    def get_external_ports(self):

        return self._get_ports(self._get_external_port)

**** CubicPower OpenStack Study ****

class VifPortSet(object):

**** CubicPower OpenStack Study ****

    def __init__(self, int_br, ryu_rest_client):

        super(VifPortSet, self).__init__()

        self.int_br = int_br

        self.api = ryu_rest_client

**** CubicPower OpenStack Study ****

    def setup(self):

        for port in self.int_br.get_external_ports():

            LOG.debug(_('External port %s'), port)

            self.api.update_port(rest_nw_id.NW_ID_EXTERNAL,

                                 port.switch.datapath_id, port.ofport)

**** CubicPower OpenStack Study ****

class RyuPluginApi(agent_rpc.PluginApi, sg_rpc.SecurityGroupServerRpcApiMixin):

**** CubicPower OpenStack Study ****

    def get_ofp_rest_api_addr(self, context):

        LOG.debug(_("Get Ryu rest API address"))

        return self.call(context,

                         self.make_msg('get_ofp_rest_api'),

                         topic=self.topic)

**** CubicPower OpenStack Study ****

class RyuSecurityGroupAgent(sg_rpc.SecurityGroupAgentRpcMixin):

**** CubicPower OpenStack Study ****

    def __init__(self, context, plugin_rpc, root_helper):

        self.context = context

        self.plugin_rpc = plugin_rpc

        self.root_helper = root_helper

        self.init_firewall()

**** CubicPower OpenStack Study ****

class OVSNeutronOFPRyuAgent(sg_rpc.SecurityGroupAgentRpcCallbackMixin):

RPC_API_VERSION = '1.1'

**** CubicPower OpenStack Study ****

    def __init__(self, integ_br, tunnel_ip, ovsdb_ip, ovsdb_port,

                 polling_interval, root_helper):

        super(OVSNeutronOFPRyuAgent, self).__init__()

        self.polling_interval = polling_interval

        self._setup_rpc()

        self.sg_agent = RyuSecurityGroupAgent(self.context,

                                              self.plugin_rpc,

                                              root_helper)

        self._setup_integration_br(root_helper, integ_br, tunnel_ip,

                                   ovsdb_port, ovsdb_ip)

**** CubicPower OpenStack Study ****

    def _setup_rpc(self):

        self.topic = topics.AGENT

        self.plugin_rpc = RyuPluginApi(topics.PLUGIN)

        self.context = q_context.get_admin_context_without_session()

        self.dispatcher = self._create_rpc_dispatcher()

        consumers = [[topics.PORT, topics.UPDATE],

                     [topics.SECURITY_GROUP, topics.UPDATE]]

        self.connection = agent_rpc.create_consumers(self.dispatcher,

                                                     self.topic,

                                                     consumers)

**** CubicPower OpenStack Study ****

    def _create_rpc_dispatcher(self):

        return dispatcher.RpcDispatcher([self])

**** CubicPower OpenStack Study ****

    def _setup_integration_br(self, root_helper, integ_br,

                              tunnel_ip, ovsdb_port, ovsdb_ip):

        self.int_br = OVSBridge(integ_br, root_helper)

        self.int_br.find_datapath_id()

        rest_api_addr = self.plugin_rpc.get_ofp_rest_api_addr(self.context)

        if not rest_api_addr:

            raise n_exc.Invalid(_("Ryu rest API port isn't specified"))

        LOG.debug(_("Going to ofp controller mode %s"), rest_api_addr)

        ryu_rest_client = client.OFPClient(rest_api_addr)

        self.vif_ports = VifPortSet(self.int_br, ryu_rest_client)

        self.vif_ports.setup()

        sc_client = client.SwitchConfClient(rest_api_addr)

        sc_client.set_key(self.int_br.datapath_id,

                          conf_switch_key.OVS_TUNNEL_ADDR, tunnel_ip)

        # Currently Ryu supports only tcp methods. (ssl isn't supported yet)

        self.int_br.set_manager('ptcp:%d' % ovsdb_port)

        sc_client.set_key(self.int_br.datapath_id, conf_switch_key.OVSDB_ADDR,

                          'tcp:%s:%d' % (ovsdb_ip, ovsdb_port))

**** CubicPower OpenStack Study ****

    def port_update(self, context, **kwargs):

        LOG.debug(_("Port update received"))

        port = kwargs.get('port')

        vif_port = self.int_br.get_vif_port_by_id(port['id'])

        if not vif_port:

            return

        if ext_sg.SECURITYGROUPS in port:

            self.sg_agent.refresh_firewall()

**** CubicPower OpenStack Study ****

    def _update_ports(self, registered_ports):

        ports = self.int_br.get_vif_port_set()

        if ports == registered_ports:

            return

        added = ports - registered_ports

        removed = registered_ports - ports

        return {'current': ports,

                'added': added,

                'removed': removed}

**** CubicPower OpenStack Study ****

    def _process_devices_filter(self, port_info):

        if 'added' in port_info:

            self.sg_agent.prepare_devices_filter(port_info['added'])

        if 'removed' in port_info:

            self.sg_agent.remove_devices_filter(port_info['removed'])

**** CubicPower OpenStack Study ****

    def daemon_loop(self):

        ports = set()

        while True:

            start = time.time()

            try:

                port_info = self._update_ports(ports)

                if port_info:

                    LOG.debug(_("Agent loop has new device"))

                    self._process_devices_filter(port_info)

                    ports = port_info['current']

            except Exception:

                LOG.exception(_("Error in agent event loop"))

            elapsed = max(time.time() - start, 0)

            if (elapsed < self.polling_interval):

                time.sleep(self.polling_interval - elapsed)

            else:

                LOG.debug(_("Loop iteration exceeded interval "

                            "(%(polling_interval)s vs. %(elapsed)s)!"),

                          {'polling_interval': self.polling_interval,

                           'elapsed': elapsed})

def main():

    eventlet.monkey_patch()

    cfg.CONF(project='neutron')

    logging_config.setup_logging(cfg.CONF)

    integ_br = cfg.CONF.OVS.integration_bridge

    polling_interval = cfg.CONF.AGENT.polling_interval

    root_helper = cfg.CONF.AGENT.root_helper

    tunnel_ip = _get_tunnel_ip()

    LOG.debug(_('tunnel_ip %s'), tunnel_ip)

    ovsdb_port = cfg.CONF.OVS.ovsdb_port

    LOG.debug(_('ovsdb_port %s'), ovsdb_port)

    ovsdb_ip = _get_ovsdb_ip()

    LOG.debug(_('ovsdb_ip %s'), ovsdb_ip)

    try:

        agent = OVSNeutronOFPRyuAgent(integ_br, tunnel_ip, ovsdb_ip,

                                      ovsdb_port, polling_interval,

                                      root_helper)

    except httplib.HTTPException as e:

        LOG.error(_("Initialization failed: %s"), e)

        sys.exit(1)

    LOG.info(_("Ryu initialization on the node is done. "

               "Agent initialized successfully, now running..."))

    agent.daemon_loop()

    sys.exit(0)

if __name__ == "__main__":

    main()

**** CubicPower OpenStack Study ****

def main():

    eventlet.monkey_patch()

    cfg.CONF(project='neutron')

    logging_config.setup_logging(cfg.CONF)

    integ_br = cfg.CONF.OVS.integration_bridge

    polling_interval = cfg.CONF.AGENT.polling_interval

    root_helper = cfg.CONF.AGENT.root_helper

    tunnel_ip = _get_tunnel_ip()

    LOG.debug(_('tunnel_ip %s'), tunnel_ip)

    ovsdb_port = cfg.CONF.OVS.ovsdb_port

    LOG.debug(_('ovsdb_port %s'), ovsdb_port)

    ovsdb_ip = _get_ovsdb_ip()

    LOG.debug(_('ovsdb_ip %s'), ovsdb_ip)

    try:

        agent = OVSNeutronOFPRyuAgent(integ_br, tunnel_ip, ovsdb_ip,

                                      ovsdb_port, polling_interval,

                                      root_helper)

    except httplib.HTTPException as e:

        LOG.error(_("Initialization failed: %s"), e)

        sys.exit(1)

    LOG.info(_("Ryu initialization on the node is done. "

               "Agent initialized successfully, now running..."))

    agent.daemon_loop()

    sys.exit(0)

if __name__ == "__main__":

    main()