Bug 1822266

Summary: Add a note/warning saying that the HyperConverged Cluster CR can be named only kubevirt-hyperconverged
Product: Container Native Virtualization (CNV) Reporter: Simone Tiraboschi <stirabos>
Component: DocumentationAssignee: Pan Ousley <pousley>
Status: CLOSED CURRENTRELEASE QA Contact: Nelly Credi <ncredi>
Severity: high Docs Contact:
Priority: high    
Version: 2.2.0CC: aspauldi, cnv-qe-bugs, danken, ncredi, pousley, rgarcia
Target Milestone: ---   
Target Release: 2.3.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-05-07 20:14:55 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Simone Tiraboschi 2020-04-08 15:49:37 UTC
Document URL: 
https://docs.openshift.com/container-platform/4.3/cnv/cnv_install/installing-container-native-virtualization.html#cnv-deploying-cnv_installing-container-native-virtualization

Section Number and Name:
Deploying container-native virtualization, point 3

Describe the issue:
On point 3, the document says:
Click the KubeVirt HyperConverged Cluster Operator Deployment tab and click Create HyperConverged Cluster.

And everything will be fine if the user simply confirms the proposed example as (implicitly) suggested in the doc.
On the other side, nothing on OCP admin console is explicitly preventing the user from trying to edit the proposed CR changing its name.

Even in 2.2, hco will only look for a CR named "hyperconverged-cluster", see:
https://github.com/kubevirt/hyperconverged-cluster-operator/blob/release-2.2/pkg/controller/hyperconverged/hyperconverged_controller.go#L48

Suggestions for improvement: 
I'd suggest to add an explicit comment/note/warning saying that the HyperConverged Cluster CR can be named only hyperconverged-cluster (which is the value proposed by default).

Additional information:
We are already documenting something similar for the name of the namespace:
You must only install the Operator in the openshift-cnv namespace.

In 2.3, as a new feature, we implemented a validation mechanism to explicitly fail at creation time on CR with a different name but we don't have it on 2.2.

Comment 1 Simone Tiraboschi 2020-04-24 16:51:42 UTC
Sorry, fault of mine:
the CR should be mandatory named `kubevirt-hyperconverged` now in 2.3 and this is exactly the same value we were proposing by default in 2.2

Comment 2 Pan Ousley 2020-04-29 18:48:11 UTC
This PR covers the 2.3 warning: https://github.com/openshift/openshift-docs/pull/21698
This PR covers the 2.2 warning: https://github.com/openshift/openshift-docs/pull/21700

Simone, can you please review these PRs? Thanks!

Comment 3 Pan Ousley 2020-05-04 13:24:07 UTC
Simone gave his +1 on both PRs, so I'm moving this to QE. Nelly, can you please review? Thanks.

Comment 4 Nelly Credi 2020-05-04 13:45:34 UTC
LGTM

Comment 5 Pan Ousley 2020-05-04 13:49:09 UTC
Thanks, Nelly. Merged to enterprise-4.3 and enterprise-4.4.