From 2ed1b25fd294d52238e36e0b32840b574d46d843 Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Tue, 3 Oct 2023 12:23:37 +0300 Subject: [PATCH] Align description of provider properties with the UI Signed-off-by: RichardHoch --- documentation/modules/adding-source-provider.adoc | 10 +++++----- documentation/modules/creating-validation-rule.adoc | 2 +- .../modules/migrating-virtual-machines-cli.adoc | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/documentation/modules/adding-source-provider.adoc b/documentation/modules/adding-source-provider.adoc index 12b048d71753..82c4f4e36659 100644 --- a/documentation/modules/adding-source-provider.adoc +++ b/documentation/modules/adding-source-provider.adoc @@ -78,7 +78,7 @@ 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. 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, `user@vsphere.local`. * *Password*: vCenter user password. @@ -100,7 +100,7 @@ ifdef::rhv[] * *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 +* *URL*: URL of the API endpoint of the {rhv-full} Manager (RHVM) on which the source VM is mounted, for example, `https://rhv-host-example.com/ovirt-engine/api` * *Username*: Username * *Password*: Password @@ -128,7 +128,7 @@ ifdef::ostack[] * *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* @@ -173,7 +173,7 @@ ifdef::cnv[] * *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. @@ -185,7 +185,7 @@ ifdef::cnv2[] * *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 index cb7db04e2df0..f5a73bc6853a 100644 --- 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:///sdk` for vSphere, `https:///ovirt-engine/api/` for {rhv-short}, or `https:///v3` for {osp}. +<2> Specify the API end point URL, for example, `https:///sdk` for vSphere, `https:///ovirt-engine/api` for {rhv-short}, or `https:///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 index e685e3d7b907..7f86248575e0 100644 --- 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:///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 ``. -<11> Specify the API end point URL, for example, `https:///sdk` for vSphere, `https:///ovirt-engine/api/` for {rhv-short}, or `https:///v3` for {osp}. +<11> Specify the API end point URL, for example, `https:///sdk` for vSphere, `https:///ovirt-engine/api` for {rhv-short}, or `https:///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:///sdk` for vSphere, `https:///ovirt-engine/api/` for {rhv-short}, or `https:///v3` for {osp}. +<2> Specify the API end point URL, for example, `https:///sdk` for vSphere, `https:///ovirt-engine/api` for {rhv-short}, or `https:///v3` for {osp}. <3> VMware only: Specify the VDDK image that you created. <4> Specify the name of provider `Secret` CR.