Bug 2249724 - Runbook url for KubeVirtComponentExceedsRequestedCPU in production is wrong and does not match with prometheusrule
Summary: Runbook url for KubeVirtComponentExceedsRequestedCPU in production is wrong a...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Container Native Virtualization (CNV)
Classification: Red Hat
Component: Documentation
Version: 4.14.0
Hardware: Unspecified
OS: Unspecified
unspecified
high
Target Milestone: ---
: ---
Assignee: Avital Pinnick
QA Contact: Debarati Basu-Nag
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-11-15 00:41 UTC by Debarati Basu-Nag
Modified: 2023-11-15 14:32 UTC (History)
0 users

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-11-15 14:32:10 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker CNV-35221 0 None None None 2023-11-15 00:42:06 UTC

Description Debarati Basu-Nag 2023-11-15 00:41:16 UTC
Document URL: https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-runbooks.html#virt-runbook-kubevirtcomponentexceedsrequestedcpu_virt-runbooks

Section Number and Name: 
https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-runbooks.html#virt-runbook-kubevirtcomponentexceedsrequestedcpu_virt-runbooks
Describe the issue:
Runbook url for alert  kubevirtcomponentexceedsrequestedcpu_virt does not match expected pattern. The prometheusrule says the url is supposed to be  https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-runbooks.html#virt-runbook-KubeVirtComponentExceedsRequestedCPU:
{noformat}
alert: KubeVirtComponentExceedsRequestedCPU
      annotations:
        description: Pod {{ $labels.pod }} cpu usage exceeds the CPU requested
        runbook_url: https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-runbooks.html#virt-runbook-KubeVirtComponentExceedsRequestedCPU
        summary: The containers in the pod are using more CPU than what is defined
          in the containers resource requests
      expr: ((kube_pod_container_resource_requests{namespace="openshift-cnv",container=~"virt-controller|virt-api|virt-handler|virt-operator",resource="cpu"})
        - on(pod) sum(rate(container_cpu_usage_seconds_total{container="",namespace="openshift-cnv"}[5m]))
        by (pod)) < 0
      for: 5m
      labels:
        kubernetes_operator_component: kubevirt
        kubernetes_operator_part_of: kubevirt
        operator_health_impact: none
        severity: warning

{noformat}

Suggestions for improvement: 
The url should be https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-runbooks.html#virt-runbook-KubeVirtComponentExceedsRequestedCPU

Additional information:

Comment 2 Avital Pinnick 2023-11-15 11:18:10 UTC
Checking the URL.

Comment 3 Avital Pinnick 2023-11-15 11:44:17 UTC
The problem is caused by our upstream/downstream sync process. The files in GitHub:openshift/openshift-docs are correct. The files in GitLab:OCP/4.14 are obsolete. I will fix this downstream.

Comment 4 Avital Pinnick 2023-11-15 11:59:30 UTC
Downstream file has been updated and merged. I will close this bug when the downstream doc fix is live on the Customer Portal. If the Prometheus rule picks up another malformed URL, please notify me asap so that I can fix it.

I will also create a task to clean up the d/s repo.

Comment 5 Avital Pinnick 2023-11-15 12:46:24 UTC
@dbasunag I am not certain about when docs.openshift.com will be updated with the correct URL. At the moment, both URLs resolve. Please try to verify the fix. Thanks!

Comment 6 Debarati Basu-Nag 2023-11-15 13:43:21 UTC
Verified that it is working after the url updates to https://docs.openshift.com/container-platform/4.14/virt/monitoring/virt-runbooks.html#virt-runbook-KubeVirtComponentExceedsRequestedCPU


Note You need to log in before you can comment on or make changes to this bug.