diff --git a/neutron/conf/agent/common.py b/neutron/conf/agent/common.py index eaa9572a18d..f05e57bcd17 100644 --- a/neutron/conf/agent/common.py +++ b/neutron/conf/agent/common.py @@ -39,7 +39,7 @@ PD_OPTS = [ PD_DRIVER_OPTS = [ cfg.StrOpt('pd_confs', default='$state_path/pd', - help=_('Location to store IPv6 PD files.')), + help=_('Location to store IPv6 Prefix Delegation files.')), cfg.StrOpt('vendor_pen', default='8888', help=_("A decimal value as Vendor's Registered Private " @@ -67,7 +67,8 @@ INTERFACE_OPTS = [ RA_OPTS = [ cfg.StrOpt('ra_confs', default='$state_path/ra', - help=_('Location to store IPv6 RA config files')), + help=_('Location to store IPv6 Router Advertisement config ' + 'files')), cfg.IntOpt('min_rtr_adv_interval', default=30, help=_('MinRtrAdvInterval setting for radvd.conf')), @@ -118,7 +119,7 @@ AGENT_STATE_OPTS = [ INTERFACE_DRIVER_OPTS = [ cfg.StrOpt('interface_driver', - help=_("The driver used to manage the virtual interface.")), + help=_("The driver used to manage virtual interfaces.")), ] IPTABLES_OPTS = [ @@ -144,8 +145,8 @@ PROCESS_MONITOR_OPTS = [ choices=['respawn', 'exit'], help=_('Action to be executed when a child process dies')), cfg.IntOpt('check_child_processes_interval', default=60, - help=_('Interval between checks of child process liveness ' - '(seconds), use 0 to disable')), + help=_('Interval between checks of child process liveness, ' + 'in seconds, use 0 to disable')), cfg.StrOpt('kill_scripts_path', default='/etc/neutron/kill_scripts/', help=_('Location of scripts used to kill external processes. ' 'Names of scripts here must follow the pattern: ' diff --git a/neutron/conf/agent/database/agents_db.py b/neutron/conf/agent/database/agents_db.py index aad0582bf5a..d2354a8dc14 100644 --- a/neutron/conf/agent/database/agents_db.py +++ b/neutron/conf/agent/database/agents_db.py @@ -17,7 +17,7 @@ from neutron.common import _constants AGENT_OPTS = [ cfg.IntOpt('agent_down_time', default=75, - help=_("Seconds to regard the agent is down; should be at " + help=_("Seconds to regard the agent as down; should be at " "least twice report_interval, to be sure the " "agent is down for good.")), cfg.StrOpt('dhcp_load_type', default='networks', @@ -29,7 +29,7 @@ AGENT_OPTS = [ 'extract particular load sent as part of its agent ' 'configuration object from the agent report state, ' 'which is the number of resources being consumed, at ' - 'every report_interval.' + 'every report_interval. ' 'dhcp_load_type can be used in combination with ' 'network_scheduler_driver = ' 'neutron.scheduler.dhcp_agent_scheduler.WeightScheduler ' @@ -38,15 +38,15 @@ AGENT_OPTS = [ 'choice for the resource being balanced. ' 'Example: dhcp_load_type=networks')), cfg.BoolOpt('enable_new_agents', default=True, - help=_("Agent starts with admin_state_up=False when " - "enable_new_agents=False. In the case, user's " - "resources will not be scheduled automatically to the " - "agent until admin changes admin_state_up to True.")), + help=_("Agents start with admin_state_up=False when " + "enable_new_agents=False. In this case, a user's " + "resources will not be scheduled automatically to an " + "agent until an admin sets admin_state_up to True.")), cfg.IntOpt("rpc_resources_processing_step", default=_constants.RPC_RES_PROCESSING_STEP, min=1, help=_("Number of resources for neutron to divide " - "the large RPC call data sets. It can be reduced " - "if RPC timeout occurred. The best value can be " + "a large RPC call into data sets. It can be reduced " + "if RPC timeouts occur. The best value should be " "determined empirically in your environment.")) ] diff --git a/neutron/conf/agent/database/agentschedulers_db.py b/neutron/conf/agent/database/agentschedulers_db.py index cf4f3c6cb06..f58e0b27718 100644 --- a/neutron/conf/agent/database/agentschedulers_db.py +++ b/neutron/conf/agent/database/agentschedulers_db.py @@ -20,9 +20,10 @@ AGENTS_SCHEDULER_OPTS = [ cfg.StrOpt('network_scheduler_driver', default='neutron.scheduler.' 'dhcp_agent_scheduler.WeightScheduler', - help=_('Driver to use for scheduling network to DHCP agent')), + help=_('Driver to use for scheduling networks to a DHCP ' + 'agent')), cfg.BoolOpt('network_auto_schedule', default=True, - help=_('Allow auto scheduling networks to DHCP agent.')), + help=_('Allow auto scheduling networks to a DHCP agent.')), cfg.BoolOpt('allow_automatic_dhcp_failover', default=True, help=_('Automatically remove networks from offline DHCP ' 'agents.')), @@ -32,7 +33,7 @@ AGENTS_SCHEDULER_OPTS = [ 'network. If this number is greater than 1, the ' 'scheduler automatically assigns multiple DHCP agents ' 'for a given tenant network, providing high ' - 'availability for DHCP service.')), + 'availability for the DHCP service.')), cfg.BoolOpt('enable_services_on_agents_with_admin_state_down', default=False, help=_('Enable services on an agent with admin_state_up ' diff --git a/neutron/conf/agent/dhcp.py b/neutron/conf/agent/dhcp.py index f1f63de2eb6..cab642f1d90 100644 --- a/neutron/conf/agent/dhcp.py +++ b/neutron/conf/agent/dhcp.py @@ -25,7 +25,7 @@ DHCP_AGENT_OPTS = [ cfg.IntOpt('resync_interval', default=5, help=_("The DHCP agent will resync its state with Neutron to " "recover from any transient notification or RPC errors. " - "The interval is maximum number of seconds between " + "The interval is the maximum number of seconds between " "attempts. The resync can be done more often based on " "the events triggered.")), cfg.IntOpt('resync_throttle', default=1, @@ -47,7 +47,7 @@ DHCP_AGENT_OPTS = [ "will only be activated when the subnet does not " "contain any router port. The guest instance must be " "configured to request host routes via DHCP (Option " - "121). This option doesn't have any effect when " + "121). This option does not have any effect when " "force_metadata is set to True.")), cfg.BoolOpt('force_metadata', default=False, help=_("In some cases the Neutron router is not present to " @@ -55,7 +55,7 @@ DHCP_AGENT_OPTS = [ "used to provide this info. Setting this value will " "force the DHCP server to append specific host routes " "to the DHCP request. If this option is set, then the " - "metadata service will be activated for all the " + "metadata service will be activated for all of the " "networks.")), cfg.BoolOpt('enable_metadata_network', default=False, help=_("Allows for serving metadata requests coming from a " @@ -74,8 +74,7 @@ DHCP_AGENT_OPTS = [ help=_('Time to sleep between reloading the DHCP allocations. ' 'This will only be invoked if the value is not 0. ' 'If a network has N updates in X seconds then ' - 'we will reload once with the port changes in the X ' - 'seconds and not N times.')), + 'it will reload once and not N times.')), ] DHCP_OPTS = [ diff --git a/neutron/conf/agent/l3/config.py b/neutron/conf/agent/l3/config.py index 8e5c961685a..9ddf8f03405 100644 --- a/neutron/conf/agent/l3/config.py +++ b/neutron/conf/agent/l3/config.py @@ -29,18 +29,18 @@ OPTS = [ help=_("The working mode for the agent. Allowed modes are: " "'legacy' - this preserves the existing behavior " "where the L3 agent is deployed on a centralized " - "networking node to provide L3 services like DNAT, " + "networking node to provide L3 services like DNAT " "and SNAT. Use this mode if you do not want to " "adopt DVR. 'dvr' - this mode enables DVR " "functionality and must be used for an L3 agent " "that runs on a compute host. 'dvr_snat' - this " "enables centralized SNAT support in conjunction " - "with DVR. This mode must be used for an L3 agent " + "with DVR. This mode must be used for an L3 agent " "running on a centralized node (or in single-host " "deployments, e.g. devstack). " "dvr_snat mode is not supported on a compute host. " "'dvr_no_external' - this mode enables only East/West " - "DVR routing functionality for a L3 agent that runs on " + "DVR routing functionality for an L3 agent that runs on " "a compute host, the North/South functionality such " "as DNAT and SNAT will be provided by the centralized " "network node that is running in 'dvr_snat' mode. " @@ -64,8 +64,8 @@ OPTS = [ "be used. However, an IPv6 gateway address is needed " "for use as the next-hop for the default route. " "If no IPv6 gateway address is configured here, " - "(and only then) the neutron router will be configured " - "to get its default route from router advertisements " + "(and only then) the Neutron router will be configured " + "to get its default route from Router Advertisements " "(RAs) from the upstream router; in which case the " "upstream router must also be configured to send " "these RAs. " @@ -73,14 +73,14 @@ OPTS = [ "of the interface on the upstream router. If a " "next-hop using a global unique address (GUA) is " "desired, it needs to be done via a subnet allocated " - "to the network and not through this parameter. ")), + "to the network and not through this parameter.")), cfg.StrOpt('prefix_delegation_driver', default='dibbler', - help=_('Driver used for ipv6 prefix delegation. This needs to ' + help=_('Driver used for IPv6 Prefix Delegation. This needs to ' 'be an entry point defined in the ' 'neutron.agent.linux.pd_drivers namespace. See ' - 'setup.cfg for entry points included with the neutron ' - 'source.')), + 'setup.cfg for entry points included with the Neutron ' + 'source code.')), cfg.BoolOpt('enable_metadata_proxy', default=True, help=_("Allow running metadata proxy.")), cfg.StrOpt('metadata_access_mark', @@ -90,17 +90,18 @@ OPTS = [ 'that only the lower 16 bits will be used.')), cfg.StrOpt('external_ingress_mark', default='0x2', - help=_('Iptables mangle mark used to mark ingress from ' + help=_('Iptables mangle mark used to mark ingress from an ' 'external network. This mark will be masked with ' '0xffff so that only the lower 16 bits will be used.')), cfg.StrOpt('radvd_user', default='', help=_('The username passed to radvd, used to drop root ' 'privileges and change user ID to username and group ID ' - 'to the primary group of username. If no user specified ' - '(by default), the user executing the L3 agent will be ' - 'passed. If "root" specified, because radvd is spawned ' - 'as root, no "username" parameter will be passed.')), + 'of the primary group of username. If no user specified ' + '(default), the user executing the L3 agent will be ' + 'passed. If "root" is specified, because radvd is ' + 'spawned as root, no "username" parameter will be ' + 'passed.')), cfg.BoolOpt('cleanup_on_shutdown', default=False, help=_('Delete all routers on L3 agent shutdown. For L3 HA ' 'routers it includes a shutdown of keepalived and ' diff --git a/neutron/conf/agent/metadata/config.py b/neutron/conf/agent/metadata/config.py index fb5675933c0..1cb8f87121a 100644 --- a/neutron/conf/agent/metadata/config.py +++ b/neutron/conf/agent/metadata/config.py @@ -56,19 +56,19 @@ METADATA_PROXY_HANDLER_OPTS = [ 'Instance-ID header with a shared secret to prevent ' 'spoofing. You may select any string for a secret, ' 'but it must match here and in the configuration used ' - 'by the Nova Metadata Server. NOTE: Nova uses the same ' + 'by the Nova metadata server. NOTE: Nova uses the same ' 'config key, but in [neutron] section.'), secret=True), cfg.StrOpt('nova_metadata_protocol', default='http', choices=['http', 'https'], - help=_("Protocol to access nova metadata, http or https")), + help=_("Protocol to access Nova metadata, http or https")), cfg.BoolOpt('nova_metadata_insecure', default=False, help=_("Allow to perform insecure SSL (https) requests to " - "nova metadata")), + "Nova metadata")), cfg.StrOpt('nova_client_cert', default='', - help=_("Client certificate for nova metadata api server.")), + help=_("Client certificate for Nova metadata api server.")), cfg.StrOpt('nova_client_priv_key', default='', help=_("Private key of client certificate.")) diff --git a/neutron/conf/agent/ovn/metadata/config.py b/neutron/conf/agent/ovn/metadata/config.py index 9b23b92075f..0ec3380fa8d 100644 --- a/neutron/conf/agent/ovn/metadata/config.py +++ b/neutron/conf/agent/ovn/metadata/config.py @@ -24,9 +24,9 @@ from neutron._i18n import _ OVS_OPTS = [ cfg.StrOpt('ovsdb_connection', default='unix:/usr/local/var/run/openvswitch/db.sock', - help=_('The connection string for the native OVSDB backend.\n' - 'Use tcp:IP:PORT for TCP connection.\n' - 'Use unix:FILE for unix domain socket connection.')), + help=_('The connection string for the native OVSDB backend. ' + 'Use tcp:IP:PORT for TCP connections. ' + 'Use unix:FILE for unix domain socket connections.')), cfg.IntOpt('ovsdb_connection_timeout', default=180, help=_('Timeout in seconds for the OVSDB ' diff --git a/neutron/conf/agent/ovs_conf.py b/neutron/conf/agent/ovs_conf.py index f8fa8ef2d0e..5f9c9b76792 100644 --- a/neutron/conf/agent/ovs_conf.py +++ b/neutron/conf/agent/ovs_conf.py @@ -17,14 +17,14 @@ from oslo_config import cfg from neutron._i18n import _ -# Default timeout for ovsdb commands +# Default timeout for OVSDB commands DEFAULT_OVSDB_TIMEOUT = 10 OPTS = [ cfg.IntOpt('ovsdb_timeout', default=DEFAULT_OVSDB_TIMEOUT, - help=_('Timeout in seconds for ovsdb commands. ' - 'If the timeout expires, ovsdb commands will fail with ' + help=_('Timeout in seconds for OVSDB commands. ' + 'If the timeout expires, OVSDB commands will fail with ' 'ALARMCLOCK error.')), cfg.IntOpt('bridge_mac_table_size', default=50000, @@ -38,7 +38,7 @@ OPTS = [ 'option is set to True, support for Internet Group ' 'Management Protocol (IGMP) is enabled in integration ' 'bridge. ' - 'Setting this option to True will also enable Open ' + 'Setting this option to True will also enable the Open ' 'vSwitch mcast-snooping-disable-flood-unregistered ' 'flag. This option will disable flooding of ' 'unregistered multicast packets to all ports. ' diff --git a/neutron/conf/agent/ovsdb_api.py b/neutron/conf/agent/ovsdb_api.py index 2d37dd1c6ba..4a0704d0369 100644 --- a/neutron/conf/agent/ovsdb_api.py +++ b/neutron/conf/agent/ovsdb_api.py @@ -21,7 +21,7 @@ API_OPTS = [ cfg.StrOpt('ovsdb_connection', default='tcp:127.0.0.1:6640', help=_('The connection string for the OVSDB backend. ' - 'Will be used for all ovsdb commands and ' + 'Will be used for all OVSDB commands and ' 'by ovsdb-client when monitoring' )), cfg.StrOpt('ssl_key_file', @@ -36,7 +36,7 @@ API_OPTS = [ )), cfg.StrOpt('ssl_ca_cert_file', help=_('The Certificate Authority (CA) certificate to use ' - 'when interacting with OVSDB. Required when using an ' + 'when interacting with OVSDB. Required when using an ' '"ssl:" prefixed ovsdb_connection' )), cfg.BoolOpt('ovsdb_debug', diff --git a/neutron/conf/agent/securitygroups_rpc.py b/neutron/conf/agent/securitygroups_rpc.py index 94d3e12f2e2..c20ef0d2fe9 100644 --- a/neutron/conf/agent/securitygroups_rpc.py +++ b/neutron/conf/agent/securitygroups_rpc.py @@ -30,13 +30,13 @@ security_group_opts = [ help=_( 'Controls whether the neutron security group API is enabled ' 'in the server. It should be false when using no security ' - 'groups or using the nova security group API.')), + 'groups or using the Nova security group API.')), cfg.BoolOpt( 'enable_ipset', default=True, - help=_('Use ipset to speed-up the iptables based security groups. ' - 'Enabling ipset support requires that ipset is installed on L2 ' - 'agent node.')), + help=_('Use IPsets to speed-up the iptables based security groups. ' + 'Enabling IPset support requires that ipset is installed on ' + 'the L2 agent node.')), cfg.ListOpt( 'permitted_ethertypes', default=[], diff --git a/neutron/conf/common.py b/neutron/conf/common.py index 3af648bc7b4..c820b3c5d78 100644 --- a/neutron/conf/common.py +++ b/neutron/conf/common.py @@ -32,7 +32,7 @@ core_opts = [ "For example: api_extensions_path = " "extensions:/path/to/more/exts:/even/more/exts. " "The __path__ of neutron.extensions is appended to " - "this, so if your extensions are in there you don't " + "this, so if your extensions are in there you do not " "need to specify them here.")), cfg.StrOpt('auth_strategy', default='keystone', help=_("The type of authentication to use")), @@ -49,7 +49,7 @@ core_opts = [ help=_("Allow the usage of the bulk API")), cfg.StrOpt('pagination_max_limit', default="-1", help=_("The maximum number of items returned in a single " - "response, value was 'infinite' or negative integer " + "response, value of 'infinite' or negative integer " "means no limit")), cfg.ListOpt('default_availability_zones', default=[], help=_("Default value of availability zone hints. The " @@ -101,12 +101,12 @@ core_opts = [ "is empty (the default), the URLs are returned " "unchanged.")), cfg.BoolOpt('notify_nova_on_port_status_changes', default=True, - help=_("Send notification to nova when port status changes")), + help=_("Send notification to Nova when port status changes")), cfg.BoolOpt('notify_nova_on_port_data_changes', default=True, - help=_("Send notification to nova when port data (fixed_ips/" - "floatingip) changes so nova can update its cache.")), + help=_("Send notification to Nova when port data (fixed_ips/" + "floatingip) changes so Nova can update its cache.")), cfg.IntOpt('send_events_interval', default=2, - help=_('Number of seconds between sending events to nova if ' + help=_('Number of seconds between sending events to Nova if ' 'there are any events to send.')), cfg.StrOpt('setproctitle', default='on', help=_("Set process name to match child worker role. " @@ -137,7 +137,7 @@ core_opts = [ 'overlay protocol overhead from this value. Defaults ' 'to 1500, the standard value for Ethernet.')), cfg.IntOpt('http_retries', default=3, min=0, - help=_("Number of times client connections (nova, ironic) " + help=_("Number of times client connections (Nova, Ironic) " "should be retried on a failed HTTP call. 0 (zero) " "means connection is attempted only once (not retried). " "Setting to any positive integer means that on failure " @@ -146,7 +146,7 @@ core_opts = [ "connect will be 4.")), cfg.BoolOpt('enable_traditional_dhcp', default=True, help=_('If False, neutron-server will disable the following ' - 'DHCP-agent related functions:' + 'DHCP-agent related functions: ' '1. DHCP provisioning block ' '2. DHCP scheduler API extension ' '3. Network scheduling mechanism ' @@ -171,13 +171,13 @@ NOVA_CONF_SECTION = 'nova' nova_opts = [ cfg.StrOpt('region_name', - help=_('Name of nova region to use. Useful if keystone manages' + help=_('Name of Nova region to use. Useful if Keystone manages' ' more than one region.')), cfg.StrOpt('endpoint_type', default='public', choices=['public', 'admin', 'internal'], - help=_('Type of the nova endpoint to use. This endpoint will' - ' be looked up in the keystone catalog and should be' + help=_('Type of the Nova endpoint to use. This endpoint will' + ' be looked up in the Keystone catalog and should be' ' one of public, internal or admin.')), ] @@ -190,13 +190,13 @@ PLACEMENT_CONF_SECTION = 'placement' placement_opts = [ cfg.StrOpt('region_name', - help=_('Name of placement region to use. Useful if keystone ' + help=_('Name of placement region to use. Useful if Keystone ' 'manages more than one region.')), cfg.StrOpt('endpoint_type', default='public', choices=['public', 'admin', 'internal'], help=_('Type of the placement endpoint to use. This endpoint ' - 'will be looked up in the keystone catalog and should ' + 'will be looked up in the Keystone catalog and should ' 'be one of public, internal or admin.')), ] @@ -209,7 +209,7 @@ IRONIC_CONF_SECTION = 'ironic' ironic_opts = [ cfg.BoolOpt('enable_notifications', default=False, - help=_("Send notification events to ironic. (For example on " + help=_("Send notification events to Ironic. (For example on " "relevant port status changes.)")), ] diff --git a/neutron/conf/db/dvr_mac_db.py b/neutron/conf/db/dvr_mac_db.py index ce28a979707..ec7420fefcc 100644 --- a/neutron/conf/db/dvr_mac_db.py +++ b/neutron/conf/db/dvr_mac_db.py @@ -19,15 +19,15 @@ from neutron._i18n import _ DVR_MAC_ADDRESS_OPTS = [ cfg.StrOpt('dvr_base_mac', default="fa:16:3f:00:00:00", - help=_("The base mac address used for unique " + help=_("The base MAC address used for unique " "DVR instances by Neutron. The first 3 octets will " "remain unchanged. If the 4th octet is not 00, it will " "also be used. The others will be randomly generated. " "The 'dvr_base_mac' *must* be different from " - "'base_mac' to avoid mixing them up with MAC's " - "allocated for tenant ports. A 4 octet example would be " + "'base_mac' to avoid mixing it up with MAC's " + "allocated for tenant ports. A 4-octet example would be " "dvr_base_mac = fa:16:3f:4f:00:00. The default is 3 " - "octet")), + "octets")), ] diff --git a/neutron/conf/db/l3_agentschedulers_db.py b/neutron/conf/db/l3_agentschedulers_db.py index 79f30b03a58..b3a9ec38f70 100644 --- a/neutron/conf/db/l3_agentschedulers_db.py +++ b/neutron/conf/db/l3_agentschedulers_db.py @@ -20,10 +20,10 @@ L3_AGENTS_SCHEDULER_OPTS = [ cfg.StrOpt('router_scheduler_driver', default='neutron.scheduler.l3_agent_scheduler.' 'LeastRoutersScheduler', - help=_('Driver to use for scheduling ' + help=_('Driver to use for scheduling a ' 'router to a default L3 agent')), cfg.BoolOpt('router_auto_schedule', default=True, - help=_('Allow auto scheduling of routers to L3 agent.')), + help=_('Allow auto scheduling of routers to L3 agents.')), cfg.BoolOpt('allow_automatic_l3agent_failover', default=False, help=_('Automatically reschedule routers from offline L3 ' 'agents to online L3 agents.')), diff --git a/neutron/conf/db/l3_dvr_db.py b/neutron/conf/db/l3_dvr_db.py index 5b7f7027cc4..ab7d3e77448 100644 --- a/neutron/conf/db/l3_dvr_db.py +++ b/neutron/conf/db/l3_dvr_db.py @@ -24,7 +24,7 @@ ROUTER_DISTRIBUTED_OPTS = [ cfg.BoolOpt('enable_dvr', default=True, help=_("Determine if setup is configured for DVR. If False, " - "DVR API extension will be disabled.")), + "the DVR API extension will be disabled.")), cfg.BoolOpt('host_dvr_for_dhcp', default=True, help=_("Flag to determine if hosting a DVR local router to " diff --git a/neutron/conf/db/l3_hamode_db.py b/neutron/conf/db/l3_hamode_db.py index 7d8f81c4b54..9b2257c0a88 100644 --- a/neutron/conf/db/l3_hamode_db.py +++ b/neutron/conf/db/l3_hamode_db.py @@ -28,16 +28,16 @@ L3_HA_OPTS = [ "be scheduled on every agent.")), cfg.StrOpt('l3_ha_net_cidr', default=n_const.L3_HA_NET_CIDR, - help=_('Subnet used for the l3 HA admin network.')), + help=_('Subnet used for the L3 HA admin network.')), cfg.StrOpt('l3_ha_network_type', default='', - help=_("The network type to use when creating the HA network " - "for an HA router. By default or if empty, the first " - "'tenant_network_types' is used. This is helpful when " - "the VRRP traffic should use a specific network which " - "is not the default one.")), + help=_("The network type to use when creating the L3 HA " + "network for an HA router. By default, or if empty, the " + "first 'tenant_network_types' value is used. This is " + "helpful when the VRRP traffic should use a specific " + "network which is not the default one.")), cfg.StrOpt('l3_ha_network_physical_name', default='', - help=_("The physical network name with which the HA network " - "can be created.")) + help=_("The physical network name with which the L3 HA network " + "should be created.")) ] diff --git a/neutron/conf/db/l3_ndpproxy_db.py b/neutron/conf/db/l3_ndpproxy_db.py index 4cf247b38c2..7a1d07cda63 100644 --- a/neutron/conf/db/l3_ndpproxy_db.py +++ b/neutron/conf/db/l3_ndpproxy_db.py @@ -19,7 +19,7 @@ from neutron._i18n import _ L3NDPPROXY_OPTS = [ cfg.BoolOpt('enable_ndp_proxy_by_default', default=False, help=_('Define the default value of enable_ndp_proxy if not ' - 'provided in router.')) + 'provided in the router.')) ] diff --git a/neutron/conf/extensions/conntrack_helper.py b/neutron/conf/extensions/conntrack_helper.py index 98cffaaf3f5..36b246004af 100644 --- a/neutron/conf/extensions/conntrack_helper.py +++ b/neutron/conf/extensions/conntrack_helper.py @@ -42,7 +42,7 @@ conntrack_helper_opts = [ {'sip': 'udp'} ], help=_('Defines the allowed conntrack helpers, and ' - 'conntack helper module protocol constraints.') + 'conntrack helper module protocol constraints.') ) ] diff --git a/neutron/conf/plugins/ml2/drivers/agent.py b/neutron/conf/plugins/ml2/drivers/agent.py index 15194a7f992..253dae8d8d1 100644 --- a/neutron/conf/plugins/ml2/drivers/agent.py +++ b/neutron/conf/plugins/ml2/drivers/agent.py @@ -23,9 +23,9 @@ agent_opts = [ help=_("The number of seconds the agent will wait between " "polling for local device changes.")), cfg.IntOpt('quitting_rpc_timeout', default=10, - help=_("Set new timeout in seconds for new rpc calls after " - "agent receives SIGTERM. If value is set to 0, rpc " - "timeout won't be changed")), + help=_("Set new timeout in seconds for new RPC calls after " + "agent receives SIGTERM. If value is set to 0, RPC " + "timeout will not be changed")), cfg.IntOpt('dscp', min=0, max=63, help=_("The DSCP value to use for outer headers during tunnel " "encapsulation.")), diff --git a/neutron/conf/plugins/ml2/drivers/linuxbridge.py b/neutron/conf/plugins/ml2/drivers/linuxbridge.py index 8154ed0f0bb..258d2a27b03 100644 --- a/neutron/conf/plugins/ml2/drivers/linuxbridge.py +++ b/neutron/conf/plugins/ml2/drivers/linuxbridge.py @@ -25,18 +25,18 @@ DEFAULT_TC_TBF_LATENCY = 50 # [ms] vxlan_opts = [ cfg.BoolOpt('enable_vxlan', default=True, help=_("Enable VXLAN on the agent. Can be enabled when " - "agent is managed by ml2 plugin using linuxbridge " + "agent is managed by ML2 plugin using Linux bridge " "mechanism driver")), cfg.IntOpt('ttl', - help=_("TTL for vxlan interface protocol packets.")), + help=_("TTL for VXLAN interface protocol packets.")), cfg.IntOpt('tos', deprecated_for_removal=True, - help=_("TOS for vxlan interface protocol packets. This option " - "is deprecated in favor of the dscp option in the AGENT " + help=_("TOS for VXLAN interface protocol packets. This option " + "is deprecated in favor of the DSCP option in the AGENT " "section and will be removed in a future release. " "To convert the TOS value to DSCP, divide by 4.")), cfg.StrOpt('vxlan_group', default=DEFAULT_VXLAN_GROUP, - help=_("Multicast group(s) for vxlan interface. A range of " + help=_("Multicast group(s) for VXLAN interface. A range of " "group addresses may be specified by using CIDR " "notation. Specifying a range allows different VNIs to " "use different group addresses, reducing or eliminating " @@ -59,14 +59,14 @@ vxlan_opts = [ "VXLAN communication.")), cfg.PortOpt('udp_dstport', help=_("The UDP port used for VXLAN communication. By " - "default, the Linux kernel doesn't use the IANA " + "default, the Linux kernel does not use the IANA " "assigned standard value, so if you want to use it, " "this option must be set to 4789. It is not set by " "default because of backward compatibility.")), cfg.BoolOpt('l2_population', default=False, - help=_("Extension to use alongside ml2 plugin's l2population " + help=_("Extension to use alongside ML2 plugin's l2population " "mechanism driver. It enables the plugin to populate " - "VXLAN forwarding table.")), + "the VXLAN forwarding table.")), cfg.BoolOpt('arp_responder', default=False, help=_("Enable local ARP responder which provides local " "responses instead of performing ARP broadcast into " diff --git a/neutron/conf/plugins/ml2/drivers/mech_sriov/mech_sriov_conf.py b/neutron/conf/plugins/ml2/drivers/mech_sriov/mech_sriov_conf.py index d975f864932..e46ca62fc18 100644 --- a/neutron/conf/plugins/ml2/drivers/mech_sriov/mech_sriov_conf.py +++ b/neutron/conf/plugins/ml2/drivers/mech_sriov/mech_sriov_conf.py @@ -27,7 +27,7 @@ sriov_driver_opts = [ "depend on your network interface card, on the kernel " "version of your operating system, and on other " "factors. " - "In case of sriov mechanism driver the valid " + "In the case of SRIOV mechanism drivers the valid " "VNIC types are direct, macvtap and direct-physical.")), ] diff --git a/neutron/conf/plugins/ml2/drivers/ovn/ovn_conf.py b/neutron/conf/plugins/ml2/drivers/ovn/ovn_conf.py index 0b0be8f56ae..be75c405a8d 100644 --- a/neutron/conf/plugins/ml2/drivers/ovn/ovn_conf.py +++ b/neutron/conf/plugins/ml2/drivers/ovn/ovn_conf.py @@ -37,7 +37,7 @@ ovn_opts = [ 'ovn_nb_private_key, ovn_nb_certificate and ' 'ovn_nb_ca_cert are mandatory.\n' 'Use unix:FILE for unix domain socket connection.\n' - 'Multiple connection can be specified by a comma ' + 'Multiple connections can be specified by a comma ' 'separated string. See also: ' 'https://github.com/openvswitch/ovs/blob' '/ab4d3bfbef37c31331db5a9dbe7c22eb8d5e5e5f' @@ -62,7 +62,7 @@ ovn_opts = [ 'ovn_sb_private_key, ovn_sb_certificate and ' 'ovn_sb_ca_cert are mandatory.\n' 'Use unix:FILE for unix domain socket connection.\n' - 'Multiple connection can be specified by a comma ' + 'Multiple connections can be specified by a comma ' 'separated string. See also: ' 'https://github.com/openvswitch/ovs/blob' '/ab4d3bfbef37c31331db5a9dbe7c22eb8d5e5e5f' @@ -81,16 +81,16 @@ ovn_opts = [ ' verify certificates presented to it by SSL peers')), cfg.IntOpt('ovsdb_connection_timeout', default=180, - help=_('Timeout in seconds for the OVSDB ' + help=_('Timeout, in seconds, for the OVSDB ' 'connection transaction')), cfg.IntOpt('ovsdb_retry_max_interval', default=180, - help=_('Max interval in seconds between ' + help=_('Max interval, in seconds ,between ' 'each retry to get the OVN NB and SB IDLs')), cfg.IntOpt('ovsdb_probe_interval', min=0, default=60000, - help=_('The probe interval in for the OVSDB session in ' + help=_('The probe interval for the OVSDB session, in ' 'milliseconds. If this is zero, it disables the ' 'connection keepalive feature. If non-zero the value ' 'will be forced to at least 1000 milliseconds. Defaults ' @@ -105,7 +105,7 @@ ovn_opts = [ 'check to see if OVN is in sync with ' 'the Neutron database. ' ' Log warnings for any inconsistencies found so' - ' that an admin can investigate \n' + ' that an admin can investigate\n' 'repair - during neutron-server startup, automatically' ' create resources found in Neutron but not in OVN.' ' Also remove resources from OVN' @@ -126,9 +126,9 @@ ovn_opts = [ default='leastloaded', choices=('leastloaded', 'chance'), help=_('The OVN L3 Scheduler type used to schedule router ' - 'gateway ports on hypervisors/chassis. \n' + 'gateway ports on hypervisors/chassis.\n' 'leastloaded - chassis with fewest gateway ports ' - 'selected \n' + 'selected\n' 'chance - chassis randomly selected')), cfg.BoolOpt('enable_distributed_floating_ip', default=False, @@ -152,8 +152,8 @@ ovn_opts = [ portbindings.VIF_TYPE_VHOST_USER]), cfg.StrOpt("vhost_sock_dir", default="/var/run/openvswitch", - help=_("The directory in which vhost virtio socket " - "is created by all the vswitch daemons")), + help=_("The directory in which vhost virtio sockets " + "are created by all the vswitch daemons")), cfg.IntOpt('dhcp_default_lease_time', default=(12 * 60 * 60), help=_('Default least time (in seconds) to use with ' @@ -170,7 +170,7 @@ ovn_opts = [ help=_("Comma-separated list of the DNS servers which will be " "used as forwarders if a subnet's dns_nameservers " "field is empty. If both subnet's dns_nameservers and " - "this option is empty, then the DNS resolvers on the " + "this option are empty, then the DNS resolvers on the " "host running the neutron server will be used.")), cfg.DictOpt('ovn_dhcp4_global_options', default={}, @@ -190,21 +190,16 @@ ovn_opts = [ help=_("Dictionary of global DHCPv6 options which will be " "automatically set on each subnet upon creation and " "on all existing subnets when Neutron starts.\n" - "An empty value for a DHCP option will cause that " + "An empty value for a DHCPv6 option will cause that " "option to be unset globally.\n" - "EXAMPLES:\n" - "- ntp_server:1.2.3.4,wpad:1.2.3.5 - Set ntp_server " - "and wpad\n" - "- ntp_server:,wpad:1.2.3.5 - Unset ntp_server and " - "set wpad\n" "See the ovn-nb(5) man page for available options.")), cfg.BoolOpt('ovn_emit_need_to_frag', default=False, help=_('Configure OVN to emit "need to frag" packets in ' - 'case of MTU mismatch.\n' - 'Before enabling this configuration make sure that ' - 'its supported by the host kernel (version >= 5.2) ' - 'or by checking the output of the following command: \n' + 'case of MTU mismatches.\n' + 'Before enabling this option make sure that ' + 'it is supported by the host kernel (version >= 5.2) ' + 'or by checking the output of the following command:\n' 'ovs-appctl -t ovs-vswitchd dpif/show-dp-features ' 'br-int | grep "Check pkt length action".')), cfg.BoolOpt('disable_ovn_dhcp_for_baremetal_ports', @@ -219,7 +214,7 @@ ovn_opts = [ deprecated_since="2023.1", help=_('If OVN older than 21.06 is used together with ' 'Neutron, this option should be set to ``False`` in ' - 'order to disable ``stateful-security-group`` API ' + 'order to disable the ``stateful-security-group`` API ' 'extension as ``allow-stateless`` keyword is only ' 'supported by OVN >= 21.06.')), ] diff --git a/neutron/conf/plugins/ml2/drivers/ovs_conf.py b/neutron/conf/plugins/ml2/drivers/ovs_conf.py index f6bc332f509..7bd43dc52dc 100644 --- a/neutron/conf/plugins/ml2/drivers/ovs_conf.py +++ b/neutron/conf/plugins/ml2/drivers/ovs_conf.py @@ -185,12 +185,12 @@ ovs_opts = [ agent_opts = [ cfg.BoolOpt('minimize_polling', default=True, - help=_("Minimize polling by monitoring ovsdb for interface " + help=_("Minimize polling by monitoring OVSDB for interface " "changes.")), cfg.IntOpt('ovsdb_monitor_respawn_interval', default=ovs_constants.DEFAULT_OVSDBMON_RESPAWN, help=_("The number of seconds to wait before respawning the " - "ovsdb monitor after losing communication with it.")), + "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).")), @@ -216,7 +216,7 @@ agent_opts = [ "in the agent, regardless of the setting in the config " "file.")), cfg.BoolOpt('dont_fragment', default=True, - help=_("Set or un-set the don't fragment (DF) bit on " + help=_("Set or un-set the do not 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.")), @@ -245,12 +245,12 @@ dhcp_opts = [ local_ip_opts = [ cfg.BoolOpt('static_nat', default=False, - help=_("When set to True, the Local IP openvswitch agent " + help=_("When set to True, the Local IP Openvswitch agent " "extension will use static NAT rules instead of using " "conntrack. This allows to use feature in OVS offload " "and DPDK scenarios at the cost of number and " - "complexity of flows. This also allows to use feature " - "together with ovs firewall.")), + "complexity of flows. This also allows using this " + "feature together with the OVS firewall.")), ] diff --git a/neutron/conf/quota.py b/neutron/conf/quota.py index 4a124e93b90..562fdd7b17d 100644 --- a/neutron/conf/quota.py +++ b/neutron/conf/quota.py @@ -44,7 +44,7 @@ DEFAULT_QUOTA_RBAC = 10 core_quota_opts = [ cfg.IntOpt('default_quota', default=DEFAULT_QUOTA, - help=_('Default number of resource allowed per tenant. ' + help=_('Default number of resources allowed per tenant. ' 'A negative value means unlimited.')), cfg.IntOpt('quota_network', default=DEFAULT_QUOTA_NETWORK, @@ -63,9 +63,15 @@ core_quota_opts = [ help=_('Default driver to use for quota checks.')), cfg.BoolOpt('track_quota_usage', default=True, - help=_('Keep in track in the database of current resource ' - 'quota usage. Plugins which do not leverage the ' - 'neutron database should set this flag to False.')), + help=_('When set to True, quota usage will be tracked in the ' + 'Neutron database for each resource, by directly ' + 'mapping to a data model class, for example, ' + 'networks, subnets, ports, etc. ' + 'When set to False, quota usage will be tracked by ' + 'the quota engine as a count of the object type ' + 'directly. ' + 'For more information, see the Quota Management ' + 'and Enforcement guide.')), ] # security_group_quota_opts from neutron/extensions/securitygroup.py @@ -76,7 +82,7 @@ security_group_quota_opts = [ 'A negative value means unlimited.')), cfg.IntOpt('quota_security_group_rule', default=DEFAULT_QUOTA_SG_RULE, - help=_('Number of security rules allowed per tenant. ' + help=_('Number of security group rules allowed per tenant. ' 'A negative value means unlimited.')), ] diff --git a/neutron/conf/service.py b/neutron/conf/service.py index 058b88d1bc9..1c2be2b397d 100644 --- a/neutron/conf/service.py +++ b/neutron/conf/service.py @@ -34,7 +34,7 @@ SERVICE_OPTS = [ 'number of API workers.')), cfg.IntOpt('rpc_state_report_workers', default=1, - help=_('Number of RPC worker processes dedicated to state ' + help=_('Number of RPC worker processes dedicated to the state ' 'reports queue.')), cfg.IntOpt('periodic_fuzzy_delay', default=5, diff --git a/neutron/conf/services/extdns_designate_driver.py b/neutron/conf/services/extdns_designate_driver.py index 80448533b0b..093fcc597e6 100644 --- a/neutron/conf/services/extdns_designate_driver.py +++ b/neutron/conf/services/extdns_designate_driver.py @@ -61,13 +61,13 @@ designate_opts = [ help=_('Allow the creation of PTR records')), cfg.IntOpt( 'ipv4_ptr_zone_prefix_size', default=24, - help=_('Number of bits in an ipv4 PTR zone that will be considered ' + help=_('Number of bits in an IPv4 PTR zone that will be considered ' 'network prefix. It has to align to byte boundary. Minimum ' 'value is 8. Maximum value is 24. As a consequence, range ' 'of values is 8, 16 and 24')), cfg.IntOpt( 'ipv6_ptr_zone_prefix_size', default=120, - help=_('Number of bits in an ipv6 PTR zone that will be considered ' + help=_('Number of bits in an IPv6 PTR zone that will be considered ' 'network prefix. It has to align to nyble boundary. Minimum ' 'value is 4. Maximum value is 124. As a consequence, range ' 'of values is 4, 8, 12, 16,..., 124')),