From cf55fe9ae35326fdbc82d1fa785a6771f48537ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Herrmann?= Date: Tue, 30 Jul 2024 18:25:29 +0200 Subject: [PATCH] CNV-40868 - Abstract & ID updates to CNV runbooks list --- virt/monitoring/virt-runbooks.adoc | 123 +++++++++++++++-------------- 1 file changed, 64 insertions(+), 59 deletions(-) diff --git a/virt/monitoring/virt-runbooks.adoc b/virt/monitoring/virt-runbooks.adoc index 0e3781edd0..d4bf1bced9 100644 --- a/virt/monitoring/virt-runbooks.adoc +++ b/virt/monitoring/virt-runbooks.adoc @@ -7,295 +7,300 @@ include::_attributes/common-attributes.adoc[] toc::[] :!virt-runbooks: -Runbooks for the {VirtProductName} Operator are maintained in the link:https://github.com/openshift/runbooks/tree/master/alerts/openshift-virtualization-operator[openshift/runbooks] Git repository, and you can view them on GitHub. To diagnose and resolve issues that trigger {VirtProductName} xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[alerts], follow the procedures in the runbooks. +To diagnose and resolve issues that trigger {VirtProductName} xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[alerts], follow the procedures in the runbooks for the {VirtProductName} Operator. Triggered {VirtProductName} alerts can be viewed in the main *Observe* -> *Alerts* tab in the web console, and also in the *Virtualization* -> *Overview* tab. -{VirtProductName} alerts are displayed in the *Virtualization* -> *Overview* tab in the web console. +Runbooks for the {VirtProductName} Operator are maintained in the link:https://github.com/openshift/runbooks/tree/master/alerts/openshift-virtualization-operator[openshift/runbooks] Git repository, and you can view them on GitHub. // IMPORTANT: these IDs are meant to exactly mirror the original module IDs // // changing them will break links in the actual alerts // -[id="virt-runbook-CDIDataImportCronOutdated"] +[id="virt-runbook-cdidataimportcronoutdated_{context}"] == CDIDataImportCronOutdated * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDIDataImportCronOutdated.md[View the runbook] for the `CDIDataImportCronOutdated` alert. -[id="virt-runbook-CDIDataVolumeUnusualRestartCount"] +[id="virt-runbook-cdidatavolumeunusualrestartcount_{context}"] == CDIDataVolumeUnusualRestartCount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDIDataVolumeUnusualRestartCount.md[View the runbook] for the `CDIDataVolumeUnusualRestartCount` alert. -[id="virt-runbook-CDIDefaultStorageClassDegraded"] +[id="virt-runbook-cdidefaultstorageclassdegraded_{context}"] == CDIDefaultStorageClassDegraded * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDIDefaultStorageClassDegraded.md[View the runbook] for the `CDIDefaultStorageClassDegraded` alert. -[id="virt-runbook-CDIMultipleDefaultVirtStorageClasses"] +[id="virt-runbook-cdimultipledefaultvirtstorageclasses_{context}"] == CDIMultipleDefaultVirtStorageClasses * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDIMultipleDefaultVirtStorageClasses.md[View the runbook] for the `CDIMultipleDefaultVirtStorageClasses` alert. -[id="virt-runbook-CDINoDefaultStorageClass"] +[id="virt-runbook-cdinodefaultstorageclass_{context}"] == CDINoDefaultStorageClass * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDINoDefaultStorageClass.md[View the runbook] for the `CDINoDefaultStorageClass` alert. -[id="virt-runbook-CDINotReady"] +[id="virt-runbook-cdinotready_{context}"] == CDINotReady * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDINotReady.md[View the runbook] for the `CDINotReady` alert. -[id="virt-runbook-CDIOperatorDown"] +[id="virt-runbook-cdioperatordown_{context}"] == CDIOperatorDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDIOperatorDown.md[View the runbook] for the `CDIOperatorDown` alert. -[id="virt-runbook-CDIStorageProfilesIncomplete"] +[id="virt-runbook-cdistorageprofilesincomplete_{context}"] == CDIStorageProfilesIncomplete * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CDIStorageProfilesIncomplete.md[View the runbook] for the `CDIStorageProfilesIncomplete` alert. -[id="virt-runbook-CnaoDown"] +[id="virt-runbook-cnaodown_{context}"] == CnaoDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CnaoDown.md[View the runbook] for the `CnaoDown` alert. -[id="virt-runbook-CnaoNMstateMigration"] +[id="virt-runbook-cnaonmstatemigration_{context}"] == CnaoNMstateMigration * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/CnaoNmstateMigration.md[View the runbook] for the `CnaoNMstateMigration` alert. -[id="virt-runbook-HCOInstallationIncomplete"] +[id="virt-runbook-hcoinstallationincomplete_{context}"] == HCOInstallationIncomplete * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/HCOInstallationIncomplete.md[View the runbook] for the `HCOInstallationIncomplete` alert. -[id="virt-runbook-HPPNotReady"] +[id="virt-runbook-hppnotready_{context}"] == HPPNotReady * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/HPPNotReady.md[View the runbook] for the `HPPNotReady` alert. -[id="virt-runbook-HPPOperatorDown"] +[id="virt-runbook-hppoperatordown_{context}"] == HPPOperatorDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/HPPOperatorDown.md[View the runbook] for the `HPPOperatorDown` alert. -[id="virt-runbook-HPPSharingPoolPathWithOS"] +[id="virt-runbook-hppsharingpoolpathwithos_{context}"] == HPPSharingPoolPathWithOS * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/HPPSharingPoolPathWithOS.md[View the runbook] for the `HPPSharingPoolPathWithOS` alert. -[id="virt-runbook-KubemacpoolDown"] +[id="virt-runbook-kubemacpooldown_{context}"] == KubemacpoolDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubemacpoolDown.md[View the runbook] for the `KubemacpoolDown` alert. -[id="virt-runbook-KubeMacPoolDuplicateMacsFound"] +[id="virt-runbook-KubeMacPoolDuplicateMacsfound_{context}"] == KubeMacPoolDuplicateMacsFound * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubeMacPoolDuplicateMacsFound.md[View the runbook] for the `KubeMacPoolDuplicateMacsFound` alert. -[id="virt-runbook-KubeVirtComponentExceedsRequestedCPU"] +[id="virt-runbook-kubevirtcomponentexceedsrequestedcpu_{context}"] == KubeVirtComponentExceedsRequestedCPU * The `KubeVirtComponentExceedsRequestedCPU` alert is link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/deprecated/KubeVirtComponentExceedsRequestedCPU.md[deprecated]. -[id="virt-runbook-KubeVirtComponentExceedsRequestedMemory"] +[id="virt-runbook-kubevirtcomponentexceedsrequestedmemory_{context}"] == KubeVirtComponentExceedsRequestedMemory * The `KubeVirtComponentExceedsRequestedMemory` alert is link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/deprecated/KubeVirtComponentExceedsRequestedMemory.md[deprecated]. -[id="virt-runbook-KubeVirtCRModified"] +[id="virt-runbook-kubevirtcrmodified_{context}"] == KubeVirtCRModified * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubeVirtCRModified.md[View the runbook] for the `KubeVirtCRModified` alert. -[id="virt-runbook-KubeVirtDeprecatedAPIRequested"] +[id="virt-runbook-kubevirtdeprecatedapirequested_{context}"] == KubeVirtDeprecatedAPIRequested * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubeVirtDeprecatedAPIRequested.md[View the runbook] for the `KubeVirtDeprecatedAPIRequested` alert. -[id="virt-runbook-KubeVirtNoAvailableNodesToRunVMs"] +[id="virt-runbook-kubevirtnoavailablenodestorunvms_{context}"] == KubeVirtNoAvailableNodesToRunVMs * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubeVirtNoAvailableNodesToRunVMs.md[View the runbook] for the `KubeVirtNoAvailableNodesToRunVMs` alert. -[id="virt-runbook-KubevirtVmHighMemoryUsage"] +[id="virt-runbook-kubevirtvmhighmemoryusage_{context}"] == KubevirtVmHighMemoryUsage * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubevirtVmHighMemoryUsage.md[View the runbook] for the `KubevirtVmHighMemoryUsage` alert. -[id="virt-runbook-KubeVirtVMIExcessiveMigrations"] +[id="virt-runbook-kubevirtvmiexcessivemigrations_{context}"] == KubeVirtVMIExcessiveMigrations * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/KubeVirtVMIExcessiveMigrations.md[View the runbook] for the `KubeVirtVMIExcessiveMigrations` alert. -[id="virt-runbook-LowKVMNodesCount"] +[id="virt-runbook-lowkvmnodescount_{context}"] == LowKVMNodesCount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/LowKVMNodesCount.md[View the runbook] for the `LowKVMNodesCount` alert. -[id="virt-runbook-LowReadyVirtControllersCount"] +[id="virt-runbook-lowreadyvirtcontrollerscount_{context}"] == LowReadyVirtControllersCount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/LowReadyVirtControllersCount.md[View the runbook] for the `LowReadyVirtControllersCount` alert. -[id="virt-runbook-LowReadyVirtOperatorsCount"] +[id="virt-runbook-lowreadyvirtoperatorscount_{context}"] == LowReadyVirtOperatorsCount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/LowReadyVirtOperatorsCount.md[View the runbook] for the `LowReadyVirtOperatorsCount` alert. -[id="virt-runbook-LowVirtAPICount"] +[id="virt-runbook-lowvirtapicount_{context}"] == LowVirtAPICount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/LowVirtAPICount.md[View the runbook] for the `LowVirtAPICount` alert. -[id="virt-runbook-LowVirtControllersCount"] +[id="virt-runbook-lowvirtcontrollerscount_{context}"] == LowVirtControllersCount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/LowVirtControllersCount.md[View the runbook] for the `LowVirtControllersCount` alert. -[id="virt-runbook-LowVirtOperatorCount"] +[id="virt-runbook-lowvirtoperatorcount_{context}"] == LowVirtOperatorCount * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/LowVirtOperatorCount.md[View the runbook] for the `LowVirtOperatorCount` alert. -[id="virt-runbook-NetworkAddonsConfigNotReady"] +[id="virt-runbook-networkaddonsconfignotready_{context}"] == NetworkAddonsConfigNotReady * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/NetworkAddonsConfigNotReady.md[View the runbook] for the `NetworkAddonsConfigNotReady` alert. -[id="virt-runbook-NoLeadingVirtOperator"] +[id="virt-runbook-noleadingvirtoperator_{context}"] == NoLeadingVirtOperator * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/NoLeadingVirtOperator.md[View the runbook] for the `NoLeadingVirtOperator` alert. -[id="virt-runbook-NoReadyVirtController"] +[id="virt-runbook-noreadyvirtcontroller_{context}"] == NoReadyVirtController * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/NoReadyVirtController.md[View the runbook] for the `NoReadyVirtController` alert. -[id="virt-runbook-NoReadyVirtOperator"] +[id="virt-runbook-noreadyvirtoperator_{context}"] == NoReadyVirtOperator * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/NoReadyVirtOperator.md[View the runbook] for the `NoReadyVirtOperator` alert. -[id="virt-runbook-OrphanedVirtualMachineInstances"] +[id="virt-runbook-orphanedvirtualmachineinstances_{context}"] == OrphanedVirtualMachineInstances * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/OrphanedVirtualMachineInstances.md[View the runbook] for the `OrphanedVirtualMachineInstances` alert. -[id="virt-runbook-OutdatedVirtualMachineInstanceWorkloads"] +[id="virt-runbook-outdatedvirtualmachineinstanceWorkloads_{context}"] == OutdatedVirtualMachineInstanceWorkloads * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/OutdatedVirtualMachineInstanceWorkloads.md[View the runbook] for the `OutdatedVirtualMachineInstanceWorkloads` alert. -[id="virt-runbook-SingleStackIPv6Unsupported"] +[id="virt-runbook-singlestackipv6unsupported_{context}"] == SingleStackIPv6Unsupported * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SingleStackIPv6Unsupported.md[View the runbook] for the `SingleStackIPv6Unsupported` alert. -[id="virt-runbook-SSPCommonTemplatesModificationReverted"] +[id="virt-runbook-sspcommontemplatesmodificationreverted_{context}"] == SSPCommonTemplatesModificationReverted * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SSPCommonTemplatesModificationReverted.md[View the runbook] for the `SSPCommonTemplatesModificationReverted` alert. -[id="virt-runbook-SSPDown"] +[id="virt-runbook-sspdown_{context}"] == SSPDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SSPDown.md[View the runbook] for the `SSPDown` alert. -[id="virt-runbook-SSPFailingToReconcile"] +[id="virt-runbook-sspfailingtoreconcile_{context}"] == SSPFailingToReconcile * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SSPFailingToReconcile.md[View the runbook] for the `SSPFailingToReconcile` alert. -[id="virt-runbook-SSPHighRateRejectedVms"] +[id="virt-runbook-ssphighraterejectedvms_{context}"] == SSPHighRateRejectedVms * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SSPHighRateRejectedVms.md[View the runbook] for the `SSPHighRateRejectedVms` alert. -[id="virt-runbook-SSPTemplateValidatorDown"] +[id="virt-runbook-ssptemplatevalidatordown_{context}"] == SSPTemplateValidatorDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SSPTemplateValidatorDown.md[View the runbook] for the `SSPTemplateValidatorDown` alert. -[id="virt-runbook-UnsupportedHCOModification"] +[id="virt-runbook-sspoperatordown_{context}"] +== SSPOperatorDown + +* link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/SSPOperatorDown.md[View the runbook] for the `SSPOperatorDown` alert. + +[id="virt-runbook-unsupportedhcomodification_{context}"] == UnsupportedHCOModification * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/UnsupportedHCOModification.md[View the runbook] for the `UnsupportedHCOModification` alert. -[id="virt-runbook-VirtAPIDown"] +[id="virt-runbook-virtapidown_{context}"] == VirtAPIDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtAPIDown.md[View the runbook] for the `VirtAPIDown` alert. -[id="virt-runbook-VirtApiRESTErrorsBurst"] +[id="virt-runbook-virtapiresterrorsburst_{context}"] == VirtApiRESTErrorsBurst * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtApiRESTErrorsBurst.md[View the runbook] for the `VirtApiRESTErrorsBurst` alert. -[id="virt-runbook-VirtApiRESTErrorsHigh"] +[id="virt-runbook-virtapiresterrorshigh_{context}"] == VirtApiRESTErrorsHigh * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtApiRESTErrorsHigh.md[View the runbook] for the `VirtApiRESTErrorsHigh` alert. -[id="virt-runbook-VirtControllerDown"] +[id="virt-runbook-virtcontrollerdown_{context}"] == VirtControllerDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtControllerDown.md[View the runbook] for the `VirtControllerDown` alert. -[id="virt-runbook-VirtControllerRESTErrorsBurst"] +[id="virt-runbook-virtcontrollerresterrorsburst_{context}"] == VirtControllerRESTErrorsBurst * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtControllerRESTErrorsBurst.md[View the runbook] for the `VirtControllerRESTErrorsBurst` alert. -[id="virt-runbook-VirtControllerRESTErrorsHigh"] +[id="virt-runbook-virtcontrollerresterrorshigh_{context}"] == VirtControllerRESTErrorsHigh * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtControllerRESTErrorsHigh.md[View the runbook] for the `VirtControllerRESTErrorsHigh` alert. -[id="virt-runbook-VirtHandlerDaemonSetRolloutFailing"] +[id="virt-runbook-virthandlerdaemonsetrolloutfailing_{context}"] == VirtHandlerDaemonSetRolloutFailing * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtHandlerDaemonSetRolloutFailing.md[View the runbook] for the `VirtHandlerDaemonSetRolloutFailing` alert. -[id="virt-runbook-VirtHandlerRESTErrorsBurst"] +[id="virt-runbook-virthandlerresterrorsburst_{context}"] == VirtHandlerRESTErrorsBurst * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtHandlerRESTErrorsBurst.md[View the runbook] for the `VirtHandlerRESTErrorsBurst` alert. -[id="virt-runbook-VirtHandlerRESTErrorsHigh"] +[id="virt-runbook-virthandlerresterrorshigh_{context}"] == VirtHandlerRESTErrorsHigh * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtHandlerRESTErrorsHigh.md[View the runbook] for the `VirtHandlerRESTErrorsHigh` alert. -[id="virt-runbook-VirtOperatorDown"] +[id="virt-runbook-virtoperatordown_{context}"] == VirtOperatorDown * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtOperatorDown.md[View the runbook] for the `VirtOperatorDown` alert. -[id="virt-runbook-VirtOperatorRESTErrorsBurst"] +[id="virt-runbook-virtoperatorresterrorsburst_{context}"] == VirtOperatorRESTErrorsBurst * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtOperatorRESTErrorsBurst.md[View the runbook] for the `VirtOperatorRESTErrorsBurst` alert. -[id="virt-runbook-VirtOperatorRESTErrorsHigh"] +[id="virt-runbook-virtoperatorresterrorshigh_{context}"] == VirtOperatorRESTErrorsHigh * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VirtOperatorRESTErrorsHigh.md[View the runbook] for the `VirtOperatorRESTErrorsHigh` alert. -[id="virt-runbook-VirtualMachineCRCErrors"] +[id="virt-runbook-virtualmachinecrcerrors_{context}"] == VirtualMachineCRCErrors * The runbook for the `VirtualMachineCRCErrors` alert is deprecated because the alert was renamed to `VMStorageClassWarning`. ** link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VMStorageClassWarning.md[View the runbook] for the `VMStorageClassWarning` alert. -[id="virt-runbook-VMCannotBeEvicted"] +[id="virt-runbook-vmcannotbeevicted_{context}"] == VMCannotBeEvicted * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VMCannotBeEvicted.md[View the runbook] for the `VMCannotBeEvicted` alert. -[id="virt-runbook-VMStorageClassWarning"] +[id="virt-runbook-vmstorageclasswarning_{context}"] == VMStorageClassWarning * link:https://github.com/openshift/runbooks/blob/master/alerts/openshift-virtualization-operator/VMStorageClassWarning.md[View the runbook] for the `VMStorageClassWarning` alert.