CNV-78917: Use versioned type name for the HyperConverged type

[nunnatsa]

In v4.22, we are intrucing a new API version for the HyperConverged type (A.K.A hco or hyperconverged). This version is not the default one in v4.22, but because of the way kubernetes works, any non-versioned request of this type (get/edit/patch...), will use the newest API version, regadless if it's the default one or not.

This breaks many examples or intructions in the documentation.

To solve this, we'll use a versioned name of the HyperConverged type. To ease that, this PR defined a new attibute named HCOCliKind, with the value of hyperconvergeds.v1beta1.hco.kubevirt.io. Then the PR replaces any read or write command line operation with hco or hyperconverged, with the new attribute.

This will also ease the fix in future release, to get it back to the shorter, non-versioned name.

Version(s):
v4.22

Issue:
https://redhat.atlassian.net/browse/CNV-78917

Link to docs preview:

QE review:

• QE has approved this change.

Additional information:

[openshift-ci-robot]

@nunnatsa: This pull request references CNV-78917 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.22.0" version, but no target version was set.

Details

In response to this:

In v4.22, we are intrucing a new API version for the HyperConverged type (A.K.A hco or hyperconverged). This version is not the default one in v4.22, but because of the way kubernetes works, any non-versioned request of this type (get/edit/patch...), will use the newest API version, regadless if it's the default one or not.

This breaks many examples or intructions in the documentation.

To solve this, we'll use a versioned name of the HyperConverged type. To ease that, this PR defined a new attibute named HCOCliKind, with the value of hyperconvergeds.v1beta1.hco.kubevirt.io. Then the PR replaces any read or write command line operation with hco or hyperconverged, with the new attribute.

This will also ease the fix in future release, to get it back to the shorter, non-versioned name.

Version(s):
v4.22

Issue:
https://redhat.atlassian.net/browse/CNV-78917

Link to docs preview:

QE review:

• QE has approved this change.

Additional information:

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.

[ocpdocs-previewbot]

🤖 Tue Apr 14 08:36:56 - Prow CI generated the docs preview:
https://109992--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

[sjhala-ccs]

LGTM (checking previews now)

[sjhala-ccs]

🤖 Mon Apr 13 15:51:04 - Prow CI generated the docs preview: https://109992--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

@nunnatsa You can see the list of preview urls for all distros at the link above. I randomly checked a few for openshift-enterprise, the attributes resolve correctly for some and not for others. For example, the attributes render correctly for
https://109992--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/live_migration/virt-configuring-live-migration#virt-configuring-live-migration-limits_virt-configuring-live-migration but not for
https://109992--ocpdocs-pr.netlify.app/openshift-enterprise/latest/virt/vm_networking/virt-connecting-vm-to-primary-udn#virt-attaching-vm-to-primary-udn_virt-connecting-vm-to-primary-udn

[openshift-ci]

@nunnatsa: all tests passed!

Full PR test history. Your PR dashboard.

Details

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-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@nunnatsa: This pull request references CNV-78917 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.22.0" version, but no target version was set.

Details

In response to this:

In v4.22, we are intrucing a new API version for the HyperConverged type (A.K.A hco or hyperconverged). This version is not the default one in v4.22, but because of the way kubernetes works, any non-versioned request of this type (get/edit/patch...), will use the newest API version, regadless if it's the default one or not.

This breaks many examples or intructions in the documentation.

To solve this, we'll use a versioned name of the HyperConverged type. To ease that, this PR defined a new attibute named HCOCliKind, with the value of hyperconvergeds.v1beta1.hco.kubevirt.io. Then the PR replaces any read or write command line operation with hco or hyperconverged, with the new attribute.

This will also ease the fix in future release, to get it back to the shorter, non-versioned name.

Version(s):
v4.22

Issue:
https://redhat.atlassian.net/browse/CNV-78917

Link to docs preview:

QE review:

• QE has approved this change.

Additional information:

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.

[sjhala-ccs]

/cherrypick enterprise-4.22

[openshift-cherrypick-robot]

@sjhala-ccs: new pull request created: #110041

Details

In response to this:

/cherrypick enterprise-4.22

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-sigs/prow repository.