OpenStack Networking (Neutron)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

194 lines
11 KiB

# Copyright 2012 Red Hat, Inc.
# 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
# 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_lib import constants as n_const
from oslo_config import cfg
from neutron._i18n import _
from neutron.plugins.ml2.drivers.openvswitch.agent.common \
import constants
ovs_opts = [
cfg.StrOpt('integration_bridge', default='br-int',
help=_("Integration bridge to use. "
"Do not change this parameter unless you have a good "
"reason to. This is the name of the OVS integration "
"bridge. There is one per hypervisor. The integration "
"bridge acts as a virtual 'patch bay'. All VM VIFs are "
"attached to this bridge and then 'patched' according "
"to their network connectivity.")),
cfg.StrOpt('tunnel_bridge', default='br-tun',
help=_("Tunnel bridge to use.")),
cfg.StrOpt('int_peer_patch_port', default='patch-tun',
help=_("Peer patch port in integration bridge for tunnel "
cfg.StrOpt('tun_peer_patch_port', default='patch-int',
help=_("Peer patch port in tunnel bridge for integration "
help=_("IP address of local overlay (tunnel) network endpoint. "
"Use either an IPv4 or IPv6 address that resides on one "
"of the host network interfaces. The IP version of this "
"value must match the value of the 'overlay_ip_version' "
"option in the ML2 plug-in configuration file on the "
"neutron server node(s).")),
help=_("Comma-separated list of <physical_network>:<bridge> "
"tuples mapping physical network names to the agent's "
"node-specific Open vSwitch bridge names to be used "
"for flat and VLAN networks. The length of bridge "
"names should be no more than 11. Each bridge must "
"exist, and should have a physical network interface "
"configured as a port. All physical networks "
"configured on the server should have mappings to "
"appropriate bridges on each agent. "
"Note: If you remove a bridge from this "
"mapping, make sure to disconnect it from the "
"integration bridge as it won't be managed by the "
"agent anymore.")),
help=_("Comma-separated list of "
"<bridge>:<egress_bw>:<ingress_bw> tuples, showing "
"the available bandwidth for the given bridge in the "
"given direction. The direction is meant from VM "
"perspective. Bandwidth is measured in kilobits per "
"second (kbps). The bridge must appear in "
"bridge_mappings as the value. But not all bridges in "
"bridge_mappings must be listed here. For a bridge not "
"listed here we neither create a resource provider in "
"placement nor report inventories against. An omitted "
"direction means we do not report an inventory for the "
"corresponding class.")),
help=_("Mapping of bridges to hypervisors: "
"<bridge>:<hypervisor>,... "
"hypervisor name is used to locate the parent of the "
"resource provider tree. Only needs to be set in the "
"rare case when the hypervisor name is different from "
"the resource_provider_default_hypervisor config "
"option value as known by the nova-compute managing "
"that hypervisor.")),
help=_("The default hypervisor name used to locate the parent "
"of the resource provider. If this option is not set, "
"canonical name is used")),
default={'allocation_ratio': 1.0,
'min_unit': 1,
'step_size': 1,
'reserved': 0},
help=_("Key:value pairs to specify defaults used "
"while reporting resource provider inventories. "
"Possible keys with their types: "
"allocation_ratio:float, "
"max_unit:int, min_unit:int, "
"reserved:int, step_size:int, "
"See also: "
cfg.BoolOpt('use_veth_interconnection', default=False,
help=_("Use veths instead of patch ports to interconnect the "
"integration bridge to physical networks. "
"Support kernel without Open vSwitch patch port "
"support so long as it is set to True.")),
cfg.StrOpt('datapath_type', default=constants.OVS_DATAPATH_SYSTEM,
help=_("OVS datapath to use. 'system' is the default value and "
"corresponds to the kernel datapath. To enable the "
"userspace datapath set this value to 'netdev'.")),
cfg.StrOpt('vhostuser_socket_dir', default=constants.VHOST_USER_SOCKET_DIR,
help=_("OVS vhost-user socket directory.")),
cfg.IPOpt('of_listen_address', default='',
help=_("Address to listen on for OpenFlow connections.")),
cfg.PortOpt('of_listen_port', default=6633,
help=_("Port to listen on for OpenFlow connections.")),
cfg.IntOpt('of_connect_timeout', default=300,
help=_("Timeout in seconds to wait for "
"the local switch connecting the controller.")),
cfg.IntOpt('of_request_timeout', default=300,
help=_("Timeout in seconds to wait for a single "
"OpenFlow request.")),
cfg.IntOpt('of_inactivity_probe', default=10,
help=_("The inactivity_probe interval in seconds for the local "
"switch connection to the controller. "
"A value of 0 disables inactivity probes.")),
agent_opts = [
help=_("Minimize polling by monitoring ovsdb for interface "
help=_("The number of seconds to wait before respawning the "
"ovsdb monitor after losing communication with it.")),
cfg.ListOpt('tunnel_types', default=DEFAULT_TUNNEL_TYPES,
help=_("Network types supported by the agent "
"(gre, vxlan and/or geneve).")),
cfg.PortOpt('vxlan_udp_port', default=n_const.VXLAN_UDP_PORT,
help=_("The UDP port to use for VXLAN tunnels.")),
cfg.IntOpt('veth_mtu', default=9000,
help=_("MTU size of veth interfaces")),
cfg.BoolOpt('l2_population', default=False,
help=_("Use ML2 l2population mechanism driver to learn "
"remote MAC and IPs and improve tunnel scalability.")),
cfg.BoolOpt('arp_responder', default=False,
help=_("Enable local ARP responder if it is supported. "
"Requires OVS 2.1 and ML2 l2population driver. "
"Allows the switch (when supporting an overlay) "
"to respond to an ARP request locally without "
"performing a costly ARP broadcast into the overlay. "
"NOTE: If enable_distributed_routing is set to True "
"then arp_responder will automatically be set to True "
"in the agent, regardless of the setting in the config "
cfg.BoolOpt('dont_fragment', default=True,
help=_("Set or un-set the don't fragment (DF) bit on "
"outgoing IP packet carrying GRE/VXLAN tunnel.")),
cfg.BoolOpt('enable_distributed_routing', default=False,
help=_("Make the l2 agent run in DVR mode.")),
cfg.BoolOpt('drop_flows_on_start', default=False,
help=_("Reset flow table on start. Setting this to True will "
"cause brief traffic interruption.")),
cfg.BoolOpt('tunnel_csum', default=False,
help=_("Set or un-set the tunnel header checksum on "
"outgoing IP packet carrying GRE/VXLAN tunnel.")),
cfg.BoolOpt('baremetal_smartnic', default=False,
help=_("Enable the agent to process Smart NIC ports.")),
cfg.BoolOpt('explicitly_egress_direct', default=False,
help=_("When set to True, the accepted egress unicast "
"traffic will not use action NORMAL. The accepted "
"egress packets will be taken care of in the final "
"egress tables direct output flows for unicast "
def register_ovs_agent_opts(cfg=cfg.CONF):
cfg.register_opts(ovs_opts, "OVS")
cfg.register_opts(agent_opts, "AGENT")
def register_ovs_opts(cfg=cfg.CONF):
cfg.register_opts(ovs_opts, "OVS")