Skip to content

Commit b6e9023

Browse files
committed
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
1 parent 057891a commit b6e9023

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

nova/conf/libvirt.py

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@
241241
"""),
242242
cfg.StrOpt('live_migration_scheme',
243243
help="""
244-
URI scheme used for live migration.
244+
URI scheme for live migration used by the source of live migration traffic.
245245
246246
Override the default libvirt live migration scheme (which is dependent on
247247
virt_type). If this option is set to None, nova will automatically choose a
@@ -257,7 +257,11 @@
257257
"""),
258258
cfg.HostAddressOpt('live_migration_inbound_addr',
259259
help="""
260-
Target used for live migration traffic.
260+
IP address used as the live migration address for this host.
261+
262+
This option indicates the IP address which should be used as the target for
263+
live migration traffic when migrating to this hypervisor. This metadata is then
264+
used by the source of the live migration traffic to construct a migration URI.
261265
262266
If this option is set to None, the hostname of the migration target compute
263267
node will be used.
@@ -266,11 +270,6 @@
266270
impact the network plane significantly. A separate network for live-migration
267271
traffic can then use this config option and avoids the impact on the
268272
management network.
269-
270-
Related options:
271-
272-
* ``live_migration_tunnelled``: The live_migration_inbound_addr value is
273-
ignored if tunneling is enabled.
274273
"""),
275274
cfg.StrOpt('live_migration_uri',
276275
deprecated_for_removal=True,
@@ -281,11 +280,11 @@
281280
and ``live_migration_inbound_addr`` respectively.
282281
""",
283282
help="""
284-
Live migration target URI to use.
283+
Live migration target URI used by the source of live migration traffic.
285284
286285
Override the default libvirt live migration target URI (which is dependent
287286
on virt_type). Any included "%s" is replaced with the migration target
288-
hostname.
287+
hostname, or `live_migration_inbound_addr` if set.
289288
290289
If this option is set to None (which is the default), Nova will automatically
291290
generate the `live_migration_uri` value based on only 4 supported `virt_type`
@@ -320,11 +319,6 @@
320319
impact performance massively.
321320
322321
Note that this option is NOT compatible with use of block migration.
323-
324-
Related options:
325-
326-
* ``live_migration_inbound_addr``: The live_migration_inbound_addr value is
327-
ignored if tunneling is enabled.
328322
"""),
329323
cfg.IntOpt('live_migration_bandwidth',
330324
default=0,

0 commit comments

Comments
 (0)