Skip to content

Commit 5a8f6c3

Browse files
authored
Merge pull request #35508 from stoobie/1975622
BZ#1975622 - [OCPRHV] [Docs] "engine" and "Manager" not correctly used in OCP docs.
2 parents 6efb939 + d585386 commit 5a8f6c3

14 files changed

+24
-22
lines changed

_unused_topics/cluster-logging-exported-fields-ovirt.2021-06-04.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ Namespace for oVirt metadata.
2626
[id="exported-fields-ovirt.engine_{context}"]
2727
=== `ovirt.engine` Fields
2828

29-
Namespace for oVirt engine related metadata. The FQDN of the oVirt engine is
29+
Namespace for metadata related to the {rh-virtualization-engine-name}. The FQDN of the {rh-virtualization-engine-name} is
3030
`ovirt.engine.fqdn`

installing/installing_rhv/installing-rhv-user-infra.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ customized {product-title} cluster on {rh-virtualization-first} and other infras
1010

1111
The following diagram shows an example of a potential {product-title} cluster running on a {rh-virtualization} cluster.
1212

13-
image::92_OpenShift_Cluster_Install_RHV_0520.png[Diagram of an {product-title} cluster on a {rh-virtualization} cluster. The {rh-virtualization} hosts run virtual machines that contain both control plane and compute pods. One of the hosts also runs a {rh-virtualization} Manager/Engine virtual machine and a bootstrap virtual machine that contains a temporary control plane pod.]
13+
image::92_OpenShift_Cluster_Install_RHV_0520.png[Diagram of an {product-title} cluster on a {rh-virtualization} cluster. The {rh-virtualization} hosts run virtual machines that contain both control plane and compute pods. One of the hosts also runs a {rh-virtualization-engine-name} virtual machine and a bootstrap virtual machine that contains a temporary control plane pod.]
1414

1515
== Prerequisites
1616

modules/common-attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,11 @@ endif::[]
3232
:sandboxed-containers-operator: OpenShift sandboxed containers Operator
3333
:rh-virtualization-first: Red Hat Virtualization (RHV)
3434
:rh-virtualization: RHV
35+
:rh-virtualization-engine-name: Manager
3536
ifdef::openshift-origin[]
3637
:rh-virtualization-first: oVirt
3738
:rh-virtualization: oVirt
39+
:rh-virtualization-engine-name: Engine
3840
endif::[]
3941
:launch: image:app-launcher.png[title="Application Launcher"]
4042
:mtc-short: MTC

modules/installation-configuration-parameters.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1332,4 +1332,4 @@ ifeval::["{context}" == "installing-ibm-power"]
13321332
endif::[]
13331333
ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
13341334
:!ibm-power:
1335-
endif::[]
1335+
endif::[]

modules/installation-initializing.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ ocpadmin@internal
333333
... For `oVirt engine password`, enter the {rh-virtualization} admin password.
334334
... For `oVirt cluster`, select the cluster for installing {product-title}.
335335
... For `oVirt storage domain`, select the storage domain for installing {product-title}.
336-
... For `oVirt network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
336+
... For `oVirt network`, select a virtual network that has access to the {rh-virtualization} {rh-virtualization-engine-name} REST API.
337337
... For `Internal API Virtual IP`, enter the static IP address you set aside for the cluster's REST API.
338338
... For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain.
339339
... For `Base Domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com`
@@ -370,7 +370,7 @@ ifdef::rhv[]
370370
+
371371
[NOTE]
372372
====
373-
If you have any intermediate CA certificates on the engine, verify that the certificates appear in the `ovirt-config.yaml` file and the `install-config.yaml` file. If they do not appear, add them as follows:
373+
If you have any intermediate CA certificates on the {rh-virtualization-engine-name}, verify that the certificates appear in the `ovirt-config.yaml` file and the `install-config.yaml` file. If they do not appear, add them as follows:
374374
375375
. In the `~/.ovirt/ovirt-config.yaml` file:
376376
+

modules/installation-launching-installer.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ You can run the `create cluster` command of the installation program only once,
159159

160160
ifndef::osp,rhv,vsphere[* Configure an account with the cloud platform that hosts your cluster.]
161161

162-
ifdef::rhv[* Open the `ovirt-imageio` port to the Engine from the machine running the installer. By default, the port is `54322`.]
162+
ifdef::rhv[* Open the `ovirt-imageio` port to the {rh-virtualization-engine-name} from the machine running the installer. By default, the port is `54322`.]
163163

164164
* Obtain the {product-title} installation program and the pull secret for your
165165
cluster.
@@ -336,7 +336,7 @@ https://ovirtlab.example.com/ovirt-engine/api
336336
----
337337
endif::openshift-origin[]
338338
+
339-
.. The installer automatically generates a CA certificate. For `Would you like to use the above certificate to connect to the Engine?`, answer `y` or `N`. If you answer `N`, you must install {product-title} in insecure mode.
339+
.. The installer automatically generates a CA certificate. For `Would you like to use the above certificate to connect to the {rh-virtualization-engine-name}?`, answer `y` or `N`. If you answer `N`, you must install {product-title} in insecure mode.
340340
//TODO: Add this sentence with xref after it's OK to add xrefs: For information about insecure mode, see xref:installing-rhv-insecure-mode_installing-rhv-default[].
341341
.. For `Engine username`, enter the user name and profile of the {rh-virtualization} administrator using this format:
342342
+
@@ -350,7 +350,7 @@ endif::openshift-origin[]
350350
.. For `Engine password`, enter the {rh-virtualization} admin password.
351351
.. For `Cluster`, select the {rh-virtualization} cluster for installing {product-title}.
352352
.. For `Storage domain`, select the storage domain for installing {product-title}.
353-
.. For `Network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
353+
.. For `Network`, select a virtual network that has access to the {rh-virtualization} {rh-virtualization-engine-name} REST API.
354354
.. For `Internal API Virtual IP`, enter the static IP address you set aside for the cluster's REST API.
355355
.. For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain.
356356
.. For `Base Domain`, enter the base domain of the {product-title} cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: `virtlab.example.com`

modules/installation-rhv-about-inventory-yml.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Enter values for parameters whose descriptions begin with "Enter." Otherwise, yo
116116

117117
* `ovirt_cluster`: Enter the name of an existing {rh-virtualization} cluster in which to install the {product-title} cluster.
118118
* `ocp.assets_dir`: The path of a directory the `openshift-install` installation program creates to store the files that it generates.
119-
* `ocp.ovirt_config_path`: The path of the `ovirt-config.yaml` file the installation program generates, for example, `./wrk/install-config.yaml`. This file contains the credentials required to interact with the REST API of the oVirt Engine/{rh-virtualization} Manager.
119+
* `ocp.ovirt_config_path`: The path of the `ovirt-config.yaml` file the installation program generates, for example, `./wrk/install-config.yaml`. This file contains the credentials required to interact with the REST API of the {rh-virtualization-engine-name}.
120120

121121
.{op-system-first} section
122122

modules/installation-rhv-creating-install-config-file.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You create an installation configuration file by running the installation progra
1010

1111
When you finish responding to the prompts, the installation program creates an initial version of the `install-config.yaml` file in the assets directory you specified earlier, for example, `./wrk/install-config.yaml`
1212

13-
The installation program also creates a file, `$HOME/.ovirt/ovirt-config.yaml`, that contains all the connection parameters that are required to reach the oVirt Engine/{rh-virtualization} Manager and use its REST API.
13+
The installation program also creates a file, `$HOME/.ovirt/ovirt-config.yaml`, that contains all the connection parameters that are required to reach the {rh-virtualization-engine-name} and use its REST API.
1414

1515
**NOTE:**
1616
The installation process does not use values you supply for some parameters, such as `Internal API virtual IP` and `Ingress virtual IP`, because you have already configured them in your infrastructure DNS.

modules/installation-rhv-creating-templates-virtual-machines.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
After confirming the variables in the `inventory.yml`, you run the first Ansible provisioning playbook, `create-templates-and-vms.yml`.
1010

11-
This playbook uses the connection parameters for the {rh-virtualization} Manager from `$HOME/.ovirt/ovirt-config.yaml` and reads `metadata.json` in the assets directory.
11+
This playbook uses the connection parameters for the {rh-virtualization} {rh-virtualization-engine-name} from `$HOME/.ovirt/ovirt-config.yaml` and reads `metadata.json` in the assets directory.
1212

1313
If a local {op-system-first} image is not already present, the playbook downloads one from the URL you specified for `image_url` in `inventory.yml`. It extracts the image and uploads it to {rh-virtualization} to create templates.
1414

modules/installing-rhv-requirements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ endif::[]
4949
* In production environments, each virtual machine must have 120 GiB or more. Therefore, the storage domain must provide 840 GiB or more for the default {product-title} cluster. In resource-constrained or non-production environments, each virtual machine must have 32 GiB or more, so the storage domain must have 230 GiB or more for the default {product-title} cluster.
5050
* To download images from the Red Hat Ecosystem Catalog during installation and update procedures, the {rh-virtualization} cluster must have access to an internet connection. The Telemetry service also needs an internet connection to simplify the subscription and entitlement process.
5151
// TBD - What about the disconnected installation alternative?
52-
* The {rh-virtualization} cluster must have a virtual network with access to the REST API on the {rh-virtualization} Manager. Ensure that DHCP is enabled on this network, because the VMs that the installer creates obtain their IP address by using DHCP.
52+
* The {rh-virtualization} cluster must have a virtual network with access to the REST API on the {rh-virtualization} {rh-virtualization-engine-name}. Ensure that DHCP is enabled on this network, because the VMs that the installer creates obtain their IP address by using DHCP.
5353
* A user account and group with the following least privileges for installing and managing an {product-title} cluster on the target {rh-virtualization} cluster:
5454
** `DiskOperator`
5555
** `DiskCreator`

0 commit comments

Comments
 (0)