OSDOCS-2869 - Migrating common SD files in the Support book

pneedle-rh · pneedle-rh · commit 30a67901aa50 · 2021-11-23T10:21:26.000Z
diff --git a/modules/about-must-gather.adoc b/modules/about-must-gather.adoc
@@ -1,11 +1,12 @@
 // Module included in the following assemblies:
 //
+// * sandboxed_containers/troubleshooting-sandboxed-containers.adoc
 // * virt/logging_events_monitoring/virt-collecting-virt-data.adoc
 // * support/gathering-cluster-data.adoc
-// * serverless/serverless-support.adoc
+// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
+// * service_mesh/v2x/ossm-support.adoc
 // * service_mesh/v1x/servicemesh-release-notes.adoc
-// * service_mesh/v2x/servicemesh-release-notes.adoc
-// * troubleshooting-sandboxed-containers.adoc
+// * serverless/serverless-support.adoc
 
 [id="about-must-gather_{context}"]
 = About the must-gather tool
diff --git a/modules/common-attributes.adoc b/modules/common-attributes.adoc
@@ -41,4 +41,10 @@ endif::[]
 :launch: image:app-launcher.png[title="Application Launcher"]
 :mtc-short: MTC
 :mtc-full: Migration Toolkit for Containers
+ifndef::openshift-dedicated[]
 :mtc-version: 1.6
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+:mtc-version: 1.4
+:mtc-version-z: 1.4.1
+endif::openshift-dedicated[]
diff --git a/modules/gathering-data-specific-features.adoc b/modules/gathering-data-specific-features.adoc
@@ -35,17 +35,25 @@ ifndef::openshift-origin[]
 |`registry.redhat.io/openshift-service-mesh/istio-must-gather-rhel8`
 |Data collection for Red Hat OpenShift Service Mesh.
 
+ifndef::openshift-dedicated[]
 |`registry.redhat.io/rhmtc/openshift-migration-must-gather-rhel8:v{mtc-version}`
 |Data collection for the {mtc-full}.
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+|`registry.redhat.io/rhcam-1-2/openshift-migration-must-gather-rhel8`
+|Data collection for migration-related information.
+endif::openshift-dedicated[]
 
 |`registry.redhat.io/ocs4/ocs-must-gather-rhel8:v4.9`
 |Data collection for Red Hat OpenShift Container Storage.
 
 |`registry.redhat.io/openshift4/ose-cluster-logging-operator`
 |Data collection for OpenShift Logging.
 
+ifndef::openshift-dedicated[]
 |`registry.redhat.io/openshift4/ose-local-storage-mustgather-rhel8`
 |Data collection for Local Storage Operator.
+endif::openshift-dedicated[]
 
 |===
 
@@ -76,8 +84,10 @@ ifdef::openshift-origin[]
 |`quay.io/openshift/origin-cluster-logging-operator`
 |Data collection for OpenShift Logging.
 
+ifndef::openshift-dedicated[]
 |`quay.io/openshift/origin-local-storage-mustgather`
 |Data collection for Local Storage Operator.
+endif::openshift-dedicated[]
 
 |===
 
@@ -94,7 +104,12 @@ To collect the default `must-gather` data in addition to specific feature data,
 .Prerequisites
 
 * Access to the cluster as a user with the `cluster-admin` role.
+ifndef::openshift-dedicated[]
 * The {product-title} CLI (`oc`) installed.
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+* The OpenShift CLI (`oc`) installed.
+endif::openshift-dedicated[]
 
 .Procedure
 
@@ -113,7 +128,14 @@ $ oc adm must-gather \
 <1> The default {product-title} `must-gather` image
 <2> The must-gather image for {VirtProductName}
 +
-You can use the `must-gather` tool with additional arguments to gather data that is specifically related to OpenShift Logging and the Red Hat OpenShift Logging Operator in your cluster. For OpenShift Logging, run the following command:
+You can use the `must-gather` tool with additional arguments to gather data that is specifically related to OpenShift Logging and the 
+ifndef::openshift-dedicated[]
+Red Hat OpenShift 
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+Cluster 
+endif::openshift-dedicated[]
+Logging Operator in your cluster. For OpenShift Logging, run the following command:
 +
 [source,terminal]
 ----
@@ -136,6 +158,10 @@ $ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/clust
 │  │  └── logforwarding_cr
 │  ├── collector
 │  │  ├── fluentd-2tr64
+ifdef::openshift-dedicated[]
+│  ├── curator
+│  │  └── curator-1596028500-zkz4s
+endif::openshift-dedicated[]
 │  ├── eo
 │  │  ├── csv
 │  │  ├── deployment
@@ -183,12 +209,24 @@ $ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/clust
    │  │  ├── configmaps.yaml
    │  │  ├── endpoints.yaml
    │  │  ├── events
+ifndef::openshift-dedicated[]
    │  │  │  ├── elasticsearch-im-app-1596020400-gm6nl.1626341a296c16a1.yaml
    │  │  │  ├── elasticsearch-im-audit-1596020400-9l9n4.1626341a2af81bbd.yaml
    │  │  │  ├── elasticsearch-im-infra-1596020400-v98tk.1626341a2d821069.yaml
    │  │  │  ├── elasticsearch-im-app-1596020400-cc5vc.1626341a3019b238.yaml
    │  │  │  ├── elasticsearch-im-audit-1596020400-s8d5s.1626341a31f7b315.yaml
    │  │  │  ├── elasticsearch-im-infra-1596020400-7mgv8.1626341a35ea59ed.yaml
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+   │  │  │  ├── curator-1596021300-wn2ks.162634ebf0055a94.yaml
+   │  │  │  ├── curator.162638330681bee2.yaml
+   │  │  │  ├── elasticsearch-delete-app-1596020400-gm6nl.1626341a296c16a1.yaml
+   │  │  │  ├── elasticsearch-delete-audit-1596020400-9l9n4.1626341a2af81bbd.yaml
+   │  │  │  ├── elasticsearch-delete-infra-1596020400-v98tk.1626341a2d821069.yaml
+   │  │  │  ├── elasticsearch-rollover-app-1596020400-cc5vc.1626341a3019b238.yaml
+   │  │  │  ├── elasticsearch-rollover-audit-1596020400-s8d5s.1626341a31f7b315.yaml
+   │  │  │  ├── elasticsearch-rollover-infra-1596020400-7mgv8.1626341a35ea59ed.yaml
+endif::openshift-dedicated[]
    │  │  ├── events.yaml
    │  │  ├── persistentvolumeclaims.yaml
    │  │  ├── pods.yaml
@@ -219,9 +257,18 @@ $ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/clust
    │  │  │           ├── current.log
    │  │  │           ├── previous.insecure.log
    │  │  │           └── previous.log
+ifdef::openshift-dedicated[]
+   │  │  ├── curator-1596028500-zkz4s
+endif::openshift-dedicated[]
    │  │  ├── elasticsearch-cdm-lp8l38m0-1-794d6dd989-4jxms
+ifndef::openshift-dedicated[]
    │  │  ├── elasticsearch-im-app-1596030300-bpgcx
    │  │  │  ├── elasticsearch-im-app-1596030300-bpgcx.yaml
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+   │  │  ├── elasticsearch-delete-app-1596030300-bpgcx
+   │  │  │  ├── elasticsearch-delete-app-1596030300-bpgcx.yaml
+endif::openshift-dedicated[]
    │  │  │  └── indexmanagement
    │  │  │     └── indexmanagement
    │  │  │        └── logs
diff --git a/modules/insights-operator-what-information-is-collected.adoc b/modules/insights-operator-what-information-is-collected.adoc
@@ -12,6 +12,7 @@ The following information is collected by the Insights Operator:
 * Errors that occur in the cluster components
 * Progress information of running updates, and the status of any component upgrades
 * Details of the platform that {product-title} is deployed on, such as Amazon Web Services, and the region that the cluster is located in
+ifndef::openshift-dedicated[]
 * Cluster workload information transformed into discreet Secure Hash Algorithm (SHA) values, which allows Red Hat to assess workloads for security and version vulnerabilities without disclosing sensitive details
+endif::openshift-dedicated[]
 * If an Operator reports an issue, information is collected about core {product-title} pods in the `openshift-&#42;` and `kube-&#42;` projects. This includes state, resource, security context, volume information, and more.
-
diff --git a/modules/querying-bootstrap-node-journal-logs.adoc b/modules/querying-bootstrap-node-journal-logs.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * support/troubleshooting/gathering-cluster-data.adoc
+// * support/gathering-cluster-data.adoc
 
 [id="querying-bootstrap-node-journal-logs_{context}"]
 = Querying bootstrap node journal logs
diff --git a/modules/support-gather-data.adoc b/modules/support-gather-data.adoc
@@ -10,7 +10,12 @@ You can gather debugging information about your cluster by using the `oc adm mus
 .Prerequisites
 
 * Access to the cluster as a user with the `cluster-admin` role.
+ifndef::openshift-dedicated[]
 * The {product-title} CLI (`oc`) installed.
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+* The OpenShift CLI (`oc`) installed.
+endif::openshift-dedicated[]
 
 .Procedure
 
diff --git a/modules/support-generating-a-sosreport-archive.adoc b/modules/support-generating-a-sosreport-archive.adoc
@@ -32,6 +32,7 @@ $ oc get nodes
 $ oc debug node/my-cluster-node
 ----
 +
+ifndef::openshift-dedicated[]
 To enter into a debug session on the target node that is tainted with the `NoExecute` effect, add a toleration to a dummy namespace, and start the debug pod in the dummy namespace:
 +
 [source,terminal]
@@ -49,6 +50,7 @@ $ oc patch namespace dummy --type=merge -p '{"metadata": {"annotations": { "sche
 $ oc debug node/my-cluster-node
 ----
 +
+endif::openshift-dedicated[]
 . Set `/host` as the root directory within the debug shell. The debug pod mounts the host's root file system in `/host` within the pod. By changing the root directory to `/host`, you can run binaries contained in the host's executable paths:
 +
 [source,terminal]
diff --git a/modules/support-knowledgebase-about.adoc b/modules/support-knowledgebase-about.adoc
@@ -1,6 +1,8 @@
 // Module included in the following assemblies:
 //
-// * support/support-redhat-knowledgebase.adoc
+// * support/getting-support.adoc
+// * support/index.adoc
+// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
 
 [id="support-knowledgebase-about_{context}"]
 = About the Red Hat Knowledgebase
diff --git a/modules/support-knowledgebase-search.adoc b/modules/support-knowledgebase-search.adoc
@@ -1,6 +1,8 @@
 // Module included in the following assemblies:
 //
-// * support/support-redhat-knowledgebase.adoc
+// * support/getting-support.adoc
+// * support/index.adoc
+// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
 
 [id="support-knowledgebase-search_{context}"]
 = Searching the Red Hat Knowledgebase
diff --git a/modules/support-submitting-a-case.adoc b/modules/support-submitting-a-case.adoc
@@ -1,6 +1,8 @@
 // Module included in the following assemblies:
 //
 // * support/getting-support.adoc
+// * support/index.adoc
+// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
 
 [id="support-submitting-a-case_{context}"]
 = Submitting a support case
@@ -16,7 +18,14 @@
 
 . 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 (*{product-version}*, if this is not already autofilled).
+. 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[]
+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*.
 
diff --git a/modules/support.adoc b/modules/support.adoc
@@ -1,8 +1,12 @@
 // Module included in the following assemblies:
 //
 // * support/getting-support.adoc
+// * support/index.adoc
+// * service_mesh/v2x/ossm-troubleshooting-istio.adoc
+// * service_mesh/v2x/ossm-support.adoc
 // * service_mesh/v1x/servicemesh-release-notes.adoc
-// * service_mesh/v2x/servicemesh-release-notes.adoc
+// * security/compliance_operator/compliance-operator-troubleshooting.adoc
+// * jaeger/rhbjaeger-release-notes.adoc
 
 [id="support_{context}"]
 = Getting support
diff --git a/modules/telemetry-what-information-is-collected.adoc b/modules/telemetry-what-information-is-collected.adoc
@@ -29,7 +29,9 @@ endif::virt-cluster[]
 * Events for all namespaces listed as "related objects" for a degraded Operator
 * Configuration details that help Red Hat Support to provide beneficial support for customers, including node configuration at the cloud infrastructure level, hostnames, IP addresses, Kubernetes pod names, namespaces, and services
 * Information about the validity of certificates
+ifndef::openshift-dedicated[]
 * Number of application builds by build strategy type
+endif::openshift-dedicated[]
 
 Telemetry does not collect identifying information such as user names or passwords. Red Hat does not intend to collect personal information. If Red Hat discovers that personal information has been inadvertently received, Red Hat will delete such information. To the extent that any telemetry data constitutes personal data, please refer to the link:https://www.redhat.com/en/about/privacy-policy[Red Hat Privacy Statement] for more information about Red Hat's privacy practices.
 
diff --git a/modules/understanding-telemetry-and-insights-operator-data-flow.adoc b/modules/understanding-telemetry-and-insights-operator-data-flow.adoc
@@ -14,4 +14,8 @@ All of the communication with Red Hat occurs over encrypted channels by using Tr
 Access to the systems that handle customer data is controlled through multi-factor authentication and strict authorization controls. Access is granted on a need-to-know basis and is limited to required operations.
 
 .Telemetry and Insights Operator data flow
-image:telmetry-and-insights-operator-data-flow.svg[Telemetry and Insights Operator data flow]
+image:telmetry-and-insights-operator-data-flow.svg[Telemetry and Insights Operator data flow]
+
+ifdef::openshift-dedicated[]
+// TODO: Not critical for now, but should this diagram be updated to say "OpenShift Dedicated" instead of "OpenShift Container Platform"?
+endif::openshift-dedicated[]
diff --git a/modules/virt-document-attributes.adoc b/modules/virt-document-attributes.adoc
@@ -12,9 +12,16 @@
 :VirtProductName: OpenShift Virtualization
 :ProductRelease:
 :ProductVersion:
+ifndef::openshift-dedicated[]
 :VirtVersion: 4.9
 :KubeVirtVersion: v0.44.2
 :HCOVersion: 4.9.0
+endif::openshift-dedicated[]
+ifdef::openshift-dedicated[]
+:VirtVersion: 2.6
+:KubeVirtVersion: v0.36.2
+:HCOVersion: 2.6.0
+endif::openshift-dedicated[]
 // :LastHCOVersion:
 :product-build:
 :DownloadURL: registry.access.redhat.com
diff --git a/support/gathering-cluster-data.adoc b/support/gathering-cluster-data.adoc
@@ -2,6 +2,9 @@
 = Gathering data about your cluster
 include::modules/common-attributes.adoc[]
 include::modules/virt-document-attributes.adoc[]
+ifdef::openshift-dedicated[]
+include::modules/attributes-openshift-dedicated.adoc[]
+endif::[]
 :context: gathering-cluster-data
 
 toc::[]
diff --git a/support/getting-support.adoc b/support/getting-support.adoc
@@ -1,6 +1,9 @@
 [id="getting-support"]
 = Getting support
 include::modules/common-attributes.adoc[]
+ifdef::openshift-dedicated[]
+include::modules/attributes-openshift-dedicated.adoc[]
+endif::[]
 :context: getting-support
 
 toc::[]
@@ -15,6 +18,7 @@ include::modules/support-submitting-a-case.adoc[leveloffset=+1]
 
 endif::openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-origin[]
 
+[id="getting-support-additional-resources"]
 == Additional resources
 
 * For details about identifying issues with your cluster, see xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster].
diff --git a/support/remote_health_monitoring/about-remote-health-monitoring.adoc b/support/remote_health_monitoring/about-remote-health-monitoring.adoc
@@ -1,6 +1,9 @@
 [id="about-remote-health-monitoring"]
 = About remote health monitoring
 include::modules/common-attributes.adoc[]
+ifdef::openshift-dedicated[]
+include::modules/attributes-openshift-dedicated.adoc[]
+endif::[]
 :context: about-remote-health-monitoring
 
 toc::[]
@@ -35,41 +38,53 @@ endif::[]
 
 include::modules/telemetry-about-telemetry.adoc[leveloffset=+1]
 
+ifndef::openshift-dedicated[]
 .Additional resources
 
 * See the xref:../../updating/updating-cluster-between-minor.adoc#updating-cluster-between-minor[{product-title} update documentation] for more information about updating or upgrading a cluster.
+endif::[]
 
 include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2]
 
+ifndef::openshift-dedicated[]
 .Additional resources
 
 * See xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by Telemetry] for details about how to list the attributes that Telemetry gathers from Prometheus in {product-title}.
 
 * See the link:https://github.com/openshift/cluster-monitoring-operator/blob/master/manifests/0000_50_cluster-monitoring-operator_04-config.yaml[upstream cluster-monitoring-operator source code] for a list of the attributes that Telemetry gathers from Prometheus.
 
 * Telemetry is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
+endif::[]
 
 include::modules/insights-operator-about.adoc[leveloffset=+1]
 
 .Additional resources
 
 * The Insights Operator is installed and enabled by default. If you need to opt out of remote health reporting, see xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
 
+ifdef::openshift-dedicated[]
+// TODO: When you click on that link, you actually can't opt out. Should this additional resources link be removed?
+endif::[]
+
 include::modules/insights-operator-what-information-is-collected.adoc[leveloffset=+2]
 
 .Additional resources
 
+ifndef::openshift-dedicated[]
 * See xref:../../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.html#insights-operator-showing-data-collected-from-the-cluster_showing-data-collected-by-remote-health-monitoring[Showing data collected by the Insights Operator] for details about how to review the data that is collected by the Insights Operator.
+endif::[]
 
 * The Insights Operator source code is available for review and contribution. See the link:https://github.com/openshift/insights-operator/blob/master/docs/gathered-data.md[Insights Operator upstream project] for a list of the items collected by the Insights Operator.
 
 include::modules/understanding-telemetry-and-insights-operator-data-flow.adoc[leveloffset=+1]
 
+ifndef::openshift-dedicated[]
 .Additional resources
 
 * See xref:../../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack_understanding-the-monitoring-stack[Understanding the monitoring stack] for more information about the {product-title} monitoring stack.
 
 * See xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[Configuring your firewall] for details about configuring a firewall and enabling endpoints for Telemetry and Insights
+endif::[]
 
 [id="additional-details-about-how-remote-health-monitoring-data-is-used"]
 == Additional details about how remote health monitoring data is used
@@ -93,3 +108,7 @@ Red Hat may engage certain service providers to assist in the collection and sto
 .User control / enabling and disabling telemetry and configuration data collection
 
 You may disable {product-title} Telemetry and the Insights Operator by following the instructions in xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting[Opting out of remote health reporting].
+
+ifdef::openshift-dedicated[]
+// TODO: Same question about should this be removed or updated, since you can't actually opt out for dedicated?
+endif::[]
diff --git a/support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc b/support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc
diff --git a/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc b/support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc
diff --git a/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc b/support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc
diff --git a/support/summarizing-cluster-specifications.adoc b/support/summarizing-cluster-specifications.adoc

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ $ oc get nodes`
`32`	`32`	`$ oc debug node/my-cluster-node`
`33`	`33`	`----`
`34`	`34`	`+`
	`35`	`+ifndef::openshift-dedicated[]`
`35`	`36`	To enter into a debug session on the target node that is tainted with the `NoExecute` effect, add a toleration to a dummy namespace, and start the debug pod in the dummy namespace:
`36`	`37`	`+`
`37`	`38`	`[source,terminal]`
`@@ -49,6 +50,7 @@ $ oc patch namespace dummy --type=merge -p '{"metadata": {"annotations": { "sche`
`49`	`50`	`$ oc debug node/my-cluster-node`
`50`	`51`	`----`
`51`	`52`	`+`
	`53`	`+endif::openshift-dedicated[]`
`52`	`54`	. Set `/host` as the root directory within the debug shell. The debug pod mounts the host's root file system in `/host` within the pod. By changing the root directory to `/host`, you can run binaries contained in the host's executable paths:
`53`	`55`	`+`
`54`	`56`	`[source,terminal]`