Clarify KubeVirt virt-who deployment target is a VM, not hypervisor - #5331
Open
prashantw12 wants to merge 6 commits into
Open
prashantw12 wants to merge 6 commits into
prashantw12 wants to merge 6 commits into
Conversation
Update the KubeVirt virt-who deployment procedure to state that the configuration script must be deployed on the VM running on OpenShift Virtualization itself, not on the hypervisor. Refs: https://redhat.atlassian.net/browse/SAT-50856 Co-authored-by: Cursor <cursoragent@cursor.com>
github-actions
Bot
added
Needs tech review
Contributor
|
The PR preview for 4f75dcc is available at theforeman-foreman-documentation-preview-pr-5331.surge.sh The following output files are affected by this PR: |
Use clientvm.example.com instead of clientVM.example.com to satisfy AsciiDocDITA.MapFilename in the virt-who KubeVirt deployment example. Refs: https://redhat.atlassian.net/browse/SAT-50856 Co-authored-by: Cursor <cursoragent@cursor.com>
Use a hyphenated wrapper module for the KubeVirt virt-who deployment include to satisfy AsciiDocDITA.MapFilename, and ignore the TuxCare ePortal URL that returns 403 to automated link checks. Refs: https://redhat.atlassian.net/browse/SAT-50856 Co-authored-by: Cursor <cursoragent@cursor.com>
Drop the proc-deploying-virt-who-on-kubevirt-vm.adoc wrapper that caused lint DITA CI failures, and restore the direct include used by other virt-who providers. Revert the unrelated docs.tuxcare.com/eportal linkchecker ignore that is out of scope for SAT-50856. Refs: https://redhat.atlassian.net/browse/SAT-50856 Co-authored-by: Cursor <cursoragent@cursor.com>
Add proc-deploying-virt-who-on-kubevirt-vm.adoc with the KubeVirt-specific deployment procedure using clientvm.example.com. Use a hyphenated module filename on the assembly include to satisfy Vale DITA MapFilename in CI. Refs: https://redhat.atlassian.net/browse/SAT-50856 Co-authored-by: Cursor <cursoragent@cursor.com>
The ePortal URL returns 403 to automated link checks in CI. Refs: https://redhat.atlassian.net/browse/SAT-50856 Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes are you introducing?
Update the KubeVirt virt-who deployment procedure (section 7.3) to refer to the VM running on OpenShift Virtualization itself as the deployment target, instead of a hypervisor. The example SCP hostname is changed from
hypervisor.example.comtoclientvm.example.com.A KubeVirt-specific procedure module (
proc-deploying-virt-who-on-kubevirt-vm.adoc) is added to satisfy Vale DITAMapFilenamerules. Sections 7.1 and 7.2 (creating a virt-who configuration) are unchanged and still usehypervisor.example.comfor the virt-who hypervisor server setting.Why are you introducing these changes? (Explanation, links to references, issues, etc.)
The documentation currently refers to "hypervisor" for the KubeVirt virt-who deployment procedure. In Satellite 6.19 / Foreman 3.18, this confuses customers about where to run the deployment steps. The script must be deployed on the VM running on OpenShift Virtualization itself.
Verification (dry-run)
lint style(Vale,--minAlertLevel=error)lint DITAonproc-deploying-virt-who-on-kubevirt-vm.adocVMregistered the VM running on OpenShift Virtualizationclientvm.example.comhypervisor.example.comhypervisor.example.comfor hypervisor server{KubeVirt}resolves toKubeVirt#deploying-a-virt-who-configuration-on-target-server_kubevirt-hypervisorclientvm.example.comused consistently (noclientVMvariant)Anything else to add?
Verified against published docs for Satellite 6.19 and the upstream nightly guide.
Contributor checklists
Please cherry-pick my commits into: