Align description of provider properties with the UI

Signed-off-by: RichardHoch <[email protected]>
kubev2v · Oct 8, 2023 · 6f88d55 · 6f88d55
1 parent 31bac02
commit 6f88d55
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 22 deletions.
diff --git a/documentation/modules/adding-source-provider.adoc b/documentation/modules/adding-source-provider.adoc
@@ -78,9 +78,9 @@ ifdef::vmware[]
 . Specify the following fields:
 
 * *Provider resource name*: Name of the source provider.
-* *URL*: vCenter host name or IP address - if a certificate for FQDN is specified, the value of this field needs to match the FQDN in the certificate.
+* *URL*: URL of the SDK endpoint of the vCenter on which the source VM is mounted. Ensure that the URL includes the `sdk` path, usually `sdk`. For example, `https://vCenter-host-example.com/sdk`. If a certificate for FQDN is specified, the value of this field needs to match the FQDN in the certificate.
 * *VDDK init image*: `VDDKInitImage` path. It is strongly recommended to create a VDDK init image to accelerate migrations. For more information, see xref:../master.adoc#creating-vddk-image_mtv[Creating a VDDK image].
-* *Username*: vCenter user, for example, `[email protected]`.
+* *Username*: vCenter user. For example, `[email protected]`.
 * *Password*: vCenter user password.
 * *SHA-1 fingerprint*: The provider currently requires the SHA-1 fingerprint of the vCenter Server's TLS certificate in all circumstances. vSphere calls this the server's thumbprint.
 +
@@ -97,12 +97,10 @@ ifdef::rhv[]
 . Click *Red Hat Virtualization*
 . Specify the following fields:
 
-* *Provider resource name*: Name of the source provider
-+
-include::snip-provider-names.adoc[]
-* *URL*: API endpoint of the {rhv-short} Manager on which the source VM is mounted
-* *Username*: Username
-* *Password*: Password
+* *Provider resource name*: Name of the source provider.
+* *URL*: URL of the API endpoint of the {rhv-full} Manager (RHVM) on which the source VM is mounted. Ensure that the URL includes the path leading to the RHVM API server, usually `ovirt-engine/api`. For example, `https://rhv-host-example.com/ovirt-engine/api`.
+* *Username*: Username.
+* *Password*: Password.
 
 . Choose one of the following options for validating CA certificates:
 
@@ -117,18 +115,14 @@ ifdef::ova[]
 . Specify the following fields:
 
 * *Provider resource name*: Name of the source provider
-+
-include::snip-provider-names.adoc[]
 * *URL*: URL of the NFS file share that serves the OVA
 endif::[]
 ifdef::ostack[]
 . Click *OpenStack*.
 . Specify the following fields:
 
 * *Provider resource name*: Name of the source provider.
-+
-include::snip-provider-names.adoc[]
-* *URL*: {osp} Identity (Keystone) endpoint, for example, `http://controller:5000/v3`.
+* *URL*: URL of the {osp} Identity (Keystone) endpoint. For example, `http://controller:5000/v3`.
 * *Authentication type*: Choose one of the following methods of authentication and supply the information related to your choice. For example, if you choose *Application credential ID* as the authentication type, the *Application credential ID* and the *Application credential secret* fields become active, and you need to supply the ID and the secret.
 
 ** *Application credential ID*
@@ -171,9 +165,7 @@ ifdef::cnv[]
 . Specify the following fields:
 
 * *Provider resource name*: Name of the source provider
-+
-include::snip-provider-names.adoc[]
-* *URL*: Endpoint of the API server
+* *URL*: URL of the endpoint of the API server
 * *Service account bearer token*: Token for a service account with `cluster-admin` privileges
 +
 If both *URL* and *Service account bearer token* are left blank, the local {ocp-short} cluster is used.
@@ -183,9 +175,7 @@ ifdef::cnv2[]
 . Specify the following fields:
 
 * *Provider resource name*: Name of the source provider
-+
-include::snip-provider-names.adoc[]
-* *URL*: Endpoint of the API server
+* *URL*: URL of the endpoint of the API server
 * *Service account bearer token*: Token for a service account with `cluster-admin` privileges
 +
 If both *URL* and *Service account bearer token* are left blank, the local {ocp-short} cluster is used.

diff --git a/documentation/modules/creating-validation-rule.adoc b/documentation/modules/creating-validation-rule.adoc
@@ -121,7 +121,7 @@ spec:
 EOF
 ----
 <1> Allowed values are `ovirt`, `vsphere`, and `openstack`.
-<2> Specify the API end point URL, for example, `https://<vCenter_host>/sdk` for vSphere, `https://<engine_host>/ovirt-engine/api/` for {rhv-short}, or `https://<identity_service>/v3` for {osp}.
+<2> Specify the API end point URL, for example, `https://<vCenter_host>/sdk` for vSphere, `https://<engine_host>/ovirt-engine/api` for {rhv-short}, or `https://<identity_service>/v3` for {osp}.
 <3> Specify the name of the provider `Secret` CR.
 
 You must update the rules version after creating a custom rule so that the `Inventory` service detects the changes and validates the VMs.
diff --git a/documentation/modules/migrating-virtual-machines-cli.adoc b/documentation/modules/migrating-virtual-machines-cli.adoc
@@ -73,7 +73,7 @@ EOF
 <8> {osp} only: Specify the project name.
 <9> {osp} only: Specify the name of the {osp} region.
 <10> {rhv-short} and {osp} only: For {rhv-short}, enter the {manager} CA certificate unless it was replaced by a third-party certificate, in which case enter the {manager} Apache CA certificate. You can retrieve the {manager} CA certificate at https://<engine_host>/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA. For {osp}, enter the CA certificate for connecting to the source environment. The certificate is not used when `insecureSkipVerify` is set to `<true>`.
-<11> Specify the API end point URL, for example, `https://<vCenter_host>/sdk` for vSphere, `https://<engine_host>/ovirt-engine/api/` for {rhv-short}, or `https://<identity_service>/v3` for {osp}.
+<11> Specify the API end point URL, for example, `https://<vCenter_host>/sdk` for vSphere, `https://<engine_host>/ovirt-engine/api` for {rhv-short}, or `https://<identity_service>/v3` for {osp}.
 <12> VMware only: Specify the vCenter SHA-1 fingerprint.
 +
 [NOTE]
@@ -110,7 +110,7 @@ spec:
 EOF
 ----
 <1> Allowed values are `ovirt`, `vsphere`, and `openstack`.
-<2> Specify the API end point URL, for example, `https://<vCenter_host>/sdk` for vSphere, `https://<engine_host>/ovirt-engine/api/` for {rhv-short}, or `https://<identity_service>/v3` for {osp}.
+<2> Specify the API end point URL, for example, `https://<vCenter_host>/sdk` for vSphere, `https://<engine_host>/ovirt-engine/api` for {rhv-short}, or `https://<identity_service>/v3` for {osp}.
 <3> VMware only: Specify the VDDK image that you created.
 <4> Specify the name of provider `Secret` CR.