Skip to content

Commit 78345a5

Browse files
committed
MTV-2381: DITA does not support forced line breaks in text
Signed-off-by: A.Arnold <[email protected]>
1 parent 05f7a02 commit 78345a5

File tree

4 files changed

+42
-39
lines changed

4 files changed

+42
-39
lines changed

documentation/modules/new-migrating-virtual-machines-cli.adoc

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can migrate from a VMware vSphere source provider by using the command-line
1212

1313
[NOTE]
1414
====
15-
To migrate virtual machines (VMs) that have shared disks, see xref:mtv-shared-disks_{context}[Migrating virtual machines with shared disks].
15+
To migrate virtual machines (VMs) that have shared disks, see xref:mtv-shared-disks_{context}[Migrating virtual machines with shared disks].
1616
====
1717

1818
endif::[]
@@ -755,11 +755,11 @@ You can use the default `hook-runner` image or specify a custom image. If you sp
755755

756756
ifdef::vmware[]
757757
[start=7]
758-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
758+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
759759
+
760-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
760+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
761761
+
762-
Configuring the IP address enables the interface to reach the configured gateway.
762+
Configuring the IP address enables the interface to reach the configured gateway.
763763
+
764764
[source,yaml,subs="attributes+"]
765765
----
@@ -770,7 +770,7 @@ metadata:
770770
name: <name_of_transfer_network>
771771
namespace: <namespace>
772772
annotations:
773-
forklift.konveyor.io/route: <IP_address>
773+
forklift.konveyor.io/route: <IP_address>
774774
----
775775

776776
. Create a `Plan` manifest for the migration:
@@ -808,7 +808,7 @@ spec:
808808
- id: <source_vm1> <13>
809809
- name: <source_vm2>
810810
networkNameTemplate: <network_interface_template_for_this_vm> <14>
811-
pvcNameTemplate: <pvc_name_template_for_this_vm> <15>
811+
pvcNameTemplate: <pvc_name_template_for_this_vm> <15>
812812
volumeNameTemplate: <volume_name_template_for_this_vm> <16>
813813
hooks: <17>
814814
- hook:
@@ -825,8 +825,7 @@ EOF
825825
<5> Specify the name of the `NetworkMap` CR.
826826
<6> Specify a storage mapping even if the VMs to be migrated are not assigned with disk images. The mapping can be empty in this case.
827827
<7> Specify the name of the `StorageMap` CR.
828-
<8> By default, virtual network interface controllers (vNICs) change during the migration process. As a result, vNICs that are configured with a static IP address linked to the interface name in the guest VM lose their IP address. +
829-
To avoid this, set `preserveStaticIPs` to `true`. {project-short} issues a warning message about any VMs for which vNIC properties are missing. To retrieve any missing vNIC properties, run those VMs in vSphere in order for the vNIC properties to be reported to {project-short}.
828+
<8> By default, virtual network interface controllers (vNICs) change during the migration process. As a result, vNICs that are configured with a static IP address linked to the interface name in the guest VM lose their IP address. To avoid this, set `preserveStaticIPs` to `true`. {project-short} issues a warning message about any VMs for which vNIC properties are missing. To retrieve any missing vNIC properties, run those VMs in vSphere in order for the vNIC properties to be reported to {project-short}.
830829
<9> [[callout9]]Optional. Specify a template for the network interface name for the VMs in your plan.
831830
The template follows the Go template syntax and has access to the following variables:
832831
* `.NetworkName:` If the target network is `multus`, add the name of the Multus Network Attachment Definition. Otherwise, leave this variable empty.
@@ -838,7 +837,7 @@ The template follows the Go template syntax and has access to the following vari
838837
* `"net-{{.NetworkIndex}}"`
839838
* `{{if eq .NetworkType "pod"}}pod{{else}}multus-{{.NetworkIndex}}{{end}}"`
840839
+
841-
Variable names cannot exceed 63 characters. This rule applies to a network name network template, a PVC name template, a VM name template, and a volume name template.
840+
Variable names cannot exceed 63 characters. This rule applies to a network name network template, a PVC name template, a VM name template, and a volume name template.
842841
<10> [[callout10]]Optional. Specify a template for the persistent volume claim (PVC) name for a plan.
843842
The template follows the Go template syntax and has access to the following variables:
844843
* `.VnName`: Name of the VM.
@@ -861,7 +860,7 @@ The template follows the Go template syntax and has access to the following vari
861860
<12> You can use either the `id` or the `name` parameter to specify the source VMs.
862861
<13> Specify the VMware vSphere VM moRef. To retrieve the moRef, see xref:retrieving-vmware-moref_vmware[Retrieving a VMware vSphere moRef].
863862
<14> Optional. Specify a network interface name for the specific VM. Overrides the value set in `spec:networkNameTemplate`. Variables and examples as in xref:callout9[callout 9].
864-
<15> Optional. Specify a PVC name for the specific VM. Overrides the value set in `spec:pvcNameTemplate`. Variables and examples as in xref:callout10[callout 10].
863+
<15> Optional. Specify a PVC name for the specific VM. Overrides the value set in `spec:pvcNameTemplate`. Variables and examples as in xref:callout10[callout 10].
865864
<16> Optional. Specify a volume name for the specific VM. Overrides the value set in `spec:volumeNameTemplate`. Variables and examples as in xref:callout11[callout 11].
866865
<17> Optional: You can specify up to two hooks for a VM. Each hook must run during a separate migration step.
867866
<18> Specify the name of the `Hook` CR.
@@ -872,11 +871,11 @@ endif::[]
872871

873872
ifdef::rhv[]
874873
[start=6]
875-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
874+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
876875
+
877-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
876+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
878877
+
879-
Configuring the IP address enables the interface to reach the configured gateway.
878+
Configuring the IP address enables the interface to reach the configured gateway.
880879
+
881880
[source,yaml,subs="attributes+"]
882881
----
@@ -887,7 +886,7 @@ metadata:
887886
name: <name_of_transfer_network>
888887
namespace: <namespace>
889888
annotations:
890-
forklift.konveyor.io/route: <IP_address>
889+
forklift.konveyor.io/route: <IP_address>
891890
----
892891

893892
. Create a `Plan` manifest for the migration:
@@ -955,11 +954,11 @@ endif::[]
955954
956955
ifdef::ova[]
957956
[start=6]
958-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
957+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
959958
+
960-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
959+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
961960
+
962-
Configuring the IP address enables the interface to reach the configured gateway.
961+
Configuring the IP address enables the interface to reach the configured gateway.
963962
+
964963
[source,yaml,subs="attributes+"]
965964
----
@@ -970,7 +969,7 @@ metadata:
970969
name: <name_of_transfer_network>
971970
namespace: <namespace>
972971
annotations:
973-
forklift.konveyor.io/route: <IP_address>
972+
forklift.konveyor.io/route: <IP_address>
974973
----
975974
976975
. Create a `Plan` manifest for the migration:
@@ -1024,11 +1023,11 @@ endif::[]
10241023
10251024
ifdef::ostack[]
10261025
[start=6]
1027-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
1026+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
10281027
+
1029-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
1028+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
10301029
+
1031-
Configuring the IP address enables the interface to reach the configured gateway.
1030+
Configuring the IP address enables the interface to reach the configured gateway.
10321031
+
10331032
[source,yaml,subs="attributes+"]
10341033
----
@@ -1039,7 +1038,7 @@ metadata:
10391038
name: <name_of_transfer_network>
10401039
namespace: <namespace>
10411040
annotations:
1042-
forklift.konveyor.io/route: <IP_address>
1041+
forklift.konveyor.io/route: <IP_address>
10431042
----
10441043
10451044
. Create a `Plan` manifest for the migration:
@@ -1093,11 +1092,11 @@ endif::[]
10931092
10941093
ifdef::cnv[]
10951094
[start=6]
1096-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
1095+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
10971096
+
1098-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
1097+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
10991098
+
1100-
Configuring the IP address enables the interface to reach the configured gateway.
1099+
Configuring the IP address enables the interface to reach the configured gateway.
11011100
+
11021101
[source,yaml,subs="attributes+"]
11031102
----
@@ -1108,7 +1107,7 @@ metadata:
11081107
name: <name_of_transfer_network>
11091108
namespace: <namespace>
11101109
annotations:
1111-
forklift.konveyor.io/route: <IP_address>
1110+
forklift.konveyor.io/route: <IP_address>
11121111
----
11131112
11141113
. Create a `Plan` manifest for the migration:

documentation/modules/ova-prerequisites.adoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,20 @@ The filename of each compressed package *must* have the `.ova` extension. Severa
2323
+
2424
When this structure is used, {project-short} scans the root folder and the first-level subfolders for compressed packages.
2525
+
26-
For example, if the NFS share is, `/nfs`, then: +
27-
The folder `/nfs` is scanned. +
28-
The folder `/nfs/subfolder1` is scanned. +
29-
But, `/nfs/subfolder1/subfolder2` is not scanned.
26+
For example, if the NFS share is, `/nfs`, then:
27+
28+
*** The folder `/nfs` is scanned.
29+
*** The folder `/nfs/subfolder1` is scanned.
30+
*** The folder `/nfs/subfolder1/subfolder2` is not scanned.
3031
3132
** In extracted OVF packages.
3233
+
3334
When this structure is used, {project-short} scans the root folder, first-level subfolders, and second-level subfolders for extracted OVF packages.
3435
However, there can be only one `.ovf` file in a folder. Otherwise, the migration will fail.
3536
+
36-
For example, if the NFS share is, `/nfs`, then: +
37-
The OVF file `/nfs/vm.ovf` is scanned. +
38-
The OVF file `/nfs/subfolder1/vm.ovf` is scanned. +
39-
The OVF file `/nfs/subfolder1/subfolder2/vm.ovf` is scanned. +
40-
But, the OVF file `/nfs/subfolder1/subfolder2/subfolder3/vm.ovf` is not scanned.
37+
For example, if the NFS share is, `/nfs`, then:
38+
39+
*** The OVF file `/nfs/vm.ovf` is scanned.
40+
*** The OVF file `/nfs/subfolder1/vm.ovf` is scanned.
41+
*** The OVF file `/nfs/subfolder1/subfolder2/vm.ovf` is scanned.
42+
*** The OVF file `/nfs/subfolder1/subfolder2/subfolder3/vm.ovf` is not scanned.

documentation/modules/rn-2.4.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ VM with multiple disks that was migrated might not be able to boot on the target
119119

120120
.Non-supported guest operating systems in warm migrations
121121

122-
Warm migrations and migrations to remote OCP clusters from vSphere do not support all types of guest operating systems that are supported in cold migrations to the local OCP cluster. It is a consequence of using RHEL 8 in the former case and RHEL 9 in the latter case. +
122+
Warm migrations and migrations to remote OCP clusters from vSphere do not support all types of guest operating systems that are supported in cold migrations to the local OCP cluster. It is a consequence of using RHEL 8 in the former case and RHEL 9 in the latter case.
123+
123124
See link:https://access.redhat.com/articles/1351473[Converting virtual machines from other hypervisors to KVM with virt-v2v in RHEL 7, RHEL 8, and RHEL 9] for the list of supported guest operating systems.
124125

125126
.VMs from vSphere with RHEL 9 guest operating system may start with network interfaces that are down

documentation/modules/rn-2.5.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The old UI of {project-short} 2.3 cannot be enabled by setting `feature_ui: true
3838

3939
.Support deployment on {ocp-name} 4.15
4040

41-
{project-short} 2.5.6 can be deployed on {ocp-name} 4.15 clusters.
41+
{project-short} 2.5.6 can be deployed on {ocp-name} 4.15 clusters.
4242

4343

4444
[id="new-features-and-enhancements-25_{context}"]
@@ -115,7 +115,8 @@ When migrating a VM with multiple disks to more than one storage classes of type
115115

116116
.Non-supported guest operating systems in warm migrations
117117

118-
Warm migrations and migrations to remote {ocp} clusters from vSphere do not support all types of guest operating systems that are supported in cold migrations to the local {ocp} cluster. This is a consequence of using RHEL 8 in the former case and RHEL 9 in the latter case. +
118+
Warm migrations and migrations to remote {ocp} clusters from vSphere do not support all types of guest operating systems that are supported in cold migrations to the local {ocp} cluster. This is a consequence of using RHEL 8 in the former case and RHEL 9 in the latter case.
119+
119120
See link:https://access.redhat.com/articles/1351473[Converting virtual machines from other hypervisors to KVM with virt-v2v in RHEL 7, RHEL 8, and RHEL 9] for the list of supported guest operating systems.
120121

121122
.VMs from vSphere with RHEL 9 guest operating system can start with network interfaces that are down
@@ -295,7 +296,7 @@ This issue is resolved in {project-short} {project-version}, VM with multiple di
295296

296297
In {project-short} releases 2.4.0-2.5.3, cold migrations from vSphere to the local cluster on which {project-short} was deployed did not take a specified transfer network into account. This issue is resolved in {project-short} 2.5.4. link:https://issues.redhat.com/browse/MTV-846[(MTV-846)]
297298

298-
.Fix migration of VMs with multi-boot guest operating system from vSphere
299+
.Fix migration of VMs with multi-boot guest operating system from vSphere
299300

300301
In {project-short} 2.5.6, the virt-v2v arguments include `–root first`, which mitigates an issue with multi-boot VMs where the pod fails. This is a fix for a regression that was introduced in {project-short} 2.4, in which the '--root' argument was dropped. link:https://issues.redhat.com/browse/MTV-987[(MTV-987)]
301302

0 commit comments

Comments
 (0)