From 5e13d3c5554c5522e02fc67e8ed4f6525154aebd Mon Sep 17 00:00:00 2001 From: Gabriel McGoldrick Date: Fri, 19 May 2023 12:21:58 +0100 Subject: [PATCH] SRVCOM-2431 fix product title, conditionals in support, logging shared content --- _attributes/common-attributes.adoc | 7 ++--- modules/about-must-gather.adoc | 4 +-- modules/cluster-logging-about.adoc | 2 -- modules/serverless-kafka-developer.adoc | 9 ------- modules/support-knowledgebase-search.adoc | 4 +-- modules/support-submitting-a-case.adoc | 33 +++++------------------ 6 files changed, 12 insertions(+), 47 deletions(-) diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 949fc8c017e1..a4781b881afe 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -139,11 +139,7 @@ :factory-prestaging-tool: factory-precaching-cli tool :factory-prestaging-tool-caps: Factory-precaching-cli tool :openshift-networking: Red Hat OpenShift Networking -// TODO - this probably needs to be different for OKD -//ifdef::openshift-origin[] -//:openshift-networking: OKD Networking -//endif::[] -// logical volume manager storage + :lvms-first: Logical volume manager storage (LVM Storage) :lvms: LVM Storage //Operator SDK version @@ -157,6 +153,7 @@ :ocp-product-title: OpenShift Container Platform +:ocp-product-version: 4.13 :dedicated-product-title: OpenShift Dedicated :aro-product-title: Azure Red Hat OpenShift :rosa-product-title: Red Hat OpenShift Service on AWS diff --git a/modules/about-must-gather.adoc b/modules/about-must-gather.adoc index aff4c9ffea63..64a5e36f95a8 100644 --- a/modules/about-must-gather.adoc +++ b/modules/about-must-gather.adoc @@ -27,7 +27,7 @@ For example: + [source,terminal,subs="attributes+"] ---- -$ oc adm must-gather --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{product-version}.0 +$ oc adm must-gather --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{ocp-product-version}.0 ---- * To collect the audit logs, use the `-- /usr/bin/gather_audit_logs` argument, as described in a following section. @@ -63,5 +63,5 @@ For example: [source,terminal,subs="attributes+"] ---- -$ oc adm must-gather --run-namespace --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{product-version}.0 +$ oc adm must-gather --run-namespace --image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{ocp-product-version}.0 ---- \ No newline at end of file diff --git a/modules/cluster-logging-about.adoc b/modules/cluster-logging-about.adoc index 73f9e1cc1ae2..76ad03f59733 100644 --- a/modules/cluster-logging-about.adoc +++ b/modules/cluster-logging-about.adoc @@ -11,9 +11,7 @@ [id="cluster-logging-about_{context}"] = About deploying the {logging-title} -ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] {ocp-product-title} cluster administrators can deploy the {logging} using the {ocp-product-title} web console or CLI to install the OpenShift Elasticsearch Operator and Red Hat OpenShift Logging Operator. When the Operators are installed, you create a `ClusterLogging` custom resource (CR) to schedule {logging} pods and other resources necessary to support the {logging}. The Operators are responsible for deploying, upgrading, and maintaining the {logging}. -endif::openshift-enterprise,openshift-webscale,openshift-origin[] The `ClusterLogging` CR defines a complete {logging} environment that includes all the components of the logging stack to collect, store and visualize logs. The Red Hat OpenShift Logging Operator watches the {logging} CR and adjusts the logging deployment accordingly. diff --git a/modules/serverless-kafka-developer.adoc b/modules/serverless-kafka-developer.adoc index b57284995e87..fb1772397a3b 100644 --- a/modules/serverless-kafka-developer.adoc +++ b/modules/serverless-kafka-developer.adoc @@ -9,15 +9,6 @@ The Knative broker implementation for Apache Kafka provides integration options for you to use supported versions of the Apache Kafka message streaming platform with {ServerlessProductName}. Kafka provides options for event source, channel, broker, and event sink capabilities. - -// OCP -ifdef::openshift-enterprise[] -[NOTE] -==== -The Knative broker implementation for Apache Kafka is not currently supported for {ibmzProductName} and {ibmpowerProductName} on {ocp-product-title}. -==== -endif::[] - Knative broker for Apache Kafka provides additional options, such as: * Kafka source diff --git a/modules/support-knowledgebase-search.adoc b/modules/support-knowledgebase-search.adoc index 0b79bfae5d8c..f8bc8baa81f2 100644 --- a/modules/support-knowledgebase-search.adoc +++ b/modules/support-knowledgebase-search.adoc @@ -21,12 +21,12 @@ In the event of an {product-title} issue, you can perform an initial search to d . In the main Red Hat Customer Portal search field, input keywords and strings relating to the problem, including: + -* {product-title} components (such as *etcd*) +* {ocp-product-title} components (such as *etcd*) * Related procedure (such as *installation*) * Warnings, error messages, and other outputs related to explicit failures . Click *Search*. -. Select the *{product-title}* product filter. +. Select the *{ocp-product-title}* product filter. . Select the *Knowledgebase* content type filter. diff --git a/modules/support-submitting-a-case.adoc b/modules/support-submitting-a-case.adoc index 6fd04be8ecb8..f5dae4a02d55 100644 --- a/modules/support-submitting-a-case.adoc +++ b/modules/support-submitting-a-case.adoc @@ -11,29 +11,17 @@ .Prerequisites -ifndef::openshift-dedicated[] + * You have access to the cluster as a user with the `cluster-admin` role. * You have installed the OpenShift CLI (`oc`). -endif::openshift-dedicated[] -ifdef::openshift-dedicated[] -* You have access to the {cluster-manager-first}. -endif::openshift-dedicated[] * You have a Red Hat Customer Portal account. -ifndef::openshift-dedicated[] * You have a Red Hat standard or premium Subscription. -endif::openshift-dedicated[] .Procedure . Log in to the link:http://access.redhat.com[Red Hat Customer Portal] and select *SUPPORT CASES* -> *Open a case*. -. Select the appropriate category for your issue (such as *Defect / Bug*), product (*{product-title}*), and product version -ifndef::openshift-dedicated[] -(*{product-version}*, -endif::openshift-dedicated[] -ifdef::openshift-dedicated[] -(*{product-title}*, -endif::openshift-dedicated[] +. Select the appropriate category for your issue (such as *Defect / Bug*), product (*{ocp-product-title}*), and product version if this is not already autofilled). . Review the list of suggested Red Hat Knowledgebase solutions for a potential match against the problem that is being reported. If the suggested articles do not address the issue, click *Continue*. @@ -45,20 +33,12 @@ if this is not already autofilled). . Ensure that the account information presented is as expected, and if not, amend accordingly. . Check that the autofilled {product-title} Cluster ID is correct. If it is not, manually obtain your cluster ID. -ifdef::openshift-dedicated[] -+ -* To manually obtain your cluster ID using {cluster-manager-url}: -.. Navigate to *Clusters*. -.. Click on the name of the cluster you need to open a support case for. -.. Find the value in the *Cluster ID* field of the *Details* section of the *Overview* tab. -endif::openshift-dedicated[] -ifndef::openshift-dedicated[] + -* To manually obtain your cluster ID using the {product-title} web console: +* To manually obtain your cluster ID using the {ocp-product-title} web console: .. Navigate to *Home* -> *Dashboards* -> *Overview*. .. Find the value in the *Cluster ID* field of the *Details* section. + -* Alternatively, it is possible to open a new support case through the {product-title} web console and have your cluster ID autofilled. +* Alternatively, it is possible to open a new support case through the {ocp-product-title} web console and have your cluster ID autofilled. .. From the toolbar, navigate to *(?) Help* -> *Open Support Case*. .. The *Cluster ID* value is autofilled. + @@ -68,7 +48,6 @@ ifndef::openshift-dedicated[] ---- $ oc get clusterversion -o jsonpath='{.items[].spec.clusterID}{"\n"}' ---- -endif::openshift-dedicated[] . Complete the following questions where prompted and then click *Continue*: + @@ -77,9 +56,9 @@ endif::openshift-dedicated[] * What information can you provide around time-frames and the business impact? . Upload relevant diagnostic data files and click *Continue*. -ifndef::openshift-dedicated[] + It is recommended to include data gathered using the `oc adm must-gather` command as a starting point, plus any issue specific data that is not collected by that command. -endif::openshift-dedicated[] + . Input relevant case management details and click *Continue*.