Bug 1804230: Documentation Incorrect for OCP 4.4 RHV IPI Install#3183
Bug 1804230: Documentation Incorrect for OCP 4.4 RHV IPI Install#3183openshift-merge-robot merged 1 commit intoopenshift:masterfrom
Conversation
openshift-ci-robot
added
the
bugzilla/invalid-bug
|
@rgolangh: This pull request references Bugzilla bug 1804230, which is invalid:
Comment DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
openshift-ci-robot
added
the
size/L
|
/bugzilla refresh |
openshift-ci-robot
added
bugzilla/valid-bug
|
@rgolangh: This pull request references Bugzilla bug 1804230, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
There was a problem hiding this comment.
These options are only available via TF_VARs? We shouldn't be suggesting that to users only developers, can these be set on the machine pools?
There was a problem hiding this comment.
Same, user facing options should be available in install-config, ex: #3170
There was a problem hiding this comment.
would like to see this doc look similar to https://github.com/openshift/installer/blob/master/docs/user/aws/customization.md
There was a problem hiding this comment.
let's use generic names in the examples and censor the kubeadmin password
There was a problem hiding this comment.
let's use generic names in the examples and censor the kubeadmin password
rolfedh
left a comment
rolfedh
left a comment
There was a problem hiding this comment.
Customizing a template during installation
Before you begin, see the generic cluster customization doc.
You can customize cluster resources both during and after installing a cluster. This topic shows you how to customize a template during the installation process before the installer uses the template to create resources for the cluster.
While creating a cluster, the OpenShift installer provides the following resources:
- It uploads a qcow disk image of Red Hat Enterprise Linux CoreOS (RHCOS).
- It creates a template from the pinned RHCOS qcow disk.
- It creates master nodes and disks from the template.
Customizing these installer-created resources before installation helps make the resource definitions consistent with each other. This approach is more straightforward than making customizations after installation. It also helps avoid issues caused by resources that are inconsistent with each other.
The cluster also uses the template to create every master and worker node both during and after the installation.
A dedicated VLAN network per cluster may come in the future.
Customizing environment variables
Optionally, you can customize the following environment variables before installation.
| Env variable | Description |
|---|---|
TF_VAR_ovirt_template_disk_size_gib |
The size of the template disk for worker/nodes in GiB |
TF_VAR_ovirt_master_mem |
Master VM memory in MiB |
TF_VAR_ovirt_master_cpu |
Master number of CPUs |
TF_VAR_ovirt_template_mem |
Template VM memory in MiB |
TF_VAR_ovirt_template_cpu |
Template number of CPUs |
Although the installer uses the same template to create every node, it uses the TF_VAR_ovirt_master_ and TF_VAR_ovirt_template_ variables to provide different resources for master and worker nodes.
Editing templates
Optionally, you can customize the template the installer creates from the pinned RHCOS qcow disk.
When the installer finishes creating the template, stop the installation for editing.
Locate the template, named infraID
Edit the contents of the template. For example, you can edit it to create a node with two NICs.
Save your edits to the template file.
If you change the file name of the template, set the OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE environment variable to the new name, (as described here)[docs/dev/]
Note: You can set OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE to the file name of a template, or the URL of a qcow image.
Customizing the install-config properties
Optionally, you can customize the install-config properties.
Note: For oVirt platform specifics, see the full struct details, here.
| Property | Description |
|---|---|
ovirt_network_name |
An active network under the selected cluster ID |
|
/uncc @jstuever |
|
This makes no mention of uploading the RHCOS image to RHV, which the binary nightly of openshift-install still does not do as of 3/10/2020. |
rgolangh
force-pushed
the
doc-update
branch
2 times, most recently
from
8fb4c33 to
7f00816
Compare
|
@rgolangh: The following test failed, say
Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
rgolangh
force-pushed
the
doc-update
branch
2 times, most recently
from
e35b7ed to
f425e7b
Compare
There was a problem hiding this comment.
This entire document is very confusing to me.
It mixes the during, before installing a lot. It's not clear to me what you can do at each.
Also the during is too confusing, I have no clue enable when do you want the user to make the change.
Also at one point this document says stop the installer when the template is created, modify it and then restart with and env..
^^ all this is a really bad ux. No document should recommend this type of high-touch-time based workflow. Please fix it.
Also, this document points to code for options available for configuration.. that's not acceptable. Please clearly document so the customization.
Lastly this document doesn't look anything like docs/aws/customization of any other cloud ones. Please make sure the documents are consistent. It's important for readers to correctly anticipate.
There was a problem hiding this comment.
The env is designed for devs and not users of the product. Please either make it clear that there are plans to provide supported way of doing it, and this is a worksheet for time being.
|
@abhinavdahiya customization.md was merged as part of #3399 . I'll drop it from this PR and update the install_ipi if needed |
openshift-ci-robot
added
the
bugzilla/severity-medium
|
@rgolangh: This pull request references Bugzilla bug 1804230, which is valid. 3 validation(s) were run on this bug
DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
@abhinavdahiya @rolfedh I think this is ready for another round of review. |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abhinavdahiya The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
There was a problem hiding this comment.
I don't understand why we are maintaining this topic. We've had customer complaints from people who landed here instead of the current documentation. It seems like we should replace this content with a link that sends users to https://docs.openshift.com/container-platform/4.4/installing/installing_rhv/installing-rhv-default.html. I'll help you move any key facts to https://github.com/openshift/openshift-docs/tree/master/installing/installing_rhv. What do you think?
Otherwise, if you still want to maintain this outside the documentation, then LGTM - merge your changes and I'll follow up with a detailed copyedit in a separate pull request.
There was a problem hiding this comment.
Replace with:
# Customizing a template during installation
Before you begin, see the [generic cluster customization doc](docs/user/customization.md).
You can customize cluster resources both during and after installing a cluster. This topic shows you how to customize a template *during* the installation process before the installer uses the template to create resources for the cluster.
While creating a cluster, the OpenShift installer provides the following resources:
- It uploads a qcow disk image of Red Hat Enterprise Linux CoreOS (RHCOS).
- It creates a template from the pinned RHCOS qcow disk.
- It creates master nodes and disks from the template.
Customizing these installer-created resources *before* installation helps make the resource definitions consistent with each other. This approach is more straightforward than making customizations after installation. It also helps avoid issues caused by resources that are inconsistent with each other.
The cluster also uses the template to create every master and worker node both during and after the installation.
A dedicated VLAN network per cluster may come in the future.
There was a problem hiding this comment.
Roy is going to move this whole section to a new doc under docs/dev/ovirt. Replace the content with:
## Customizing environment variables
Optionally, you can customize the following environment variables before installation.
| Env variable | Description |
| --- | --- |
| `TF_VAR_ovirt_template_disk_size_gib` | The size of the template disk for worker/nodes in GiB |
| `TF_VAR_ovirt_master_mem` | Master VM memory in MiB |
| `TF_VAR_ovirt_master_cpu` | Master number of CPUs |
| `TF_VAR_ovirt_template_mem` | Template VM memory in MiB |
| `TF_VAR_ovirt_template_cpu` | Template number of CPUs |
Although the installer uses the same template to create every node, it uses the `TF_VAR_ovirt_master_` and `TF_VAR_ovirt_template_` variables to provide different resources for master and worker nodes.
There was a problem hiding this comment.
These references to "VM" are confusing. It's unclear which lexicon we're using: RHV or OCP? Are we talking about "master and worker nodes" in OCP, or the RHV "RHV Master, RHVH/RHEL hosts (hypervisors), and virtual machines" in RHV?
There was a problem hiding this comment.
Roy is going to move this section to a new doc under docs/dev/ovirt
There was a problem hiding this comment.
I totally dropped customization.md from the PR because it was merged as part of #3399 - see https://github.com/openshift/installer/blob/master/docs/user/ovirt/customization.md
There was a problem hiding this comment.
Replace with:
## Editing templates.
Optionally, you can customize the template the installer creates from the pinned RHCOS qcow disk.
When the installer finishes creating the template, stop the installation for editing.
Locate the template, named [`infraID`](pkg/asset/installconfig/clusterid.go)
Edit the contents of the template. For example, you can edit it to create a node with two NICs.
Save your edits to the template file.
If you change the file name of the template, set the `OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE` environment variable to the new name, (as described here)[docs/dev/]
Note: You can set `OPENSHIFT_INSTALL_OS_IMAGE_OVERRIDE` to the file name of a template, or the URL of a qcow image.
dougsland
left a comment
dougsland
left a comment
There was a problem hiding this comment.
looks good, few comments.
There was a problem hiding this comment.
oVirt 4.3.9.4 or higher as we talked.
There was a problem hiding this comment.
Probably add a external link:
[per ETCD requirement doc](https://github.com/etcd-io/etcd/blob/master/Documentation/op-guide/hardware.md)
There was a problem hiding this comment.
I'd suggest us update API_VIP to API_VIRTUAL_IP
There was a problem hiding this comment.
api_vip and dns_vip, and ingress_vip are the name of the keys in install-config. Actually I'll change all the usages here to lower case.
There was a problem hiding this comment.
api_vip and dns_vip, and ingress_vip are the name of the keys in install-config. Actually I'll
change all the usages here to lower case.
Can we link to source code (install-config) these keys ?
There was a problem hiding this comment.
:s/to your/Make sure the DNS Virtual IP is included in /etc/resolv.conf (or similar phrase)/g
There was a problem hiding this comment.
I think Rolfe may be able to help here with another PR. I want this change to get it already to at least be a good improvement over what we already have.
There was a problem hiding this comment.
Can we add a note for "install_dir" ? Will it keep the vms configurations? Should we do a backup in case of failure?
There was a problem hiding this comment.
IMO, we should add into requirements a note about: "pub key" and how to generate it.
There was a problem hiding this comment.
This doc should be specific to ovirt/RHV. All information which is non-platform specific should go in the generic docs. If it was there I would link to it. Maybe it's worth adding that there.
There was a problem hiding this comment.
missing url for docs/usr/customization.md ?
There was a problem hiding this comment.
do we have any link to add as reference for install-config.yaml?
There was a problem hiding this comment.
It's a generated file. But I'll add a link to the installer explain command that will print information about the install-config.
revisit install_ipi.md Signed-off-by: Roy Golan <rgolan@redhat.com>
|
Alright, let's move forward. |
|
@dougsland: changing LGTM is restricted to collaborators DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
/lgtm |
|
@rgolangh: All pull requests linked via external trackers have merged: openshift/installer#3183. Bugzilla bug 1804230 has been moved to the MODIFIED state. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
9 participants
docs: Update for oVirt installation and customization
revisit install_ipi.md