OpenShift Virtualization: add hyperconverged v1 API - #491
Open
nunnatsa wants to merge 1 commit into
Open
Conversation
Author
|
/cc @mikemckiernan |
Documentation preview |
mikemckiernan
left a comment
mikemckiernan
left a comment
Member
There was a problem hiding this comment.
Thank you for the update! PLMK what I can clarify.
| * `Install the OpenShift Virtualization Operator <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/virtualization/installing>`__. | ||
| * `Install the virtctl client <https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/virtualization/getting-started#installing-virtctl_virt-using-the-cli-tools>`__. | ||
| * Starting with OpenShift Virtualization 4.12.3 and 4.13.0, set the ``disableMDevConfiguration`` feature gate: | ||
| * Starting with OpenShift Virtualization 4.12.3 and 4.13.0, disable MDev Configurations |
Member
There was a problem hiding this comment.
Suggested change
| * Starting with OpenShift Virtualization 4.12.3 and 4.13.0, disable MDev Configurations | |
| * You must disable mediated device virtualization to prevent conflicts with the Operator: |
- These releases seem to be in the distant past.
- That's an AI proposed reason, please check the true rationale.
- Rereading this now, this seems like it might more accurately be a step in a procedure than a prereq. (Up to you.)
There was a problem hiding this comment.
It's still required, otherwise OpenShift Virtualization itself will try to manage these devices. I'd reword the suggested change to highlight this.
You must disable OpenShift Virtualization mediated device management to prevent conflicts with the GPU Operator:
| .. code-block:: console | ||
|
|
||
| hyperconverged.hco.kubevirt.io/kubevirt-hyperconverged patched | ||
| $ kubectl patch hyperconverged -n openshift-cnv kubevirt-hyperconverged --type='merge' \ |
Member
There was a problem hiding this comment.
Not oc? Up to you, no matter to me.
Comment on lines
+141
to
+147
| .. note:: | ||
|
|
||
| in OpenShit Virtualization v4.22.x, use the full versioned name for the hyperconverged custom resource: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| $ kubectl patch hyperconvergeds.v1beta1.hco.kubevirt.io -n openshift-cnv kubevirt-hyperconverged --type='json' -p='[{"op": "add", "path": "/spec/featureGates/disableMDevConfiguration", "value": true}]' |
Member
There was a problem hiding this comment.
I feel for OCP support folks that they need to support (test?) all these combinations. Is there truly no more limited support matrix?
Because all three commands are unique, I think it'll present clearest if this is a labelled tab too. Something like "OpenShift Virtualization v4.22.x"
Author
There was a problem hiding this comment.
yes...
But we're in the middle of a process to replace the API. this is the price I guess.
OpenShift virtualization v4.22.0 introduced the new v1 API version for the `HyperConverged` kind. This API version is not backward compatible with the older `v1beta1` API version. The `v1beta1` API version will be deprecated, and later removed from OpenShift Virtualization. This PR adding the v1 API tab, whenever the v1beta1 format is already used in the documents. Note: In OpenShift Virtualization v4.22.x, because of the unchangeable way Kubernetes prioritizes API versions, using a non-versioned name of the HyperConverged custom resource, i.e. `hyperconverged` or `hco`, will make Kubernetes to use the v1 API version. It is recomanded to use the fully versioned named for v1beta1, i.e. `hyperconvergeds.v1beta1.hco.kubevirt.io`. Signed-off-by: Nahshon Unna Tsameret <[email protected]>
Author
|
Thanks for the review @mikemckiernan. Fixed. |
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
3 participants
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.
OpenShift virtualization v4.22.0 introduced the new v1 API version for the
HyperConvergedkind. This API version is not backward compatible with the olderv1beta1API version.The
v1beta1API version will be deprecated, and later removed from OpenShift Virtualization.This PR adding the v1 API tab, whenever the v1beta1 format is already used in the documents.
Note: In OpenShift Virtualization v4.22.x, because of the unchangeable way Kubernetes prioritizes API versions, using a non-versioned name of the HyperConverged custom resource, i.e.
hyperconvergedorhco, will make Kubernetes to use the v1 API version. It is recomanded to use the fully versioned named for v1beta1, i.e.hyperconvergeds.v1beta1.hco.kubevirt.io.