openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity
Files
fa17000dd2051bbd12553e7eaab35689f0bae0e2
openshift-docs/modules/gathering-data-specific-features.adoc
Erin Donnelly fa17000dd2 Rebase 
Fix missed instances of OCS and replaced with ODF

Minor fixes

fix build error

Add IBM Power and Z

Fix build error

Fix errors

attempt at build fix
2022-04-01 21:25:41 +00:00

344 lines
13 KiB
Plaintext
Raw Blame History

// Module included in the following assemblies:
//
// * virt/logging_events_monitoring/virt-collecting-virt-data.adoc
// * support/gathering-cluster-data.adoc
//This file contains UI elements and/or package names that need to be updated.
ifeval::["{context}" == "gathering-cluster-data"]
:from-main-support-section:
:VirtProductName: OpenShift Virtualization
endif::[]
:_content-type: PROCEDURE
[id="gathering-data-specific-features_{context}"]
= Gathering data about specific features
You can gather debugging information about specific features by using the `oc adm must-gather` CLI command with the `--image` or `--image-stream` argument. The `must-gather` tool supports multiple images, so you can gather data about more than one feature by running a single command.
ifdef::from-main-support-section[]
ifndef::openshift-origin[]
.Supported must-gather images
[cols="2,2",options="header",subs="attributes+"]
|===
|Image |Purpose
|`registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{HCOVersion}`
|Data collection for {VirtProductName}.
|`registry.redhat.io/openshift-serverless-1/svls-must-gather-rhel8`
|Data collection for OpenShift Serverless.
|`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 {rh-storage-first}.
|`registry.redhat.io/openshift-logging/cluster-logging-rhel8-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[]
|===
endif::openshift-origin[]
ifdef::openshift-origin[]
.Available must-gather images
[cols="2,2",options="header"]
|===
|Image |Purpose
|`quay.io/kubevirt/must-gather`
|Data collection for KubeVirt.
|`quay.io/openshift-knative/must-gather`
|Data collection for Knative.
|`docker.io/maistra/istio-must-gather`
|Data collection for service mesh.
|`quay.io/konveyor/must-gather`
|Data collection for migration-related information.
|`quay.io/ocs-dev/ocs-must-gather`
|Data collection for {rh-storage}.
|`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[]
|===
endif::openshift-origin[]
endif::from-main-support-section[]
[NOTE]
====
To collect the default `must-gather` data in addition to specific feature data, add the `--image-stream=openshift/must-gather` argument.
====
.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
. Navigate to the directory where you want to store the `must-gather` data.
ifndef::openshift-origin[]
. Run the `oc adm must-gather` command with one or more `--image` or `--image-stream` arguments. For example, the following command gathers both the default cluster data and information specific to {VirtProductName}:
+
[source,terminal,subs="attributes+"]
----
$ oc adm must-gather \
--image-stream=openshift/must-gather \ <1>
--image=registry.redhat.io/container-native-virtualization/cnv-must-gather-rhel8:v{HCOVersion} <2>
----
<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
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]
----
$ oc adm must-gather --image=$(oc -n openshift-logging get deployment.apps/cluster-logging-operator \
-o jsonpath='{.spec.template.spec.containers[?(@.name == "cluster-logging-operator")].image}')
----
+
.Example `must-gather` output for OpenShift Logging
[%collapsible]
====
[source,terminal]
----
├── cluster-logging
│ ├── clo
│ │ ├── cluster-logging-operator-74dd5994f-6ttgt
│ │ ├── clusterlogforwarder_cr
│ │ ├── cr
│ │ ├── csv
│ │ ├── deployment
│ │ └── logforwarding_cr
│ ├── collector
│ │ ├── fluentd-2tr64
ifdef::openshift-dedicated[]
│ ├── curator
│ │ └── curator-1596028500-zkz4s
endif::openshift-dedicated[]
│ ├── eo
│ │ ├── csv
│ │ ├── deployment
│ │ └── elasticsearch-operator-7dc7d97b9d-jb4r4
│ ├── es
│ │ ├── cluster-elasticsearch
│ │ │ ├── aliases
│ │ │ ├── health
│ │ │ ├── indices
│ │ │ ├── latest_documents.json
│ │ │ ├── nodes
│ │ │ ├── nodes_stats.json
│ │ │ └── thread_pool
│ │ ├── cr
│ │ ├── elasticsearch-cdm-lp8l38m0-1-794d6dd989-4jxms
│ │ └── logs
│ │ ├── elasticsearch-cdm-lp8l38m0-1-794d6dd989-4jxms
│ ├── install
│ │ ├── co_logs
│ │ ├── install_plan
│ │ ├── olmo_logs
│ │ └── subscription
│ └── kibana
│ ├── cr
│ ├── kibana-9d69668d4-2rkvz
├── cluster-scoped-resources
│ └── core
│ ├── nodes
│ │ ├── ip-10-0-146-180.eu-west-1.compute.internal.yaml
│ └── persistentvolumes
│ ├── pvc-0a8d65d9-54aa-4c44-9ecc-33d9381e41c1.yaml
├── event-filter.html
├── gather-debug.log
└── namespaces
├── openshift-logging
│ ├── apps
│ │ ├── daemonsets.yaml
│ │ ├── deployments.yaml
│ │ ├── replicasets.yaml
│ │ └── statefulsets.yaml
│ ├── batch
│ │ ├── cronjobs.yaml
│ │ └── jobs.yaml
│ ├── core
│ │ ├── 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
│ │ ├── replicationcontrollers.yaml
│ │ ├── secrets.yaml
│ │ └── services.yaml
│ ├── openshift-logging.yaml
│ ├── pods
│ │ ├── cluster-logging-operator-74dd5994f-6ttgt
│ │ │ ├── cluster-logging-operator
│ │ │ │ └── cluster-logging-operator
│ │ │ │ └── logs
│ │ │ │ ├── current.log
│ │ │ │ ├── previous.insecure.log
│ │ │ │ └── previous.log
│ │ │ └── cluster-logging-operator-74dd5994f-6ttgt.yaml
│ │ ├── cluster-logging-operator-registry-6df49d7d4-mxxff
│ │ │ ├── cluster-logging-operator-registry
│ │ │ │ └── cluster-logging-operator-registry
│ │ │ │ └── logs
│ │ │ │ ├── current.log
│ │ │ │ ├── previous.insecure.log
│ │ │ │ └── previous.log
│ │ │ ├── cluster-logging-operator-registry-6df49d7d4-mxxff.yaml
│ │ │ └── mutate-csv-and-generate-sqlite-db
│ │ │ └── mutate-csv-and-generate-sqlite-db
│ │ │ └── logs
│ │ │ ├── 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
│ │ │ ├── current.log
│ │ │ ├── previous.insecure.log
│ │ │ └── previous.log
│ │ ├── fluentd-2tr64
│ │ │ ├── fluentd
│ │ │ │ └── fluentd
│ │ │ │ └── logs
│ │ │ │ ├── current.log
│ │ │ │ ├── previous.insecure.log
│ │ │ │ └── previous.log
│ │ │ ├── fluentd-2tr64.yaml
│ │ │ └── fluentd-init
│ │ │ └── fluentd-init
│ │ │ └── logs
│ │ │ ├── current.log
│ │ │ ├── previous.insecure.log
│ │ │ └── previous.log
│ │ ├── kibana-9d69668d4-2rkvz
│ │ │ ├── kibana
│ │ │ │ └── kibana
│ │ │ │ └── logs
│ │ │ │ ├── current.log
│ │ │ │ ├── previous.insecure.log
│ │ │ │ └── previous.log
│ │ │ ├── kibana-9d69668d4-2rkvz.yaml
│ │ │ └── kibana-proxy
│ │ │ └── kibana-proxy
│ │ │ └── logs
│ │ │ ├── current.log
│ │ │ ├── previous.insecure.log
│ │ │ └── previous.log
│ └── route.openshift.io
│ └── routes.yaml
└── openshift-operators-redhat
├── ...
----
====
endif::openshift-origin[]
ifdef::openshift-origin[]
. Run the `oc adm must-gather` command with one or more `--image` or `--image-stream` arguments. For example, the following command gathers both the default cluster data and information specific to KubeVirt:
+
[source,terminal]
----
$ oc adm must-gather \
--image-stream=openshift/must-gather \ <1>
--image=quay.io/kubevirt/must-gather <2>
----
<1> The default {product-title} `must-gather` image
<2> The must-gather image for KubeVirt
endif::openshift-origin[]
. Create a compressed file from the `must-gather` directory that was just created in your working directory. For example, on a computer that uses a Linux
operating system, run the following command:
+
[source,terminal]
----
$ tar cvaf must-gather.tar.gz must-gather.local.5421342344627712289/ <1>
----
<1> Make sure to replace `must-gather-local.5421342344627712289/` with the
actual directory name.
. Attach the compressed file to your support case on the link:https://access.redhat.com[Red Hat Customer Portal].
ifeval::["{context}" == "gathering-cluster-data"]
:!from-main-support-section:
:!VirtProductName:
endif::[]
View Git Blame Copy Permalink