openstack/nova
Code Issues Proposed changes

Merge "conf: Fix indentation of network"

Browse Source
This commit is contained in:
Jenkins 2016-11-30 04:29:24 +00:00 committed by Gerrit Code Review
commit 8647620246
1 changed files with 143 additions and 143 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

286
nova/conf/network.py
View File

@ -28,7 +28,7 @@ NOVA_NET_API = 'nova.network.api.API'
network_opts = [
cfg.StrOpt("flat_network_bridge",
help="""
help="""
This option determines the bridge used for simple network interfaces when no
bridge is specified in the VM creation request.
@ -44,8 +44,8 @@ Related options:
``use_neutron``
"""),
cfg.StrOpt("flat_network_dns",
default="8.8.4.4",
help="""
default="8.8.4.4",
help="""
This is the address of the DNS server for a simple network. If this option is
not specified, the default of '8.8.4.4' is used.
@ -61,15 +61,15 @@ Related options:
``use_neutron``
"""),
cfg.BoolOpt("flat_injected",
default=False,
help="""
default=False,
help="""
This option determines whether the network setup information is injected into
the VM before it is booted. While it was originally designed to be used only by
nova-network, it is also used by the vmware and xenapi virt drivers to control
whether network information is injected into a VM.
"""),
cfg.StrOpt("flat_interface",
help="""
help="""
This option is the name of the virtual interface of the VM on which the bridge
will be built. While it was originally designed to be used only by
nova-network, it is also used by libvirt for the bridge interface name.
@ -79,10 +79,10 @@ Possible values:
Any valid virtual interface name, such as 'eth0'
"""),
cfg.IntOpt("vlan_start",
default=100,
min=1,
max=4094,
help="""
default=100,
min=1,
max=4094,
help="""
This is the VLAN number used for private networks. Note that the when creating
the networks, if the specified number has already been assigned, nova-network
will increment this number until it finds an available VLAN.
@ -102,7 +102,7 @@ Related options:
``network_manager``, ``use_neutron``
"""),
cfg.StrOpt("vlan_interface",
help="""
help="""
This option is the name of the virtual interface of the VM on which the VLAN
bridge will be built. While it was originally designed to be used only by
nova-network, it is also used by libvirt and xenapi for the bridge interface
@ -117,9 +117,9 @@ Possible values:
Any valid virtual interface name, such as 'eth0'
"""),
cfg.IntOpt("num_networks",
default=1,
min=1,
help="""
default=1,
min=1,
help="""
This option represents the number of networks to create if not explicitly
specified when the network is created. The only time this is used is if a CIDR
is specified, but an explicit network_size is not. In that case, the subnets
@ -142,8 +142,8 @@ Related options:
``use_neutron``, ``network_size``
"""),
cfg.StrOpt("vpn_ip",
default="$my_ip",
help="""
default="$my_ip",
help="""
This is the public IP address for the cloudpipe VPN servers. It defaults to the
IP address of the host.
@ -161,8 +161,8 @@ Related options:
``network_manager``, ``use_neutron``, ``vpn_start``
"""),
cfg.PortOpt("vpn_start",
default=1000,
help="""
default=1000,
help="""
This is the port number to use as the first VPN port for private networks.
Please note that this option is only used when using nova-network instead of
@ -180,9 +180,9 @@ Related options:
``use_neutron``, ``vpn_ip``, ``network_manager``
"""),
cfg.IntOpt("network_size",
default=256,
min=1,
help="""
default=256,
min=1,
help="""
This option determines the number of addresses in each private subnet.
Please note that this option is only used when using nova-network instead of
@ -199,8 +199,8 @@ Related options:
``use_neutron``, ``num_networks``
"""),
cfg.StrOpt("fixed_range_v6",
default="fd00::/48",
help="""
default="fd00::/48",
help="""
This option determines the fixed IPv6 address block when creating a network.
Please note that this option is only used when using nova-network instead of
@ -215,7 +215,7 @@ Related options:
``use_neutron``
"""),
cfg.StrOpt("gateway",
help="""
help="""
This is the default IPv4 gateway. It is used only in the testing suite.
Please note that this option is only used when using nova-network instead of
@ -230,7 +230,7 @@ Related options:
``use_neutron``, ``gateway_v6``
"""),
cfg.StrOpt("gateway_v6",
help="""
help="""
This is the default IPv6 gateway. It is used only in the testing suite.
Please note that this option is only used when using nova-network instead of
@ -245,9 +245,9 @@ Related options:
``use_neutron``, ``gateway``
"""),
cfg.IntOpt("cnt_vpn_clients",
default=0,
min=0,
help="""
default=0,
min=0,
help="""
This option represents the number of IP addresses to reserve at the top of the
address range for VPN clients. It also will be ignored if the configuration
option for `network_manager` is not set to the default of
@ -262,9 +262,9 @@ Related options:
``use_neutron``, ``network_manager``
"""),
cfg.IntOpt("fixed_ip_disassociate_timeout",
default=600,
min=0,
help="""
default=600,
min=0,
help="""
This is the number of seconds to wait before disassociating a deallocated fixed
IP address. This is only used with the nova-network service, and has no effect
when using neutron for networking.
@ -278,9 +278,9 @@ Related options:
``use_neutron``
"""),
cfg.IntOpt("create_unique_mac_address_attempts",
default=5,
min=1,
help="""
default=5,
min=1,
help="""
This option determines how many times nova-network will attempt to create a
unique MAC address before giving up and raising a
`VirtualInterfaceMacAddressException` error.
@ -294,8 +294,8 @@ Related options:
``use_neutron``
"""),
cfg.BoolOpt("teardown_unused_network_gateway",
default=False,
help="""
default=False,
help="""
Determines whether unused gateway devices, both VLAN and bridge, are deleted if
the network is in nova-network VLAN mode and is multi-hosted.
@ -304,8 +304,8 @@ Related options:
``use_neutron``, ``vpn_ip``, ``fake_network``
"""),
cfg.BoolOpt("force_dhcp_release",
default=True,
help="""
default=True,
help="""
When this option is True, a call is made to release the DHCP for the instance
when that instance is terminated.
@ -314,8 +314,8 @@ Related options:
``use_neutron``
"""),
cfg.BoolOpt("update_dns_entries",
default=False,
help="""
default=False,
help="""
When this option is True, whenever a DNS entry must be updated, a fanout cast
message is sent to all network hosts to update their DNS entries in multi-host
mode.
@ -325,9 +325,9 @@ Related options:
``use_neutron``
"""),
cfg.IntOpt("dns_update_periodic_interval",
default=-1,
min=-1,
help="""
default=-1,
min=-1,
help="""
This option determines the time, in seconds, to wait between refreshing DNS
entries for the network.
@ -341,8 +341,8 @@ Related options:
``use_neutron``
"""),
cfg.StrOpt("dhcp_domain",
default="novalocal",
help="""
default="novalocal",
help="""
This option allows you to specify the domain for the DHCP server.
Possible values:
@ -354,8 +354,8 @@ Related options:
``use_neutron``
"""),
cfg.StrOpt("l3_lib",
default="nova.network.l3.LinuxNetL3",
help="""
default="nova.network.l3.LinuxNetL3",
help="""
This option allows you to specify the L3 management library to be used.
Possible values:
@ -368,10 +368,10 @@ Related options:
``use_neutron``
"""),
cfg.BoolOpt("share_dhcp_address",
default=False,
deprecated_for_removal=True,
deprecated_since='2014.2',
help="""
default=False,
deprecated_for_removal=True,
deprecated_since='2014.2',
help="""
THIS VALUE SHOULD BE SET WHEN CREATING THE NETWORK.
If True in multi_host mode, all compute hosts share the same dhcp address. The
@ -384,16 +384,16 @@ an explicit value should be passed to 'create_networks()' as a keyword argument
with the name 'share_address'.
"""),
cfg.BoolOpt('use_neutron',
default=False,
help="Whether to use Neutron or Nova Network as the back end "
"for networking. Defaults to False (indicating Nova "
"network).Set to True to use neutron.")
default=False,
help="Whether to use Neutron or Nova Network as the back end "
"for networking. Defaults to False (indicating Nova "
"network).Set to True to use neutron.")
]
linux_net_opts = [
cfg.MultiStrOpt('dhcpbridge_flagfile',
default=['/etc/nova/nova-dhcpbridge.conf'],
help="""
default=['/etc/nova/nova-dhcpbridge.conf'],
help="""
This option is a list of full paths to one or more configuration files for
dhcpbridge. In most cases the default path of '/etc/nova/nova-dhcpbridge.conf'
should be sufficient, but if you have special needs for configuring dhcpbridge,
@ -405,8 +405,8 @@ Possible values
configuration file.
"""),
cfg.StrOpt('networks_path',
default=paths.state_path_def('networks'),
help="""
default=paths.state_path_def('networks'),
help="""
The location where the network configuration files will be kept. The default is
the 'networks' directory off of the location where nova's Python module is
installed.
@ -416,8 +416,8 @@ Possible values
A string containing the full path to the desired configuration directory
"""),
cfg.StrOpt('public_interface',
default='eth0',
help="""
default='eth0',
help="""
This is the name of the network interface for public IP addresses. The default
is 'eth0'.
@ -426,8 +426,8 @@ Possible values:
Any string representing a network interface name
"""),
cfg.StrOpt('dhcpbridge',
default=paths.bindir_def('nova-dhcpbridge'),
help="""
default=paths.bindir_def('nova-dhcpbridge'),
help="""
The location of the binary nova-dhcpbridge. By default it is the binary named
'nova-dhcpbridge' that is installed with all the other nova binaries.
@ -436,8 +436,8 @@ Possible values:
Any string representing the full path to the binary for dhcpbridge
"""),
cfg.StrOpt('routing_source_ip',
default='$my_ip',
help="""
default='$my_ip',
help="""
This is the public IP address of the network host. It is used when creating a
SNAT rule.
@ -450,9 +450,9 @@ Related options:
force_snat_range
"""),
cfg.IntOpt('dhcp_lease_time',
default=86400,
min=1,
help="""
default=86400,
min=1,
help="""
The lifetime of a DHCP lease, in seconds. The default is 86400 (one day).
Possible values:
@ -478,8 +478,8 @@ Related options:
use_network_dns_servers
"""),
cfg.BoolOpt("use_network_dns_servers",
default=False,
help="""
default=False,
help="""
When this option is set to True, the dns1 and dns2 servers for the network
specified by the user on boot will be used for DNS, as well as any specified in
the `dns_server` option.
@ -489,8 +489,8 @@ Related options:
dns_server
"""),
cfg.ListOpt("dmz_cidr",
default=[],
help="""
default=[],
help="""
This option is a list of zero or more IP address ranges in your network's DMZ
that should be accepted.
@ -499,8 +499,8 @@ Possible values:
A list of strings, each of which should be a valid CIDR.
"""),
cfg.MultiStrOpt("force_snat_range",
default=[],
help="""
default=[],
help="""
This is a list of zero or more IP ranges that traffic from the
`routing_source_ip` will be SNATted to. If the list is empty, then no SNAT
rules are created.
@ -514,8 +514,8 @@ Related options:
routing_source_ip
"""),
cfg.StrOpt("dnsmasq_config_file",
default="",
help="""
default="",
help="""
The path to the custom dnsmasq configuration file, if any.
Possible values:
@ -524,8 +524,8 @@ Possible values:
custom dnsmasq configuration file.
"""),
cfg.StrOpt("linuxnet_interface_driver",
default="nova.network.linux_net.LinuxBridgeInterfaceDriver",
help="""
default="nova.network.linux_net.LinuxBridgeInterfaceDriver",
help="""
This is the class used as the ethernet device driver for linuxnet bridge
operations. The default value should be all you need for most cases, but if you
wish to use a customized class, set this option to the full dot-separated
@ -536,8 +536,8 @@ Possible values:
Any string representing a dot-separated class path that Nova can import.
"""),
cfg.StrOpt("linuxnet_ovs_integration_bridge",
default="br-int",
help="""
default="br-int",
help="""
The name of the Open vSwitch bridge that is used with linuxnet when connecting
with Open vSwitch."
@ -546,8 +546,8 @@ Possible values:
Any string representing a valid bridge name.
"""),
cfg.BoolOpt("send_arp_for_ha",
default=False,
help="""
default=False,
help="""
When True, when a device starts up, and upon binding floating IP addresses, arp
messages will be sent to ensure that the arp caches on the compute hosts are
up-to-date.
@ -557,8 +557,8 @@ Related options:
send_arp_for_ha_count
"""),
cfg.IntOpt("send_arp_for_ha_count",
default=3,
help="""
default=3,
help="""
When arp messages are configured to be sent, they will be sent with the count
set to the value of this option. Of course, if this is set to zero, no arp
messages will be sent.
@ -572,14 +572,14 @@ Related options:
send_arp_for_ha
"""),
cfg.BoolOpt("use_single_default_gateway",
default=False,
help="""
default=False,
help="""
When set to True, only the firt nic of a VM will get its default gateway from
the DHCP server.
"""),
cfg.MultiStrOpt("forward_bridge_interface",
default=["all"],
help="""
default=["all"],
help="""
One or more interfaces that bridges can forward traffic to. If any of the items
in this list is the special keyword 'all', then all traffic will be forwarded.
@ -588,8 +588,8 @@ Possible values:
A list of zero or more interface names, or the word 'all'.
"""),
cfg.StrOpt("metadata_host",
default="$my_ip",
help="""
default="$my_ip",
help="""
This option determines the IP address for the network metadata API server.
Possible values:
@ -601,8 +601,8 @@ Related options:
* metadata_port
"""),
cfg.PortOpt("metadata_port",
default=8775,
help="""
default=8775,
help="""
This option determines the port used for the metadata API server.
Related options:
@ -610,8 +610,8 @@ Related options:
* metadata_host
"""),
cfg.StrOpt("iptables_top_regex",
default="",
help="""
default="",
help="""
This expression, if defined, will select any matching iptables rules and place
them at the top when applying metadata changes to the rules.
@ -624,8 +624,8 @@ Related options:
* iptables_bottom_regex
"""),
cfg.StrOpt("iptables_bottom_regex",
default="",
help="""
default="",
help="""
This expression, if defined, will select any matching iptables rules and place
them at the bottom when applying metadata changes to the rules.
@ -638,8 +638,8 @@ Related options:
* iptables_top_regex
"""),
cfg.StrOpt("iptables_drop_action",
default="DROP",
help="""
default="DROP",
help="""
By default, packets that do not pass the firewall are DROPped. In many cases,
though, an operator may find it more useful to change this from DROP to REJECT,
so that the user issuing those packets may have a better idea as to what's
@ -650,9 +650,9 @@ Possible values:
* A string representing an iptables chain. The default is DROP.
"""),
cfg.IntOpt("ovs_vsctl_timeout",
default=120,
min=0,
help="""
default=120,
min=0,
help="""
This option represents the period of time, in seconds, that the ovs_vsctl calls
will wait for a response from the database before timing out. A setting of 0
means that the utility should wait forever for a response.
@ -663,15 +663,15 @@ Possible values:
calls should wait forever for a response.
"""),
cfg.BoolOpt("fake_network",
default=False,
help="""
default=False,
help="""
This option is used mainly in testing to avoid calls to the underlying network
utilities.
"""),
cfg.IntOpt("ebtables_exec_attempts",
default=3,
min=1,
help="""
default=3,
min=1,
help="""
This option determines the number of times to retry ebtables commands before
giving up. The minimum number of retries is 1.
@ -684,8 +684,8 @@ Related options:
* ebtables_retry_interval
"""),
cfg.FloatOpt("ebtables_retry_interval",
default=1.0,
help="""
default=1.0,
help="""
This option determines the time, in seconds, that the system will sleep in
between ebtables retries. Note that each successive retry waits a multiple of
this value, so for example, if this is set to the default of 1.0 seconds, and
@ -707,63 +707,63 @@ Related options:
ldap_dns_opts = [
cfg.StrOpt('ldap_dns_url',
default='ldap://ldap.example.com:389',
help='URL for LDAP server which will store DNS entries'),
default='ldap://ldap.example.com:389',
help='URL for LDAP server which will store DNS entries'),
cfg.StrOpt('ldap_dns_user',
default='uid=admin,ou=people,dc=example,dc=org',
help='User for LDAP DNS'),
default='uid=admin,ou=people,dc=example,dc=org',
help='User for LDAP DNS'),
cfg.StrOpt('ldap_dns_password',
default='password',
help='Password for LDAP DNS',
secret=True),
default='password',
help='Password for LDAP DNS',
secret=True),
cfg.StrOpt('ldap_dns_soa_hostmaster',
default='hostmaster@example.org',
help='Hostmaster for LDAP DNS driver Statement of Authority'),
default='hostmaster@example.org',
help='Hostmaster for LDAP DNS driver Statement of Authority'),
cfg.MultiStrOpt('ldap_dns_servers',
default=['dns.example.org'],
help='DNS Servers for LDAP DNS driver'),
default=['dns.example.org'],
help='DNS Servers for LDAP DNS driver'),
cfg.StrOpt('ldap_dns_base_dn',
default='ou=hosts,dc=example,dc=org',
help='Base DN for DNS entries in LDAP'),
default='ou=hosts,dc=example,dc=org',
help='Base DN for DNS entries in LDAP'),
cfg.IntOpt('ldap_dns_soa_refresh',
default=1800,
help='Refresh interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
default=1800,
help='Refresh interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
cfg.IntOpt('ldap_dns_soa_retry',
default=3600,
help='Retry interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
default=3600,
help='Retry interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
cfg.IntOpt('ldap_dns_soa_expiry',
default=86400,
help='Expiry interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
default=86400,
help='Expiry interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
cfg.IntOpt('ldap_dns_soa_minimum',
default=7200,
help='Minimum interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
default=7200,
help='Minimum interval (in seconds) for LDAP DNS driver '
'Statement of Authority'),
]
driver_opts = [
cfg.StrOpt('network_driver',
default='nova.network.linux_net',
help='Driver to use for network creation'),
default='nova.network.linux_net',
help='Driver to use for network creation'),
]
rpcapi_opts = [
cfg.StrOpt('network_topic',
default='network',
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
default='network',
deprecated_for_removal=True,
deprecated_since='15.0.0',
deprecated_reason="""
There is no need to let users choose the RPC topic for all services - there
is little gain from this. Furthermore, it makes it really easy to break Nova
by using this option.
""",
help='The topic network nodes listen on'),
help='The topic network nodes listen on'),
cfg.BoolOpt('multi_host',
default=False,
help='Default value for multi_host in networks. Also, if set, '
'some rpc network calls will be sent directly to host.'),
default=False,
help='Default value for multi_host in networks. Also, if set, '
'some rpc network calls will be sent directly to host.'),
]
ALL_DEFAULT_OPTS = (linux_net_opts + network_opts + ldap_dns_opts