Provide details for configure multiple DHCP agents

The help text is not that good for operation. This fix adds more
information about the option 'dhcp_agents_per_network'.

Change-Id: I955c1e9989a9c65b0ffdbbdca9113c795ec72fe6
Closes-Bug: #1370934

diff --git a/etc/neutron.conf b/etc/neutron.conf
index 5d8640f90ea275b14008e1604e5bd73b3edcb9ba..35e2a74014dccc93218a96ff13b7743d1fb0b365 100644 (file)
--- a/etc/neutron.conf
+++ b/etc/neutron.conf
@@ -215,8 +215,10 @@
 # Networks could then be rescheduled if network_auto_schedule is True
 # allow_automatic_dhcp_failover = True
 
-# Number of DHCP agents scheduled to host a network. This enables redundant
-# DHCP agents for configured networks.
+# Number of DHCP agents scheduled to host a tenant 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.
 # dhcp_agents_per_network = 1
 
 # Enable services on agents with admin_state_up False.

diff --git a/neutron/db/agentschedulers_db.py b/neutron/db/agentschedulers_db.py
index 39cb3eddd4852d60bbab974ccb4f4e8913f3a558..45cbe417e30eb4191fa42c98d47c011c5f2c7d9f 100644 (file)
--- a/neutron/db/agentschedulers_db.py
+++ b/neutron/db/agentschedulers_db.py
@@ -48,7 +48,11 @@ AGENTS_SCHEDULER_OPTS = [
                 help=_('Automatically remove networks from offline DHCP '
                        'agents.')),
     cfg.IntOpt('dhcp_agents_per_network', default=1,
-               help=_('Number of DHCP agents scheduled to host a network.')),
+               help=_('Number of DHCP agents scheduled to host a tenant '
+                      '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.')),
     cfg.BoolOpt('enable_services_on_agents_with_admin_state_down',
                 default=False,
                 help=_('Enable services on an agent with admin_state_up '