mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
[enterprise-4.13] CNV-17386: Consolidate support files
Signed-off-by: Avital Pinnick <apinnick@redhat.com>
This commit is contained in:
Avital Pinnick
1
virt/support/monitoring/_attributes
Symbolic link
1
virt/support/monitoring/_attributes
Symbolic link
@@ -0,0 +1 @@
|
||||
../../_attributes
|
||||
1
virt/support/monitoring/images
Symbolic link
1
virt/support/monitoring/images
Symbolic link
@@ -0,0 +1 @@
|
||||
../../images
|
||||
1
virt/support/monitoring/modules
Symbolic link
1
virt/support/monitoring/modules
Symbolic link
@@ -0,0 +1 @@
|
||||
../../modules
|
||||
1
virt/support/monitoring/snippets
Symbolic link
1
virt/support/monitoring/snippets
Symbolic link
@@ -0,0 +1 @@
|
||||
../../snippets
|
||||
@@ -20,16 +20,16 @@ include::modules/virt-accessing-node-exporter-outside-cluster.adoc[leveloffset=+
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_virt-exposing-custom-metrics-for-vms"]
|
||||
== Additional resources
|
||||
* xref:../../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
* xref:../../../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Configuring the monitoring stack]
|
||||
|
||||
* xref:../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
|
||||
* xref:../../../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[Enabling monitoring for user-defined projects]
|
||||
|
||||
* xref:../../monitoring/managing-metrics.adoc#managing-metrics[Managing metrics]
|
||||
* xref:../../../monitoring/managing-metrics.adoc#managing-metrics[Managing metrics]
|
||||
|
||||
* xref:../../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
||||
* xref:../../../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[Reviewing monitoring dashboards]
|
||||
|
||||
* xref:../../applications/application-health.adoc#application-health[Monitoring application health by using health checks]
|
||||
* xref:../../../applications/application-health.adoc#application-health[Monitoring application health by using health checks]
|
||||
|
||||
* xref:../../nodes/pods/nodes-pods-configmaps.adoc#nodes-pods-configmaps[Creating and using config maps]
|
||||
* xref:../../../nodes/pods/nodes-pods-configmaps.adoc#nodes-pods-configmaps[Creating and using config maps]
|
||||
|
||||
* xref:../../virt/virtual_machines/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Controlling virtual machine states]
|
||||
* xref:../../../virt/virtual_machines/virt-controlling-vm-states.adoc#virt-controlling-vm-states[Controlling virtual machine states]
|
||||
24
virt/support/monitoring/virt-monitoring-overview.adoc
Normal file
24
virt/support/monitoring/virt-monitoring-overview.adoc
Normal file
@@ -0,0 +1,24 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-monitoring-overview"]
|
||||
= Monitoring overview
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-monitoring-overview
|
||||
|
||||
toc::[]
|
||||
|
||||
You can monitor the health of your cluster and virtual machines (VMs) with the following tools:
|
||||
|
||||
xref:../../../virt/support/monitoring/virt-running-cluster-checkups.adoc#virt-running-cluster-checkups[{product-title} cluster checkup framework]::
|
||||
Check network connectivity and latency by using predefined, automated tests.
|
||||
|
||||
:FeatureName: The {product-title} cluster checkup framework
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
xref:../../../virt/support/monitoring/virt-prometheus-queries.adoc#virt-prometheus-queries[Prometheus queries for virtual resources]::
|
||||
Query vCPU, network, storage, and guest memory swapping usage and live migration progress.
|
||||
|
||||
xref:../../../virt/support/monitoring/virt-exposing-custom-metrics-for-vms.adoc#virt-exposing-custom-metrics-for-vms[VM custom metrics]::
|
||||
Configure the `node-exporter` service to expose internal VM metrics and processes.
|
||||
|
||||
xref:../../../virt/support/monitoring/virt-monitoring-vm-health.adoc#[VM health checks]::
|
||||
Configure readiness, liveness, and guest agent ping probes and a watchdog for VMs.
|
||||
54
virt/support/monitoring/virt-monitoring-vm-health.adoc
Normal file
54
virt/support/monitoring/virt-monitoring-vm-health.adoc
Normal file
@@ -0,0 +1,54 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-monitoring-vm-health"]
|
||||
= Virtual machine health checks
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-monitoring-vm-health
|
||||
|
||||
toc::[]
|
||||
|
||||
You can configure virtual machine (VM) health checks by defining readiness and liveness probes in the `VirtualMachine` resource.
|
||||
|
||||
include::modules/virt-about-readiness-liveness-probes.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-define-http-readiness-probe.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-define-tcp-readiness-probe.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-define-http-liveness-probe.adoc[leveloffset=+2]
|
||||
|
||||
[id="watchdog_{context}"]
|
||||
== Defining a watchdog
|
||||
|
||||
You can define a watchdog to monitor the health of the guest operating system by performing the following steps:
|
||||
|
||||
. Configure a watchdog device for the virtual machine (VM).
|
||||
. Install the watchdog agent on the guest.
|
||||
|
||||
The watchdog device monitors the agent and performs one of the following actions if the guest operating system is unresponsive:
|
||||
|
||||
* `poweroff`: The VM powers down immediately. If `spec.running` is set to `true` or `spec.runStrategy` is not set to `manual`, then the VM reboots.
|
||||
* `reset`: The VM reboots in place and the guest operating system cannot react.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The reboot time might cause liveness probes to time out. If cluster-level protections detect a failed liveness probe, the VM might be forcibly rescheduled, increasing the reboot time.
|
||||
====
|
||||
|
||||
* `shutdown`: The VM gracefully powers down by stopping all services.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Watchdog is not available for Windows VMs.
|
||||
====
|
||||
|
||||
include::modules/virt-defining-watchdog-device-vm.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-installing-watchdog-agent.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-define-guest-agent-ping-probe.adoc[leveloffset=+1]
|
||||
|
||||
[id="additional-resources_monitoring-vm-health"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../../applications/application-health.adoc#application-health[Monitoring application health by using health checks]
|
||||
@@ -14,7 +14,7 @@ Use the {product-title} monitoring dashboard to query virtualization metrics.
|
||||
[id="prerequisites_{context}"]
|
||||
== Prerequisites
|
||||
|
||||
* To use the vCPU metric, the `schedstats=enable` kernel argument must be applied to the `MachineConfig` object. This kernel argument enables scheduler statistics used for debugging and performance tuning and adds a minor additional load to the scheduler. See the xref:../../post_installation_configuration/machine-configuration-tasks.adoc#nodes-nodes-kernel-arguments_post-install-machine-configuration-tasks[{product-title} machine configuration tasks] documentation for more information on applying a kernel argument.
|
||||
* To use the vCPU metric, the `schedstats=enable` kernel argument must be applied to the `MachineConfig` object. This kernel argument enables scheduler statistics used for debugging and performance tuning and adds a minor additional load to the scheduler. For more information, see xref:../../../post_installation_configuration/machine-configuration-tasks.html#nodes-nodes-kernel-arguments_post-install-machine-configuration-tasks[Adding kernel arguments to nodes].
|
||||
|
||||
* For guest memory swapping queries to return data, memory swapping must be enabled on the virtual guests.
|
||||
|
||||
@@ -26,13 +26,13 @@ include::modules/monitoring-querying-metrics-for-user-defined-projects-as-a-deve
|
||||
|
||||
include::modules/virt-querying-metrics.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-live-migration-metrics.adoc[leveloffset=+1]
|
||||
include::modules/virt-live-migration-metrics.adoc[leveloffset=+2]
|
||||
|
||||
[id="additional-resources_virt-prometheus-queries"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
|
||||
* xref:../../../monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview]
|
||||
|
||||
* link:https://prometheus.io/docs/prometheus/latest/querying/basics/[Querying Prometheus]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-running-cluster-checkups"]
|
||||
= Running cluster checkups
|
||||
= {product-title} cluster checkup framework
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-running-cluster-checkups
|
||||
|
||||
@@ -11,12 +11,7 @@ toc::[]
|
||||
:FeatureName: The {product-title} cluster checkup framework
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
|
||||
include::modules/virt-about-cluster-checkup-framework.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-measuring-latency-vm-secondary-network.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_running-cluster-checkups"]
|
||||
== Additional resources
|
||||
* xref:../../virt/virtual_machines/vm_networking/virt-attaching-vm-multiple-networks.adoc#virt-attaching-vm-multiple-networks[Attaching a virtual machine to multiple networks]
|
||||
@@ -17,34 +17,48 @@ Prometheus is a time-series database and a rule evaluation engine for metrics. P
|
||||
Alertmanager::
|
||||
The Alertmanager service handles alerts received from Prometheus. The Alertmanager is also responsible for sending the alerts to external notification systems.
|
||||
|
||||
include::modules/virt-collecting-data-about-your-environment.adoc[leveloffset=+1]
|
||||
For information about the {product-title} monitoring stack, see xref:../../monitoring/monitoring-overview.adoc#about-openshift-monitoring[About {product-title} monitoring].
|
||||
|
||||
[id="additional-resources_collecting-data-about-your-environment"]
|
||||
[role="_additional-resources"]
|
||||
=== Additional resources
|
||||
* Configuring the xref:../../monitoring/configuring-the-monitoring-stack.adoc#modifying-retention-time-for-prometheus-metrics-data_configuring-the-monitoring-stack[retention time] for Prometheus metrics data
|
||||
* Configuring the Alertmanager to send xref:../../monitoring/managing-alerts.adoc#sending-notifications-to-external-systems_managing-alerts[alert notifications] to external systems
|
||||
* Collecting `must-gather` data for xref:../../support/gathering-cluster-data.adoc#support_gathering_data_gathering-cluster-data[{product-title}]
|
||||
* Collecting `must-gather` data for link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.13/html-single/troubleshooting_openshift_data_foundation/index#downloading-log-files-and-diagnostic-information_rhodf[{rh-storage-first}]
|
||||
* Collecting `must-gather` data for xref:../../virt/support/virt-collecting-virt-data.adoc#virt-using-virt-must-gather_virt-collecting-virt-data[{VirtProductName}]
|
||||
* Collecting Prometheus metrics for xref:../../monitoring/managing-metrics.adoc#querying-metrics-for-all-projects-as-an-administrator_managing-metrics[all projects] as a cluster administrator
|
||||
// This procedure is in the assembly so that we can add xrefs instead of a long list of additional resources.
|
||||
[id="virt-collecting-data-about-your-environment_{context}"]
|
||||
== Collecting data about your environment
|
||||
|
||||
include::modules/virt-collecting-data-about-vms.adoc[leveloffset=+1]
|
||||
Collecting data about your environment minimizes the time required to analyze and determine the root cause.
|
||||
|
||||
[id="additional-resources_collecting-data-about-vms"]
|
||||
[role="_additional-resources"]
|
||||
=== Additional resources
|
||||
* Installing xref:../../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-virtio-drivers-existing-windows_virt-installing-qemu-guest-agent[VirtIO drivers] on Windows VMs
|
||||
* Downloading and installing link:https://access.redhat.com/solutions/6957701[VirtIO drivers] on Windows VMs without host access
|
||||
* Connecting to Windows VMs with RDP using the xref:../../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-rdp-console-web_virt-accessing-vm-consoles[web console] or the xref:../../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-rdp-console_virt-accessing-vm-consoles[command line]
|
||||
* Collecting `must-gather` data about xref:../../virt/support/virt-collecting-virt-data.adoc#virt-must-gather-options_virt-collecting-virt-data[virtual machines]
|
||||
// * Collecting virtual machine memory dumps. [link TBD. CNV-20256]
|
||||
.Prerequisites
|
||||
|
||||
* xref:../../monitoring/configuring-the-monitoring-stack.adoc#modifying-retention-time-for-prometheus-metrics-data_configuring-the-monitoring-stack[Set the retention time for Prometheus metrics data] to a minimum of seven days.
|
||||
* xref:../../monitoring/managing-alerts.adoc#sending-notifications-to-external-systems_managing-alerts[Configure the Alertmanager to capture relevant alerts and to send alert notifications to a dedicated mailbox] so that they can be viewed and persisted outside the cluster.
|
||||
* Record the exact number of affected nodes and virtual machines.
|
||||
|
||||
.Procedure
|
||||
|
||||
. xref:../../support/gathering-cluster-data.adoc#support_gathering_data_gathering-cluster-data[Collect must-gather data for the cluster].
|
||||
. link:https://access.redhat.com/documentation/en-us/red_hat_openshift_data_foundation/4.12/html-single/troubleshooting_openshift_data_foundation/index#downloading-log-files-and-diagnostic-information_rhodf[Collect must-gather data for {rh-storage-first}], if necessary.
|
||||
. xref:../../virt/support/virt-collecting-virt-data.adoc#virt-using-virt-must-gather_virt-collecting-virt-data[Collect must-gather data for {VirtProductName}].
|
||||
. xref:../../monitoring/managing-metrics.adoc#querying-metrics-for-all-projects-as-an-administrator_managing-metrics[Collect Prometheus metrics for the cluster].
|
||||
|
||||
[id="virt-collecting-data-about-vms_{context}"]
|
||||
== Collecting data about virtual machines
|
||||
|
||||
Collecting data about malfunctioning virtual machines (VMs) minimizes the time required to analyze and determine the root cause.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Linux VMs: xref:../../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-qemu-guest-agent-on-linux-vm_virt-installing-qemu-guest-agent[Install the latest QEMU guest agent].
|
||||
* Windows VMs:
|
||||
** Record the Windows patch update details.
|
||||
** link:https://access.redhat.com/solutions/6957701[Install the latest VirtIO drivers].
|
||||
** xref:../../virt/virtual_machines/virt-installing-qemu-guest-agent.adoc#virt-installing-virtio-drivers-existing-windows_virt-installing-qemu-guest-agent[Install the latest QEMU guest agent].
|
||||
** If Remote Desktop Protocol (RDP) is enabled, try to connect to the VMs with RDP by using the xref:../../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-vm-rdp-console-web_virt-accessing-vm-consoles[web console] or the xref:../../virt/virtual_machines/virt-accessing-vm-consoles.adoc#virt-accessing-rdp-console_virt-accessing-vm-consoles[command line] to determine whether there is a problem with the connection software.
|
||||
|
||||
.Procedure
|
||||
|
||||
. xref:../../virt/support/virt-collecting-virt-data.adoc#virt-must-gather-options_virt-collecting-virt-data[Collect must-gather data for the VMs] using the `gather_vms_details` script.
|
||||
. Collect screenshots of VMs that have crashed _before_ you restart them.
|
||||
. xref:../../virt/virt-using-the-cli-tools.html#vm-memory-dump-commands_virt-using-the-cli-tools[Collect memory dumps from VMs] _before_ remediation attempts.
|
||||
. Record factors that the malfunctioning VMs have in common. For example, the VMs have the same host or network.
|
||||
|
||||
include::modules/virt-using-virt-must-gather.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-must-gather-options.adoc[leveloffset=+2]
|
||||
|
||||
[id="additional-resources_must-gather-virt"]
|
||||
[role="_additional-resources"]
|
||||
=== Additional resources
|
||||
* xref:../../support/gathering-cluster-data.adoc#about-must-gather_gathering-cluster-data[About the `must-gather` tool]
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-diagnosing-datavolumes-using-events-and-conditions"]
|
||||
= Diagnosing data volumes using events and conditions
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-diagnosing-datavolumes-using-events-and-conditions
|
||||
|
||||
toc::[]
|
||||
|
||||
Use the `oc describe` command to analyze and help resolve issues with data volumes.
|
||||
|
||||
include::modules/virt-about-conditions-and-events.adoc[leveloffset=+1]
|
||||
include::modules/virt-analyzing-datavolume-conditions-and-events.adoc[leveloffset=+1]
|
||||
@@ -1,18 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-events"]
|
||||
= Viewing events
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-events
|
||||
|
||||
toc::[]
|
||||
|
||||
include::modules/virt-about-vm-events.adoc[leveloffset=+1]
|
||||
|
||||
See also:
|
||||
xref:../../nodes/clusters/nodes-containers-events.adoc#nodes-containers-events[Viewing system event information in an {product-title} cluster].
|
||||
|
||||
include::modules/virt-viewing-vm-events-web.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-viewing-namespace-events-cli.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-viewing-resource-events-cli.adoc[leveloffset=+1]
|
||||
@@ -1,15 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-logs"]
|
||||
= Viewing {VirtProductName} logs
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-logs
|
||||
|
||||
toc::[]
|
||||
|
||||
You can view logs for {VirtProductName} components and virtual machines by using the web console or the `oc` CLI. You can retrieve virtual machine logs from the `virt-launcher` pod. To control log verbosity, edit the `HyperConverged` custom resource.
|
||||
|
||||
include::modules/virt-viewing-logs-cli.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-viewing-virtual-machine-logs-web.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-common-error-messages.adoc[leveloffset=+1]
|
||||
@@ -1,25 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-monitor-vmi-migration"]
|
||||
= Monitoring live migration
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-monitor-vmi-migration
|
||||
|
||||
toc::[]
|
||||
|
||||
You can monitor the progress of live migration from either the web console or the CLI.
|
||||
|
||||
[id="monitoring-live-migration-by-using-the-web-console_{context}"]
|
||||
== Monitoring live migration by using the web console
|
||||
|
||||
You can monitor the progress of all live migrations on the xref:../../virt/virt-web-console-overview.adoc#virtualization-overview-migrations_virt-web-console-overview[*Overview -> Migrations* tab] in the web console.
|
||||
|
||||
You can view the migration metrics of a virtual machine on the xref:../../virt/virt-web-console-overview.adoc#ui-virtualmachine-details-metrics_virt-web-console-overview[*VirtualMachine details -> Metrics* tab] in the web console.
|
||||
|
||||
include::modules/virt-monitoring-vm-migration-cli.adoc[leveloffset=+1]
|
||||
|
||||
[id="metrics_virt-monitor-vmi-migration"]
|
||||
== Metrics
|
||||
|
||||
You can use xref:../../virt/support/virt-prometheus-queries.adoc#virt-prometheus-queries[Prometheus queries] to monitor live migration.
|
||||
|
||||
include::modules/virt-live-migration-metrics.adoc[leveloffset=+2]
|
||||
@@ -1,26 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-monitoring-vm-health"]
|
||||
= Monitoring virtual machine health with health probes
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-monitoring-vm-health
|
||||
|
||||
toc::[]
|
||||
|
||||
A virtual machine (VM) can become unhealthy due to transient issues such as connectivity loss, deadlocks, or problems with external dependencies. A health check periodically performs diagnostics on a VM by using any combination of the readiness and liveness probes.
|
||||
|
||||
include::modules/virt-about-readiness-liveness-probes.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-define-http-readiness-probe.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-define-tcp-readiness-probe.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-define-http-liveness-probe.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/virt-define-guest-agent-ping-probe.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
[id="additional-resources_monitoring-vm-health"]
|
||||
[role="_additional-resources"]
|
||||
== Additional resources
|
||||
|
||||
* xref:../../applications/application-health.adoc#application-health[Monitoring application health by using health checks]
|
||||
@@ -1,25 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-openshift-cluster-monitoring"]
|
||||
= {product-title} cluster monitoring, logging, and Telemetry
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-openshift-cluster-monitoring
|
||||
|
||||
toc::[]
|
||||
|
||||
{product-title} provides various resources for monitoring at the cluster level.
|
||||
|
||||
// Cluster monitoring
|
||||
include::modules/monitoring-about-cluster-monitoring.adoc[leveloffset=+1]
|
||||
|
||||
// OpenShift Logging
|
||||
include::modules/cluster-logging-about-components.adoc[leveloffset=+1]
|
||||
|
||||
For more information on OpenShift Logging, see the xref:../../logging/cluster-logging.adoc#cluster-logging[OpenShift Logging] documentation.
|
||||
|
||||
// Telemetry
|
||||
include::modules/telemetry-about-telemetry.adoc[leveloffset=+1]
|
||||
include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+2]
|
||||
|
||||
== CLI troubleshooting and debugging commands
|
||||
|
||||
For a list of the `oc` client troubleshooting and debugging commands, see the xref:../../cli_reference/openshift_cli/developer-cli-commands.adoc#cli-developer-commands[{product-title} CLI tools] documentation.
|
||||
74
virt/support/virt-support-overview.adoc
Normal file
74
virt/support/virt-support-overview.adoc
Normal file
@@ -0,0 +1,74 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-support-overview"]
|
||||
= Support overview
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-support-overview
|
||||
|
||||
toc::[]
|
||||
|
||||
You can collect data about your environment, monitor the health of your cluster and virtual machines (VMs), and troubleshoot {VirtProductName} resources with the following tools.
|
||||
|
||||
[id="virt-web-console_{context}"]
|
||||
== Web console
|
||||
|
||||
The {product-title} web console displays resource usage, alerts, events, and trends for your cluster and for {VirtProductName} components and resources.
|
||||
|
||||
.Web console pages for monitoring and troubleshooting
|
||||
[options="header"]
|
||||
|====
|
||||
|Page |Description
|
||||
|
||||
|*Overview* page
|
||||
|Cluster details, status, alerts, inventory, and resource usage
|
||||
|
||||
|*Virtualization* -> xref:../../virt/virt-web-console-overview.adoc#virtualization-overview-overview_virt-web-console-overview[*Overview* tab]
|
||||
|{VirtProductName} resources, usage, alerts, and status
|
||||
|
||||
|*Virtualization* -> xref:../../virt/virt-web-console-overview.adoc#virtualization-overview-top-consumers_virt-web-console-overview[*Top consumers* tab]
|
||||
|Top consumers of CPU, memory, and storage
|
||||
|
||||
|*Virtualization* -> xref:../../virt/virt-web-console-overview.adoc#virtualization-overview-migrations_virt-web-console-overview[*Migrations* tab]
|
||||
|Progress of live migrations
|
||||
|
||||
|*VirtualMachines* -> *VirtualMachine* -> *VirtualMachine details* -> xref:../../virt/virt-web-console-overview.adoc#ui-virtualmachine-details-metrics_virt-web-console-overview[*Metrics* tab]
|
||||
|VM resource usage, storage, network, and migration
|
||||
|
||||
|*VirtualMachines* -> *VirtualMachine* -> *VirtualMachine details* -> xref:../../virt/virt-web-console-overview.adoc#ui-virtualmachine-details-events_virt-web-console-overview[*Events* tab]
|
||||
|List of VM events
|
||||
|====
|
||||
|
||||
[id="collecting-data-for-red-hat-support_{context}"]
|
||||
== Collecting data for Red Hat Support
|
||||
|
||||
When you submit a xref:../../support/getting-support.adoc#support-submitting-a-case_getting-support[support case] to Red Hat Support, it is helpful to provide debugging information. You can gather debugging information by performing the following steps:
|
||||
|
||||
xref:../../virt/support/virt-collecting-virt-data.adoc#virt-collecting-data-about-your-environment_virt-collecting-virt-data[Collecting data about your environment]::
|
||||
Configure Prometheus and Alertmanager and collect `must-gather` data for {product-title} and {VirtProductName}.
|
||||
|
||||
xref:../../virt/support/virt-collecting-virt-data.adoc#virt-collecting-data-about-vms_virt-collecting-virt-data[Collecting data about VMs]::
|
||||
Collect `must-gather` data and memory dumps from VMs.
|
||||
|
||||
xref:../../virt/support/virt-collecting-virt-data.adoc#virt-using-virt-must-gather_virt-collecting-virt-data[`must-gather` tool for {VirtProductName}]::
|
||||
Configure and use the `must-gather` tool.
|
||||
|
||||
[id="monitoring_{context}"]
|
||||
== Monitoring
|
||||
|
||||
You can monitor the health of your cluster and VMs. For details about monitoring tools, see the xref:../../virt/support/monitoring/virt-monitoring-overview.adoc#virt-monitoring-overview[Monitoring overview].
|
||||
|
||||
[id="troubleshooting_{context}"]
|
||||
== Troubleshooting
|
||||
|
||||
Troubleshoot {VirtProductName} components and VMs and resolve issues that trigger alerts in the web console.
|
||||
|
||||
xref:../../virt/support/virt-troubleshooting.adoc#events_virt-troubleshooting[Events]::
|
||||
View important life-cycle information for VMs, namespaces, and resources.
|
||||
|
||||
xref:../../virt/support/virt-troubleshooting.adoc#virt-logs_virt-troubleshooting[Logs]::
|
||||
View and configure logs for {VirtProductName} components and VMs.
|
||||
|
||||
xref:../../virt/support/virt-runbooks.adoc#virt-runbooks[Runbooks]::
|
||||
Diagnose and resolve issues that trigger {VirtProductName} alerts in the web console.
|
||||
|
||||
xref:../../virt/support/virt-troubleshooting.adoc#troubleshooting-data-volumes_virt-troubleshooting[Troubleshooting data volumes]::
|
||||
Troubleshoot data volumes by analyzing conditions and events.
|
||||
50
virt/support/virt-troubleshooting.adoc
Normal file
50
virt/support/virt-troubleshooting.adoc
Normal file
@@ -0,0 +1,50 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-troubleshooting"]
|
||||
= Troubleshooting
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-troubleshooting
|
||||
|
||||
toc::[]
|
||||
|
||||
[id="events_{context}"]
|
||||
== Events
|
||||
|
||||
xref:../../nodes/clusters/nodes-containers-events.adoc#nodes-containers-events[{product-title} events] are records of important life-cycle information and are useful for monitoring and troubleshooting resource issues. You can gather information about the following events:
|
||||
|
||||
* VM events: Navigate to the xref:../../virt/virt-web-console-overview.adoc#ui-virtualmachine-details-events_virt-web-console-overview[*Events* tab] of the *VirtualMachine details* page in the web console.
|
||||
|
||||
* Namespace events: Use the `oc get` command with the namespace:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc get events -n <namespace>
|
||||
----
|
||||
+
|
||||
See the xref:../../nodes/clusters/nodes-containers-events.adoc#nodes-containers-events-list_nodes-containers-events[list of events] for details about specific events.
|
||||
|
||||
* Resource events: Use the `oc describe` command with the resource:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ oc describe <resource> <resource_name>
|
||||
----
|
||||
|
||||
[id="virt-logs_{context}"]
|
||||
== Logs
|
||||
|
||||
You can view logs for {VirtProductName} components and VMs by using the web console or the `oc` CLI tool. You can retrieve virtual machine logs from the `virt-launcher` pod. To control log verbosity, edit the `HyperConverged` custom resource.
|
||||
|
||||
include::modules/virt-viewing-virtual-machine-logs-web.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-viewing-logs-cli.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-common-error-messages.adoc[leveloffset=+2]
|
||||
|
||||
[id="troubleshooting-data-volumes_{context}"]
|
||||
== Troubleshooting data volumes
|
||||
|
||||
You can check the `Conditions` and `Events` sections of the `DataVolume` object to analyze and resolve issues.
|
||||
|
||||
include::modules/virt-about-dv-conditions-and-events.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-analyzing-datavolume-conditions-and-events.adoc[leveloffset=+2]
|
||||
@@ -1,13 +0,0 @@
|
||||
:_content-type: ASSEMBLY
|
||||
[id="virt-using-dashboard-to-get-cluster-info"]
|
||||
= Using the {product-title} dashboard to get cluster information
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: virt-using-dashboard-to-get-cluster-info
|
||||
|
||||
toc::[]
|
||||
|
||||
Access the {product-title} dashboard, which captures high-level information about the cluster, by clicking *Home > Dashboards > Overview* from the {product-title} web console.
|
||||
|
||||
The {product-title} dashboard provides various cluster information, captured in individual dashboard _cards_.
|
||||
|
||||
include::modules/virt-about-the-overview-dashboard.adoc[leveloffset=+1]
|
||||
Reference in New Issue
Block a user