From aa4a7bccd4df03e0d38daba07b98fd902eec0cbe Mon Sep 17 00:00:00 2001 From: Dan Kenigsberg Date: Sat, 11 Jan 2020 17:17:02 +0200 Subject: [PATCH] Updating CNV Operator naming for 4.3 --- ...lling-container-native-virtualization.adoc | 2 +- ...lling-container-native-virtualization.adoc | 4 ++-- cnv/cnv-release-notes/cnv-release-notes.adoc | 2 +- ...ading-container-native-virtualization.adoc | 2 +- .../cnv-deleting-catalog-subscription.adoc | 21 +++++++++++++++++++ modules/cnv-deleting-custom-resource.adoc | 19 ++++++----------- modules/cnv-deleting-hco-subscription.adoc | 21 ------------------- modules/cnv-deploying-cnv.adoc | 9 ++++---- modules/cnv-monitoring-upgrade-status.adoc | 2 +- ...oc => cnv-subscribing-to-the-catalog.adoc} | 17 +++++++-------- 10 files changed, 45 insertions(+), 54 deletions(-) create mode 100644 modules/cnv-deleting-catalog-subscription.adoc delete mode 100644 modules/cnv-deleting-hco-subscription.adoc rename modules/{cnv-subscribing-to-hco-catalog.adoc => cnv-subscribing-to-the-catalog.adoc} (67%) diff --git a/cnv/cnv-install/installing-container-native-virtualization.adoc b/cnv/cnv-install/installing-container-native-virtualization.adoc index d36de71ed5a7..a5023ace1bbd 100644 --- a/cnv/cnv-install/installing-container-native-virtualization.adoc +++ b/cnv/cnv-install/installing-container-native-virtualization.adoc @@ -19,6 +19,6 @@ include::modules/technology-preview.adoc[leveloffset=+1] include::modules/cnv-preparing-to-install.adoc[leveloffset=+1] -include::modules/cnv-subscribing-to-hco-catalog.adoc[leveloffset=+2] +include::modules/cnv-subscribing-to-the-catalog.adoc[leveloffset=+1] include::modules/cnv-deploying-cnv.adoc[leveloffset=+1] diff --git a/cnv/cnv-install/uninstalling-container-native-virtualization.adoc b/cnv/cnv-install/uninstalling-container-native-virtualization.adoc index 19959ec5ed9f..6f6739eae3eb 100644 --- a/cnv/cnv-install/uninstalling-container-native-virtualization.adoc +++ b/cnv/cnv-install/uninstalling-container-native-virtualization.adoc @@ -9,11 +9,11 @@ xref:../../web-console/web-console.adoc#web-console-overview_web-console[web con .Prerequisites -* {CNVProductNameStart} 2.1 +* {CNVProductNameStart} {CNVVersion} include::modules/cnv-deleting-custom-resource.adoc[leveloffset=+1] -include::modules/cnv-deleting-hco-subscription.adoc[leveloffset=+1] +include::modules/cnv-deleting-catalog-subscription.adoc[leveloffset=+1] [NOTE] ==== diff --git a/cnv/cnv-release-notes/cnv-release-notes.adoc b/cnv/cnv-release-notes/cnv-release-notes.adoc index d58bcda0f023..5104f3d58d71 100644 --- a/cnv/cnv-release-notes/cnv-release-notes.adoc +++ b/cnv/cnv-release-notes/cnv-release-notes.adoc @@ -187,7 +187,7 @@ nodes. from the Operator Lifecycle Manager (OLM). This issue is caused by the limitations associated with using a declarative API to track the state of {CNVProductName} Operators. Enabling automatic updates during -xref:../cnv-install/installing-container-native-virtualization.adoc#cnv-subscribing-to-hco-catalog_installing-container-native-virtualization[installation] +xref:../cnv-install/installing-container-native-virtualization.adoc#cnv-subscribing-to-the-catalog_installing-container-native-virtualization[installation] decreases the risk of encountering this issue. (link:https://bugzilla.redhat.com/show_bug.cgi?id=1759612[*BZ#1759612*]) diff --git a/cnv/upgrading-container-native-virtualization.adoc b/cnv/upgrading-container-native-virtualization.adoc index c3a73ffdc35a..9435a8638166 100644 --- a/cnv/upgrading-container-native-virtualization.adoc +++ b/cnv/upgrading-container-native-virtualization.adoc @@ -4,7 +4,7 @@ include::modules/cnv-document-attributes.adoc[] :context: upgrading-container-native-virtualization toc::[] -You enable automatic updates during {CNVProductName} xref:../cnv/cnv-install/installing-container-native-virtualization.adoc#cnv-subscribing-to-hco-catalog_installing-container-native-virtualization[installation]. +You enable automatic updates during {CNVProductName} xref:../cnv/cnv-install/installing-container-native-virtualization.adoc#cnv-subscribing-to-the-catalog_installing-container-native-virtualization[installation]. Learn what to expect and how you can check the status of an update in progress. :FeatureName: {CNVProductNameStart} diff --git a/modules/cnv-deleting-catalog-subscription.adoc b/modules/cnv-deleting-catalog-subscription.adoc new file mode 100644 index 000000000000..bd31b7c3fc9d --- /dev/null +++ b/modules/cnv-deleting-catalog-subscription.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * cnv/cnv_install/uninstalling-container-native-virtualization.adoc + +[id="cnv-deleting-catalog-subscription_{context}"] += Deleting the {CNVProductNameStart} catalog subscription + +To finish uninstalling {CNVProductName}, delete the +*{CNVProductNameStart}* catalog subscription. + +.Prerequisites + +* An active subscription to the *{CNVProductNameStart}* catalog + +.Procedure + +. Navigate to the *Operators* -> *OperatorHub* page. + +. Search for *{CNVProductNameStart}* and then select it. + +. Click *Uninstall*. diff --git a/modules/cnv-deleting-custom-resource.adoc b/modules/cnv-deleting-custom-resource.adoc index 0c14f5c298fe..2230f56b9b38 100644 --- a/modules/cnv-deleting-custom-resource.adoc +++ b/modules/cnv-deleting-custom-resource.adoc @@ -3,7 +3,7 @@ // * cnv/cnv_install/uninstalling-container-native-virtualization.adoc [id="cnv-deleting-kubevirt-hyperconverged-custom-resource_{context}"] -= Deleting the KubeVirt HyperConverged custom resource += Deleting the KubeVirt HyperConverged Cluster Operator Deployment custom resource To uninstall {CNVProductName}, you must first delete the *KubeVirt HyperConverged Cluster Operator Deployment* custom resource. @@ -19,29 +19,22 @@ the *Projects* list. . Navigate to the *Operators* -> *Installed Operators* page. -. Click *KubeVirt HyperConverged Cluster Operator*. +. Click *{CNVProductNameStart}*. . Click the *KubeVirt HyperConverged Cluster Operator Deployment* tab. -. Click the Options menu {kebab} in the row containing the *hyperconverged-cluster* -custom resource. In the expanded menu, click *Delete HyperConverged*. +. Click the Options menu {kebab} in the row containing the *kubevirt-hyperconverged* +custom resource. In the expanded menu, click *Delete HyperConverged Cluster*. . Click *Delete* in the confirmation window. . Navigate to the *Workloads* -> *Pods* page to verify that only the Operator Pods are running. -. Open a terminal window and clean up the remaining KubeVirt resources by running +. Open a terminal window and clean up the remaining resources by running the following command: + ---- $ oc delete apiservices v1alpha3.subresources.kubevirt.io -n openshift-cnv ---- -+ -[NOTE] -==== -Because some KubeVirt resources are currently improperly retained, you must -manually remove them. These resources will be removed automatically after -(link:https://bugzilla.redhat.com/show_bug.cgi?id=1712429[*BZ1712429*]) is -resolved. -==== + diff --git a/modules/cnv-deleting-hco-subscription.adoc b/modules/cnv-deleting-hco-subscription.adoc deleted file mode 100644 index 1ad13a85355f..000000000000 --- a/modules/cnv-deleting-hco-subscription.adoc +++ /dev/null @@ -1,21 +0,0 @@ -// Module included in the following assemblies: -// -// * cnv/cnv_install/uninstalling-container-native-virtualization.adoc - -[id="cnv-deleting-hco-subscription_{context}"] -= Deleting the KubeVirt HyperConverged Cluster Operator catalog subscription - -To finish uninstalling {CNVProductName}, uninstall the -*KubeVirt HyperConverged Cluster Operator subscription*. - -.Prerequisites - -* An active *KubeVirt HyperConverged Cluster Operator* catalog subscription - -.Procedure - -. Navigate to the *Catalog -> OperatorHub* page. - -. Locate the *KubeVirt HyperConverged Cluster Operator* and then select it. - -. Click *Uninstall*. diff --git a/modules/cnv-deploying-cnv.adoc b/modules/cnv-deploying-cnv.adoc index d53d2350c1e8..f254f5997aab 100644 --- a/modules/cnv-deploying-cnv.adoc +++ b/modules/cnv-deploying-cnv.adoc @@ -3,22 +3,21 @@ // * cnv/cnv_install/installing-container-native-virtualization.adoc [id="cnv-deploying-cnv_{context}"] -= Deploying container-native virtualization += Deploying {CNVProductName} -After subscribing to the *KubeVirt HyperConverged Cluster Operator* catalog, +After subscribing to the *{CNVProductNameStart}* catalog, create the *KubeVirt HyperConverged Cluster Operator Deployment* custom resource to deploy {CNVProductName}. .Prerequisites -* An active subscription to the *KubeVirt HyperConverged Cluster Operator* catalog -in the `openshift-cnv` namespace +* An active subscription to the *{CNVProductNameStart}* catalog in the `openshift-cnv` namespace .Procedure . Navigate to the *Operators* -> *Installed Operators* page. -. Click *KubeVirt HyperConverged Cluster Operator*. +. Click *{CNVProductNameStart}*. . Click the *KubeVirt HyperConverged Cluster Operator Deployment* tab and click *Create HyperConverged Cluster*. diff --git a/modules/cnv-monitoring-upgrade-status.adoc b/modules/cnv-monitoring-upgrade-status.adoc index 0078d0070ed6..916084c2a7de 100644 --- a/modules/cnv-monitoring-upgrade-status.adoc +++ b/modules/cnv-monitoring-upgrade-status.adoc @@ -40,7 +40,7 @@ VERSION REPLACES PHASE conditions by running the following command: + ---- -$ oc get hco -n openshift-cnv hyperconverged-cluster \ +$ oc get hco -n openshift-cnv kubevirt-hyperconverged \ -o=jsonpath='{range .status.conditions[*]}{.type}{"\t"}{.status}{"\t"}{.message}{"\n"}{end}' ---- + diff --git a/modules/cnv-subscribing-to-hco-catalog.adoc b/modules/cnv-subscribing-to-the-catalog.adoc similarity index 67% rename from modules/cnv-subscribing-to-hco-catalog.adoc rename to modules/cnv-subscribing-to-the-catalog.adoc index 8f1144f4afe4..edc05c5211b4 100644 --- a/modules/cnv-subscribing-to-hco-catalog.adoc +++ b/modules/cnv-subscribing-to-the-catalog.adoc @@ -2,13 +2,13 @@ // // * cnv/cnv_install/installing-container-native-virtualization.adoc -[id="cnv-subscribing-to-hco-catalog_{context}"] -= Subscribing to the KubeVirt HyperConverged Cluster Operator catalog +[id="cnv-subscribing-to-the-catalog_{context}"] += Subscribing to the {CNVProductNameStart} catalog Before you install {CNVProductName}, subscribe to the -*KubeVirt HyperConverged Cluster Operator* catalog from -the {product-title} web console. Subscribing gives the `openshift-cnv` -namespace access to the {CNVProductName} Operators. +*{CNVProductNameStart}* catalog from the {product-title} web console. +Subscribing gives the `openshift-cnv` namespace access to the {CNVProductName} +Operators. .Prerequisites @@ -20,7 +20,7 @@ namespace access to the {CNVProductName} Operators. . Navigate to the *Operators* → *OperatorHub* page. -. Locate the *KubeVirt HyperConverged Cluster Operator* and then select it. +. Search for *{CNVProductNameStart}* and then select it. . Read the information about the Operator and click *Install*. @@ -35,11 +35,10 @@ list and choose the `openshift-cnv` namespace. in the cluster. This option is *not* supported for use with {CNVProductName}. You must only install the Operator in the `openshift-cnv` namespace. ==== -.. Select *2.1* from the list of available *Update Channel* options. +.. Select *{CNVVersion}* from the list of available *Update Channel* options. .. For *Approval Strategy*, ensure that *Automatic*, which is the default value, is selected. {CNVProductNameStart} automatically updates when a new z-stream release is available. -. Click *Subscribe* to make the Operator available to the selected namespaces on -this {product-title} cluster. +. Click *Subscribe* to make the Operator available to the `openshift-cnv` namespace.