openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

1975622 Added new attribute: {rh-virtualization-engine-name} and substitued attribute where relevant.

Browse Source 
On branch 1975622
Your branch is up to date with 'origin/1975622'.

Changes to be committed:
	modified:   _unused_topics/cluster-logging-exported-fields-ovirt.2021-06-04.adoc
	modified:   modules/common-attributes.adoc
	modified:   modules/installation-initializing.adoc
	modified:   modules/installation-launching-installer.adoc
	modified:   modules/installation-rhv-about-inventory-yml.adoc
	modified:   modules/installation-rhv-creating-install-config-file.adoc
	modified:   modules/installing-rhv-setting-up-ca-certificate.adoc
	modified:   modules/installing-rhv-setting-up-installation-machine.adoc
	modified:   modules/virt-importing-vm-cli.adoc
This commit is contained in:
sgoodman
2021-08-16 19:21:08 +03:00
committed by openshift-cherrypick-robot
parent fcf71894d5
commit 456fc7486a
14 changed files with 24 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -26,5 +26,5 @@ Namespace for oVirt metadata.
[id="exported-fields-ovirt.engine_{context}"]
=== `ovirt.engine` Fields
Namespace for oVirt engine related metadata. The FQDN of the oVirt engine is
Namespace for metadata related to the {rh-virtualization-engine-name}. The FQDN of the {rh-virtualization-engine-name} is
`ovirt.engine.fqdn`

2
installing/installing_rhv/installing-rhv-user-infra.adoc
View File

@@ -10,7 +10,7 @@ customized {product-title} cluster on {rh-virtualization-first} and other infras
The following diagram shows an example of a potential {product-title} cluster running on a {rh-virtualization} cluster.
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.]
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.]
== Prerequisites

2
modules/common-attributes.adoc
View File

@@ -32,9 +32,11 @@ endif::[]
:sandboxed-containers-operator: OpenShift sandboxed containers Operator
:rh-virtualization-first: Red Hat Virtualization (RHV)
:rh-virtualization: RHV
:rh-virtualization-engine-name: Manager
ifdef::openshift-origin[]
:rh-virtualization-first: oVirt
:rh-virtualization: oVirt
:rh-virtualization-engine-name: Engine
endif::[]
:launch: image:app-launcher.png[title="Application Launcher"]
:mtc-short: MTC

2
modules/installation-configuration-parameters.adoc
View File

@@ -1337,4 +1337,4 @@ ifeval::["{context}" == "installing-ibm-power"]
endif::[]
ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
:!ibm-power:
endif::[]
endif::[]

4
modules/installation-initializing.adoc
View File

@@ -333,7 +333,7 @@ ocpadmin@internal
... For `oVirt engine password`, enter the {rh-virtualization} admin password.
... For `oVirt cluster`, select the cluster for installing {product-title}.
... For `oVirt storage domain`, select the storage domain for installing {product-title}.
... For `oVirt network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
... For `oVirt network`, select a virtual network that has access to the {rh-virtualization} {rh-virtualization-engine-name} REST API.
... For `Internal API Virtual IP`, enter the static IP address you set aside for the cluster's REST API.
... For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain.
... 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[]
+
[NOTE]
====
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:
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:
. In the `~/.ovirt/ovirt-config.yaml` file:
+

6
modules/installation-launching-installer.adoc
View File

@@ -159,7 +159,7 @@ You can run the `create cluster` command of the installation program only once,
ifndef::osp,rhv,vsphere[* Configure an account with the cloud platform that hosts your cluster.]
ifdef::rhv[* Open the `ovirt-imageio` port to the Engine from the machine running the installer. By default, the port is `54322`.]
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`.]
* Obtain the {product-title} installation program and the pull secret for your
cluster.
@@ -336,7 +336,7 @@ https://ovirtlab.example.com/ovirt-engine/api
----
endif::openshift-origin[]
+
.. 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.
.. 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.
//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[].
.. For `Engine username`, enter the user name and profile of the {rh-virtualization} administrator using this format:
+
@@ -350,7 +350,7 @@ endif::openshift-origin[]
.. For `Engine password`, enter the {rh-virtualization} admin password.
.. For `Cluster`, select the {rh-virtualization} cluster for installing {product-title}.
.. For `Storage domain`, select the storage domain for installing {product-title}.
.. For `Network`, select a virtual network that has access to the {rh-virtualization} Manager REST API.
.. For `Network`, select a virtual network that has access to the {rh-virtualization} {rh-virtualization-engine-name} REST API.
.. For `Internal API Virtual IP`, enter the static IP address you set aside for the cluster's REST API.
.. For `Ingress virtual IP`, enter the static IP address you reserved for the wildcard apps domain.
.. 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`

2
modules/installation-rhv-about-inventory-yml.adoc
View File

@@ -116,7 +116,7 @@ Enter values for parameters whose descriptions begin with "Enter." Otherwise, yo
* `ovirt_cluster`: Enter the name of an existing {rh-virtualization} cluster in which to install the {product-title} cluster.
* `ocp.assets_dir`: The path of a directory the `openshift-install` installation program creates to store the files that it generates.
* `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.
* `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}.
.{op-system-first} section

2
modules/installation-rhv-creating-install-config-file.adoc
View File

@@ -10,7 +10,7 @@ You create an installation configuration file by running the installation progra
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`
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.
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.
**NOTE:**
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.

2
modules/installation-rhv-creating-templates-virtual-machines.adoc
View File

@@ -8,7 +8,7 @@
After confirming the variables in the `inventory.yml`, you run the first Ansible provisioning playbook, `create-templates-and-vms.yml`.
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.
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.
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.

2
modules/installing-rhv-requirements.adoc
View File

@@ -49,7 +49,7 @@ endif::[]
* 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.
* 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.
// TBD - What about the disconnected installation alternative?
* 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.
* 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.
* A user account and group with the following least privileges for installing and managing an {product-title} cluster on the target {rh-virtualization} cluster:
** `DiskOperator`
** `DiskCreator`

8
modules/installing-rhv-setting-up-ca-certificate.adoc
View File

@@ -9,23 +9,23 @@
Download the CA certificate from the {rh-virtualization-first} Manager and set it up on the installation machine.
You can download the certificate from a webpage on the {rh-virtualization} Manager or by using a `curl` command.
You can download the certificate from a webpage on the {rh-virtualization} {rh-virtualization-engine-name} or by using a `curl` command.
Later, you provide the certificate to the installation program.
.Procedure
. Use either of these two methods to download the CA certificate:
** Go to the Manager's webpage, `\https://<engine-fqdn>/ovirt-engine/`. Then, under *Downloads*, click the *CA Certificate* link.
** Go to the {rh-virtualization-engine-name}'s webpage, `\https://<engine-fqdn>/ovirt-engine/`. Then, under *Downloads*, click the *CA Certificate* link.
** Run the following command:
+
[source,terminal]
----
$ curl -k 'https://<engine-fqdn>/ovirt-engine/services/pki-resource?resource=ca-certificate&format=X509-PEM-CA' -o /tmp/ca.pem <1>
----
<1> For `<engine-fqdn>`, specify the fully qualified domain name of the {rh-virtualization} Manager, such as `rhv-env.virtlab.example.com`.
<1> For `<engine-fqdn>`, specify the fully qualified domain name of the {rh-virtualization} {rh-virtualization-engine-name}, such as `rhv-env.virtlab.example.com`.
. Configure the CA file to grant rootless user access to the Manager. Set the CA file permissions to have an octal value of `0644` (symbolic value: `-rw-r--r--`):
. Configure the CA file to grant rootless user access to the {rh-virtualization-engine-name}. Set the CA file permissions to have an octal value of `0644` (symbolic value: `-rw-r--r--`):
+
[source,terminal]
----

6
modules/installing-rhv-setting-up-installation-machine.adoc
View File

@@ -7,7 +7,7 @@
= Setting up the installation machine
To run the binary `openshift-install` installation program and Ansible scripts, set up the {rh-virtualization} Manager or an {op-system-base-full} computer with network access to the {rh-virtualization} environment and the REST API on the {rh-virtualization} Manager/oVirt Engine.
To run the binary `openshift-install` installation program and Ansible scripts, set up the {rh-virtualization} {rh-virtualization-engine-name} or an {op-system-base-full} computer with network access to the {rh-virtualization} environment and the REST API on the {rh-virtualization-engine-name}.
// The following steps include creating an `ASSETS_DIR` environment variable, which the installation program uses to create a directory of asset files. Later, the installation process reuses this variable to locate these asset files.
@@ -22,14 +22,14 @@ To run the binary `openshift-install` installation program and Ansible scripts,
. link:https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.4/html/python_sdk_guide/chap-overview#Installing_the_Software_Development_Kit[Install the `python3-ovirt-engine-sdk4` package] to get the Python Software Development Kit.
. Install the `ovirt.image-template` Ansible role. On {rh-virtualization} Manager and other {op-system-base-full} machines, this role is distributed as the `ovirt-ansible-image-template` package. For example, enter:
. Install the `ovirt.image-template` Ansible role. On the {rh-virtualization} {rh-virtualization-engine-name} and other {op-system-base-full} machines, this role is distributed as the `ovirt-ansible-image-template` package. For example, enter:
+
[source,terminal]
----
# dnf install ovirt-ansible-image-template
----
. Install the `ovirt.vm-infra` Ansible role. On {rh-virtualization} Manager and other {op-system-base} machines, this role is distributed as the `ovirt-ansible-vm-infra` package.
. Install the `ovirt.vm-infra` Ansible role. On the {rh-virtualization} {rh-virtualization-engine-name} and other {op-system-base} machines, this role is distributed as the `ovirt-ansible-vm-infra` package.
+
[source,terminal]
----

2
modules/installing-rhv-verifying-rhv-environment.adoc
View File

@@ -46,7 +46,7 @@ These requirements are based on the default resources the installation program u
** 16 GiB for each of the three compute machines
.. Record the amount of *Max free Memory for scheduling new virtual machines* for use later on.
+
. Verify that the virtual network for installing {product-title} has access to the {rh-virtualization} Manager's REST API. From a virtual machine on this network, use curl to reach the {rh-virtualization} Manager's REST API:
. Verify that the virtual network for installing {product-title} has access to the {rh-virtualization} {rh-virtualization-engine-name}'s REST API. From a virtual machine on this network, use curl to reach the {rh-virtualization} {rh-virtualization-engine-name}'s REST API:
+
[source,terminal]
----

4
modules/virt-importing-vm-cli.adoc
View File

@@ -129,7 +129,7 @@ EOF
----
<1> If you create a `ResourceMapping` CR, uncomment the `resourceMapping` section.
<2> Specify the target VM name.
<3> Specify the source VM ID, for example, `80554327-0569-496b-bdeb-fcbbf52b827b`. You can obtain the VM ID by entering `\https://www.example.com/ovirt-engine/api/vms/` in a web browser on the Manager machine to list all VMs. Locate the VM you want to import and its corresponding VM ID. You do not need to specify a VM name or cluster name.
<3> Specify the source VM ID, for example, `80554327-0569-496b-bdeb-fcbbf52b827b`. You can obtain the VM ID by entering `\https://www.example.com/ovirt-engine/api/vms/` in a web browser on the {rh-virtualization-engine-name} machine to list all VMs. Locate the VM you want to import and its corresponding VM ID. You do not need to specify a VM name or cluster name.
<4> If you specify the source VM name, you must also specify the source cluster. Do not specify the source VM ID.
<5> If you specify the source cluster, you must also specify the source VM name. Do not specify the source VM ID.
<6> If you create a `ResourceMapping` CR, comment out the `mappings` section.
@@ -142,7 +142,7 @@ EOF
* If the RHV VM migration mode is `Allow manual and automatic migration`, the default access mode is `ReadWriteMany`.
* If the RHV virtual disk access mode is `ReadOnly`, the default access mode is `ReadOnlyMany`.
* For all other settings, the default access mode is `ReadWriteOnce`.
<13> Specify the source VM disk ID, for example, `8181ecc1-5db8-4193-9c92-3ddab3be7b05`. You can obtain the disk ID by entering `\https://www.example.com/ovirt-engine/api/vms/vm23` in a web browser on the Manager machine and reviewing the VM details.
<13> Specify the source VM disk ID, for example, `8181ecc1-5db8-4193-9c92-3ddab3be7b05`. You can obtain the disk ID by entering `\https://www.example.com/ovirt-engine/api/vms/vm23` in a web browser on the {rh-virtualization-engine-name} machine and reviewing the VM details.
<14> Specify the target storage class.
. Follow the progress of the virtual machine import to verify that the import was successful: