OSDOCS#14725: OVE install method #93592
Conversation
|
@skopacz1: This pull request references OSDOCS-14725 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci-robot
added
the
jira/valid-reference
openshift-ci
bot
added
the
size/L
|
🤖 Tue Dec 16 17:25:44 - Prow CI generated the docs preview: |
|
@skopacz1: This pull request references OSDOCS-14725 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.20.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
virt/install/installing-ove.adoc
Outdated
|
|
||
| The following procedures describe a streamlined method to install a {ove-first} cluster that requires less planning and configuration compared to other installation methods. | ||
|
|
||
| :FeatureName: Installing an {ove} cluster using this method |
There was a problem hiding this comment.
I have no idea what type of official name this feature has 🤷♂️
So this is just a placeholder for now
modules/installing-ove-console.adoc
Outdated
| Otherwise, a default value is selected. | ||
|
|
||
| .. Enter an IP address in the *API IP* field. | ||
| An API IP provides an endpoint for all users to interact with, and configure the platform. |
There was a problem hiding this comment.
Note: VIPS are not always required, it depends on the network type
There was a problem hiding this comment.
Should I document this as an Optional step, in that case? As-is, this is written as something that all users need to add
There was a problem hiding this comment.
I don't think this page is any different from the SaaS one (cc @rawagner to make me honest), so in such case you could reuse the same approach for documenting it I guess
virt/install/installing-ove.adoc
Outdated
| [id="next-steps_{context}"] | ||
| == Next steps | ||
|
|
||
| After a successful cluster installation, you can take the following next steps to prepare your cluster to run virtualized workloads: |
There was a problem hiding this comment.
I'm not an expert here, so leaving to @tiraboschi and @dominikholler for more useful comments :) .
Btw, not sure if you could directly point to some already existing docs for OVE, though
There was a problem hiding this comment.
Happy to add or remove any links in this section. That said, I think the OVE docs are a little bare at the moment.
modules/installing-ove-console.adoc
Outdated
| [id="virt-installing-ove-console_{context}"] | ||
| = Configuring the cluster installation from the web console | ||
|
|
||
| Once the machines have been booted from the ISO image and the rendezvous node has been selected, configure the rest of the cluster installation from the web console. |
There was a problem hiding this comment.
As mentioned before, I think the workflow it's just one, it's just the inherent parallelism of the process that could give the impression of having multiple ways to do that - but it's not: the system has been designed to make the order irrelevant (see also the comment on the warning message on the TUI for example) to make the life simpler for the end user, so IMHO by sticking to one specific path we could lose the aforementioned flexibity
modules/installing-ove-console.adoc
Outdated
| Otherwise, a default value is selected. | ||
|
|
||
| .. Enter an IP address in the *API IP* field. | ||
| An API IP provides an endpoint for all users to interact with, and configure the platform. |
There was a problem hiding this comment.
I don't think this page is any different from the SaaS one (cc @rawagner to make me honest), so in such case you could reuse the same approach for documenting it I guess
virt/install/installing-ove.adoc
Outdated
|
|
||
| The following procedures describe a streamlined method to install a {ove-first} cluster that requires less planning and configuration compared to other installation methods. | ||
|
|
||
| :FeatureName: Installing an {ove} cluster using this method |
_topic_maps/_topic_map.yml
Outdated
| Topics: | ||
| - Name: Preparing your cluster | ||
| File: preparing-cluster-for-virt | ||
| - Name: Installing an OpenShift Virtualization Engine cluster |
There was a problem hiding this comment.
| - Name: Installing an OpenShift Virtualization Engine cluster | |
| - Name: Installing an OpenShift Virtualization Engine cluster in a disconnected environment |
There was a problem hiding this comment.
I am guessing that we will try to move away from wording that includes OVE in it, but in the meantime I can clarify the disconnected environment part until we land a particular name for this procedure/feature
| . In the *Rendezvous node IP selection* menu, select an IP address from the list to use as the rendezvous node IP address and select *Continue*. | ||
| Make note of this address for later use. | ||
|
|
||
| . Wait for the rendezvous node to provide a URL for finishing the installation and save the URL for later use. No newline at end of file |
There was a problem hiding this comment.
| . Wait for the rendezvous node to provide a URL for finishing the installation and save the URL for later use. | |
| . Wait for the rendezvous node to provide a URL for finishing the installation and save the URL (shown in the terminal) for later use. |
Could maybe be useful to show an example here?
There was a problem hiding this comment.
Sure, if you mean a screenshot then would you mind providing a decent quality screen capture?
|
|
||
| . Configure the cluster networking on the *Networking* page: | ||
|
|
||
| .. Optional: Select a machine network from the dropdown menu of the *Machine network* field. |
There was a problem hiding this comment.
This section still looks a bit confusing to me. In the Networking page by default the Cluster-managed Networking is select:
With this option, the user is required to enter the API and Ingress vips,as well as the stack type.
Instead, by selecting User-Managed Networking option does not have to specify anything:
Note that the Use advanced networking and SSH public key fields are always (optionally) available in both the cases.
There was a problem hiding this comment.
I did not know this was how the UI worked, let me try to rewrite this section to account for these two options.
|
The This is because your PR targets the If the update in your PR does NOT apply to version 4.20 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main. |
|
@skopacz1 not sure if a refresh would be required, but IINW the preview link seems to show yet the older version? |
skopacz1
changed the title
openshift-ci-robot
removed
the
jira/valid-reference
|
@skopacz1: No Jira issue is referenced in the title of this pull request. 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 openshift-eng/jira-lifecycle-plugin repository. |
skopacz1
force-pushed
the
OSDOCS-14725
branch
from
1f79972 to
807270b
Compare
|
The This is because your PR targets the If the update in your PR does NOT apply to version 4.21 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main. |
skopacz1
force-pushed
the
OSDOCS-14725
branch
2 times, most recently
from
5cf3f28 to
0385e66
Compare
|
/lgtm |
skopacz1
force-pushed
the
OSDOCS-14725
branch
from
138d0b6 to
41a2dd5
Compare
|
New changes are detected. LGTM label has been removed. |
skopacz1
added
do-not-merge/hold
|
/label merge-review-in-progress |
openshift-ci
bot
added
the
merge-review-in-progress
bergerhoffer
left a comment
bergerhoffer
left a comment
There was a problem hiding this comment.
Just a few minor suggestions, but nothing merge blocking (other than perhaps getting ahead of the DITA migration issues)
| [id="virt-installing-ove-advantages_{context}"] | ||
| = Installation method advantages | ||
|
|
||
| This method has the following advantages for users who want to install a cluster primarily to run virtualized workloads using {VirtProductName}: |
There was a problem hiding this comment.
Out of scope for merge review, but there are references to "this method" throughout, that it would be better to clarify what "this method" is. Especially something like at the beginning of this module, which doesn't have prior context set.
There was a problem hiding this comment.
It's tough because it's a PM decision to specifically not create a new name for this feature, and it's different enough from the normal Agent-based Installer workflow (because it has a full blown UI and other things) that it feels wrong to call it just an Agent installation (to be honest it's still more debatable whether this is even more of an Agent installer thing or an Assisted Installer thing). I can think about this some more after this gets merged, to see if there's some happy medium
| [id="virt-installing-ove-advantages_{context}"] | ||
| = Installation method advantages | ||
|
|
||
| This method has the following advantages for users who want to install a cluster primarily to run virtualized workloads using {VirtProductName}: |
There was a problem hiding this comment.
Since this is new content, it would be good to try to get all files to have proper short descriptions, so you don't have to come back later and do it. Some of the first paras in some of the files would be fine short descriptions, but this one wouldn't, since it leads into below text with a colon
There was a problem hiding this comment.
Ah right I forgot that modules need this as well, I can try to write up short descriptions.
|
|
||
| . Click *Next* to continue. | ||
|
|
||
| . If you will manage your own networking, select the *User-Managed Networking* option on the *Networking* page. |
There was a problem hiding this comment.
Out of scope for merge review, but there are lots of future tense will's in here that could likely be adjusted
|
|
||
| . On the *Review and create* page, review all of the cluster details and click *Install cluster* to initiate the cluster installation. | ||
|
|
||
| During the installation process, the rendezvous node reboots and the console you used to configure the installation is no longer accessible. |
There was a problem hiding this comment.
Same about making this DITA compliant. Info after the procedure steps have completed won't be supported in DITA. Consider adjusting that now as necessary to avoid having to come back and fix later
| ==== | ||
|
|
||
| .. Enter your pull secret in the *Pull secret* field. | ||
| You can obtain a copy of your pull secret link:https://console.redhat.com/openshift/install/pull-secret[here]. |
There was a problem hiding this comment.
Out of scope for merge review, but "here" as the link text is against style guide recommendations. Link text should be descriptive of the page it's taking you to
There was a problem hiding this comment.
Feedback about unclear docs is always in scope to me!
| .. Optional: In the *Number of control plane nodes* field, select the number of control plane nodes for your installation from the dropdown menu. | ||
| The default value is `3`. | ||
|
|
||
| .. Optional: Select the *include custom manifests* checkbox if you want to upload custom manifests to further configure your cluster. |
There was a problem hiding this comment.
Should "Include" be capitalized here like in the important block below?
There was a problem hiding this comment.
Great catch, it is in fact capitalized in the UI
bergerhoffer
added
ok-to-merge
and removed
merge-review-in-progress
skopacz1
force-pushed
the
OSDOCS-14725
branch
from
41a2dd5 to
df493bc
Compare
skopacz1
force-pushed
the
OSDOCS-14725
branch
from
df493bc to
63ca1d2
Compare
|
@skopacz1: all tests passed! Full PR test history. Your PR dashboard. 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-sigs/prow repository. I understand the commands that are listed here. |
skopacz1
removed
the
do-not-merge/hold
11 participants
OSDOCS-14725
Version(s): 4.20+
This PR adds a streamlined and opinionated installation method for users who want a simplified way of installing a cluster mainly for virtualization.
QE review:
Preview: Installing a cluster without an external registry