From b6e9023751de396888c8547ae4c8af0f2c6e752d Mon Sep 17 00:00:00 2001 From: Andrew Bonney Date: Thu, 16 Jul 2020 15:21:40 +0100 Subject: [PATCH] Fix misleading documentation for live_migration_inbound_addr Testing on our own deployment which has 'live_migration_tunnelled' enabled has indicated that 'live_migration_inbound_addr' still works in this case, despite the documentation suggesting otherwise. Looking at the code I am lead to believe that 'live_migration_inbound_addr' is set on the migration target, and is then used by the migration source to replace the '%s' in the migration URI. Whilst the 'live_migration_uri' is ignored if both 'live_migration_tunnelled' is enabled and 'live_migration_inbound_addr' is set, the docs suggest further impact on the inbound_addr which doesn't appear to be true. This patch attempts to clarify the use of the live migration parameters. Change-Id: I5a25786413ede23c72f8ccee1ad12497da7f751c --- nova/conf/libvirt.py | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/nova/conf/libvirt.py b/nova/conf/libvirt.py index a129a4641148..dbf03c223b57 100644 --- a/nova/conf/libvirt.py +++ b/nova/conf/libvirt.py @@ -241,7 +241,7 @@ Related options: """), cfg.StrOpt('live_migration_scheme', help=""" -URI scheme used for live migration. +URI scheme for live migration used by the source of live migration traffic. Override the default libvirt live migration scheme (which is dependent on virt_type). If this option is set to None, nova will automatically choose a @@ -257,7 +257,11 @@ Related options: """), cfg.HostAddressOpt('live_migration_inbound_addr', help=""" -Target used for live migration traffic. +IP address used as the live migration address for this host. + +This option indicates the IP address which should be used as the target for +live migration traffic when migrating to this hypervisor. This metadata is then +used by the source of the live migration traffic to construct a migration URI. If this option is set to None, the hostname of the migration target compute node will be used. @@ -266,11 +270,6 @@ This option is useful in environments where the live-migration traffic can impact the network plane significantly. A separate network for live-migration traffic can then use this config option and avoids the impact on the management network. - -Related options: - -* ``live_migration_tunnelled``: The live_migration_inbound_addr value is - ignored if tunneling is enabled. """), cfg.StrOpt('live_migration_uri', deprecated_for_removal=True, @@ -281,11 +280,11 @@ allow to change live migration scheme and target URI: ``live_migration_scheme`` and ``live_migration_inbound_addr`` respectively. """, help=""" -Live migration target URI to use. +Live migration target URI used by the source of live migration traffic. Override the default libvirt live migration target URI (which is dependent on virt_type). Any included "%s" is replaced with the migration target -hostname. +hostname, or `live_migration_inbound_addr` if set. If this option is set to None (which is the default), Nova will automatically generate the `live_migration_uri` value based on only 4 supported `virt_type` @@ -320,11 +319,6 @@ encryption support in the hypervisor. Enabling this option will definitely impact performance massively. Note that this option is NOT compatible with use of block migration. - -Related options: - -* ``live_migration_inbound_addr``: The live_migration_inbound_addr value is - ignored if tunneling is enabled. """), cfg.IntOpt('live_migration_bandwidth', default=0,