Skip to content

Commit 6b5efd4

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

File tree

4 files changed

+46
-42
lines changed

4 files changed

+46
-42
lines changed

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

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ include::snip_no-nvme.adoc[]
1616

1717
[NOTE]
1818
====
19-
To migrate virtual machines (VMs) that have shared disks, see xref:mtv-shared-disks_{context}[Migrating virtual machines with shared disks].
19+
To migrate virtual machines (VMs) that have shared disks, see xref:mtv-shared-disks_{context}[Migrating virtual machines with shared disks].
2020
====
2121

2222
endif::[]
@@ -400,7 +400,7 @@ spec:
400400
namespace: <namespace>
401401
EOF
402402
----
403-
<1> Allowed values are `pod`, `multus`, and `ignored`. Use `ignored` to avoid attaching VMs to this network for this migration.
403+
<1> Allowed values are `pod`, `multus`, and `ignored`. Use `ignored` to avoid attaching VMs to this network for this migration.
404404
<2> You can use either the `id` or the `name` parameter to specify the source network. For `id`, specify the VMware vSphere network Managed Object Reference (moRef). To retrieve the moRef, see xref:retrieving-vmware-moref_vmware[Retrieving a VMware vSphere moRef].
405405
<3> Specify a network attachment definition for each additional {virt} network.
406406
<4> Required only when `type` is `multus`. Specify the namespace of the {virt} network attachment definition.
@@ -759,11 +759,11 @@ You can use the default `hook-runner` image or specify a custom image. If you sp
759759

760760
ifdef::vmware[]
761761
[start=7]
762-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
762+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
763763
+
764-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
764+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
765765
+
766-
Configuring the IP address enables the interface to reach the configured gateway.
766+
Configuring the IP address enables the interface to reach the configured gateway.
767767
+
768768
[source,yaml,subs="attributes+"]
769769
----
@@ -774,7 +774,7 @@ metadata:
774774
name: <name_of_transfer_network>
775775
namespace: <namespace>
776776
annotations:
777-
forklift.konveyor.io/route: <IP_address>
777+
forklift.konveyor.io/route: <IP_address>
778778
----
779779

780780
. Create a `Plan` manifest for the migration:
@@ -813,7 +813,7 @@ spec:
813813
- id: <source_vm1> <14>
814814
- name: <source_vm2>
815815
networkNameTemplate: <network_interface_template_for_this_vm> <15>
816-
pvcNameTemplate: <pvc_name_template_for_this_vm> <16>
816+
pvcNameTemplate: <pvc_name_template_for_this_vm> <16>
817817
volumeNameTemplate: <volume_name_template_for_this_vm> <17>
818818
targetName: <target_name> <18>
819819
hooks: <19>
@@ -831,8 +831,7 @@ EOF
831831
<5> Specify the name of the `NetworkMap` CR.
832832
<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.
833833
<7> Specify the name of the `StorageMap` CR.
834-
<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. +
835-
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}.
834+
<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}.
836835
<9> [[callout9]]Optional. Specify a template for the network interface name for the VMs in your plan.
837836
The template follows the Go template syntax and has access to the following variables:
838837
* `.NetworkName:` If the target network is `multus`, add the name of the Multus Network Attachment Definition. Otherwise, leave this variable empty.
@@ -844,22 +843,22 @@ The template follows the Go template syntax and has access to the following vari
844843
* `"net-{{.NetworkIndex}}"`
845844
* `{{if eq .NetworkType "pod"}}pod{{else}}multus-{{.NetworkIndex}}{{end}}"`
846845
+
847-
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.
846+
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.
848847
<10> [[callout10]]Optional. Specify a template for the persistent volume claim (PVC) name for a plan.
849848
The template follows the Go template syntax and has access to the following variables:
850849
* `.VnName`: Name of the VM.
851850
* `.PlanName`: Name of the migration plan.
852851
* `.DiskIndex`: Initial volume index of the disk.
853852
* `.RootDiskIndex`: Index of the root disk.
854-
* `.Shared`: Options: `true`, for a shared volume, `false`, for a non-shared volume.
853+
* `.Shared`: Options: `true`, for a shared volume, `false`, for a non-shared volume.
855854
+
856855
*Examples*
857856
* `"{{.VmName}}-disk-{{.DiskIndex}}"`
858857
* `"{{if eq .DiskIndex .RootDiskIndex}}root{{else}}data{{end}}-{{.DiskIndex}}"`
859858
* `"{{if .Shared}}shared-{{end}}{{.VmName}}-{{.DiskIndex}}"`
860859
+
861860
<11> Optional:
862-
* When set to `true`, {project-short} adds one or more randonly generated alphanumeric characters to the name of the PVC in order to ensure all PVCs have unique names.
861+
* When set to `true`, {project-short} adds one or more randonly generated alphanumeric characters to the name of the PVC in order to ensure all PVCs have unique names.
863862
* When set to `false`, if you specify a `pvcNameTemplate`, {project-short} does not add such charchters to the name of the PVC.
864863
+
865864
include::snip_pvcNameTemplateUseGenerateName-warn.adoc[]
@@ -872,10 +871,11 @@ The template follows the Go template syntax and has access to the following vari
872871
*Examples*
873872
** `"disk-{{.VolumeIndex}}"`
874873
** `"pvc-{{.PVCName}}"`
874+
<<<<<<< HEAD
875875
<13> You can use either the `id` or the `name` parameter to specify the source VMs.
876876
<14> Specify the VMware vSphere VM moRef. To retrieve the moRef, see xref:retrieving-vmware-moref_vmware[Retrieving a VMware vSphere moRef].
877877
<15> 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].
878-
<16> 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].
878+
<16> 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].
879879
<17> Optional: Specify a volume name for the specific VM. Overrides the value set in `spec:volumeNameTemplate`. Variables and examples as in xref:callout12[callout 12].
880880
<18> Optional: {project-short} automatically generates a name for the target VM. You can override this name by using this parameter and entering a new name. The name you enter must be unique and it must be a valid Kubernetes subdomain. Otherwise, the migration fails automatically.
881881
<19> Optional: Specify up to two hooks for a VM. Each hook must run during a separate migration step.
@@ -887,11 +887,11 @@ endif::[]
887887

888888
ifdef::rhv[]
889889
[start=6]
890-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
890+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
891891
+
892-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
892+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
893893
+
894-
Configuring the IP address enables the interface to reach the configured gateway.
894+
Configuring the IP address enables the interface to reach the configured gateway.
895895
+
896896
[source,yaml,subs="attributes+"]
897897
----
@@ -902,7 +902,7 @@ metadata:
902902
name: <name_of_transfer_network>
903903
namespace: <namespace>
904904
annotations:
905-
forklift.konveyor.io/route: <IP_address>
905+
forklift.konveyor.io/route: <IP_address>
906906
----
907907

908908
. Create a `Plan` manifest for the migration:
@@ -970,11 +970,11 @@ endif::[]
970970
971971
ifdef::ova[]
972972
[start=6]
973-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
973+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
974974
+
975-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
975+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
976976
+
977-
Configuring the IP address enables the interface to reach the configured gateway.
977+
Configuring the IP address enables the interface to reach the configured gateway.
978978
+
979979
[source,yaml,subs="attributes+"]
980980
----
@@ -985,7 +985,7 @@ metadata:
985985
name: <name_of_transfer_network>
986986
namespace: <namespace>
987987
annotations:
988-
forklift.konveyor.io/route: <IP_address>
988+
forklift.konveyor.io/route: <IP_address>
989989
----
990990
991991
. Create a `Plan` manifest for the migration:
@@ -1039,11 +1039,11 @@ endif::[]
10391039
10401040
ifdef::ostack[]
10411041
[start=6]
1042-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
1042+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
10431043
+
1044-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
1044+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
10451045
+
1046-
Configuring the IP address enables the interface to reach the configured gateway.
1046+
Configuring the IP address enables the interface to reach the configured gateway.
10471047
+
10481048
[source,yaml,subs="attributes+"]
10491049
----
@@ -1054,7 +1054,7 @@ metadata:
10541054
name: <name_of_transfer_network>
10551055
namespace: <namespace>
10561056
annotations:
1057-
forklift.konveyor.io/route: <IP_address>
1057+
forklift.konveyor.io/route: <IP_address>
10581058
----
10591059
10601060
. Create a `Plan` manifest for the migration:
@@ -1108,11 +1108,11 @@ endif::[]
11081108
11091109
ifdef::cnv[]
11101110
[start=6]
1111-
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
1111+
. Enter the following command to create the network attachment definition (NAD) of the transfer network used for {project-short} migrations.
11121112
+
1113-
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
1113+
You use this definition to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically.
11141114
+
1115-
Configuring the IP address enables the interface to reach the configured gateway.
1115+
Configuring the IP address enables the interface to reach the configured gateway.
11161116
+
11171117
[source,yaml,subs="attributes+"]
11181118
----
@@ -1123,7 +1123,7 @@ metadata:
11231123
name: <name_of_transfer_network>
11241124
namespace: <namespace>
11251125
annotations:
1126-
forklift.konveyor.io/route: <IP_address>
1126+
forklift.konveyor.io/route: <IP_address>
11271127
----
11281128
11291129
. 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)