Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add runbooks for observability controller alerts #280

Conversation

machadovilaca
Copy link
Member

Add runbooks for observability controller alerts

  • HAControlPlaneDown
  • NodeNetworkInterfaceDown
  • HighCPUWorkload

/cc @sradco @jherrman

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Release note:

Add runbooks for observability controller alerts

@kubevirt-bot kubevirt-bot requested a review from sradco January 21, 2025 15:13
@kubevirt-bot kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Jan 21, 2025
@kubevirt-bot
Copy link

@machadovilaca: GitHub didn't allow me to request PR reviews from the following users: jherrman.

Note that only kubevirt members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

Add runbooks for observability controller alerts

  • HAControlPlaneDown
  • NodeNetworkInterfaceDown
  • HighCPUWorkload

/cc @sradco @jherrman

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Release note:

Add runbooks for observability controller alerts

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Copy link
Contributor

@jherrman jherrman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @machadovilaca , added a couple of suggestions and comments for the text, by way of writer review. Apply them as you see fit :-)

Cheers,
J.

docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HighCPUWorkload.md Outdated Show resolved Hide resolved
docs/runbooks/HighCPUWorkload.md Outdated Show resolved Hide resolved
docs/runbooks/NodeNetworkInterfaceDown.md Outdated Show resolved Hide resolved
docs/runbooks/NodeNetworkInterfaceDown.md Outdated Show resolved Hide resolved
docs/runbooks/NodeNetworkInterfaceDown.md Outdated Show resolved Hide resolved
@machadovilaca machadovilaca force-pushed the add-observability-controller-alerts-runbooks branch from b4fcc01 to d822c7d Compare January 22, 2025 14:19
@machadovilaca
Copy link
Member Author

updated @jherrman

@machadovilaca
Copy link
Member Author

updated @jherrman

@jherrman can you take a new look?

Copy link
Contributor

@jherrman jherrman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@machadovilaca , apologies for the delay. Added a couple more suggestions for minor rewording, but otherwise this is ship-shape from my side :-)

docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HAControlPlaneDown.md Outdated Show resolved Hide resolved
docs/runbooks/HighCPUWorkload.md Outdated Show resolved Hide resolved
docs/runbooks/HighCPUWorkload.md Outdated Show resolved Hide resolved
docs/runbooks/HighCPUWorkload.md Outdated Show resolved Hide resolved
docs/runbooks/NodeNetworkInterfaceDown.md Outdated Show resolved Hide resolved
@machadovilaca machadovilaca force-pushed the add-observability-controller-alerts-runbooks branch from d822c7d to a5cc59e Compare February 4, 2025 13:47
@machadovilaca
Copy link
Member Author

@jherrman updated 🚀

@jherrman
Copy link
Contributor

jherrman commented Feb 4, 2025

/lgtm

sradco
sradco previously approved these changes Feb 12, 2025
@sradco
Copy link
Collaborator

sradco commented Feb 12, 2025

@machadovilaca some of the command are grouped together so the user cant use the copy function. Can you please update?

- HAControlPlaneDown
- NodeNetworkInterfaceDown
- HighCPUWorkload

Signed-off-by: João Vilaça <[email protected]>
@machadovilaca machadovilaca force-pushed the add-observability-controller-alerts-runbooks branch from a5cc59e to c546cb5 Compare February 12, 2025 14:57
@machadovilaca
Copy link
Member Author

@machadovilaca some of the command are grouped together so the user cant use the copy function. Can you please update?

@sradco updated

- Verify CPU, memory, and disk usage
```bash
# Check the node's CPU and memory resource usage
kubectl top node <node-name>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we know how much usage will count as problematic?

- Consider replacing the node if necessary

## Additional notes
- Maintain at least three control plane nodes for high availability
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Maintain at least three control plane nodes for high availability
- Maintain at least 3 control plane nodes for high availability

## Additional notes
- Maintain at least three control plane nodes for high availability
- Monitor etcd cluster health if the affected node runs etcd
- Document any infrastructure-specific recovery procedures
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure I understand this sentence, where to document? how it can help?

@avlitman
Copy link
Collaborator

/lgtm

@sradco sradco merged commit 2239771 into kubevirt:main Feb 12, 2025
2 checks passed
github-actions bot pushed a commit that referenced this pull request Feb 12, 2025
…vability-controller-alerts-runbooks

Add runbooks for observability controller alerts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes Indicates the PR's author has DCO signed all their commits. size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants