OSDOCS-16225 [NETOBSERV] New Network Observability Operator alerts content

[gwynnemonahan]

OSDOCS-16225 [NETOBSERV] New Network Observability Operator alerts content

TECHNOLOGY PREVIEW FEATURE

Version(s):
Merge to only the no-1.10 branch - no cherrypicks are required.
I will open one PR against main to incorporate all of the <no-.10> content just before its GA.

Note to self for integration: applies to OCP 4.12, 4.14+

Issue:
https://issues.redhat.com/browse/OSDOCS-16225

Link to docs preview:

• Network observability alerts: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts.html
• About network observability alerts: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#network-observability-alerts-about_network-observability-alerts
• List of default alerts: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#network-observability-default-alerts_network-observability-alerts
• Configuring predefined alerts: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#network-observability-configuring-predefined-alerts_network-observability-alerts
• Understanding the PromQL expression for alerts: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#network-observability-alerts-promql-expression_network-observability-alerts
• Alert Metadata for Prometheus and Network Health: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#alert-meta-data-prometheus-network-health_network-observability-alerts
• Creating custom alert rules: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#network-observability-creating-custom-alert-rules_network-observability-alerts
• Disabling predefined alerts: https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts#network-observability-disabling-predefined-alerts_network-observability-alerts

QE review:

• QE has approved this change.

Additional information:

• xrefs being handled by https://issues.redhat.com/browse/OSDOCS-16509

[ocpdocs-previewbot]

🤖 Thu Oct 16 17:49:16 - Prow CI generated the docs preview:

https://99499--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/network_observability/network-observability-alerts.html

[jotak]

@gwynnemonahan I've updated the upstream a little bit: netobserv/network-observability-operator#2070

Preview: https://github.com/netobserv/network-observability-operator/blob/f3d67c2714d7de8efb12e8a88a6067cb04f15358/docs/Alerts.md

Changes are:

• Like mentioned here, remove the threshold and grouping details from the list of default alerts
• More importantly I've added a section that was missing, on metadata, when user want to create their own alerts
• In the promql examples, I've replaced all occurrences of netobserv_namespace_ingress_bytes_total with netobserv_workload_ingress_bytes_total. The reason is that we changed the latter to be the new default, so unless they have a specific config, users will likely have that one available instead of the other.

[gwynnemonahan]

@gwynnemonahan I've updated the upstream a little bit: netobserv/network-observability-operator#2070

Preview: https://github.com/netobserv/network-observability-operator/blob/f3d67c2714d7de8efb12e8a88a6067cb04f15358/docs/Alerts.md

Changes are:

• Like mentioned here, remove the threshold and grouping details from the list of default alerts
• More importantly I've added a section that was missing, on metadata, when user want to create their own alerts
• In the promql examples, I've replaced all occurrences of netobserv_namespace_ingress_bytes_total with netobserv_workload_ingress_bytes_total. The reason is that we changed the latter to be the new default, so unless they have a specific config, users will likely have that one available instead of the other.

Hey @jotak ,

I've made updates based on your changes. Please take a look. Thanks!

[jotak]

Thanks @gwynnemonahan , great doc! (I really like how you structured the "about promQL" part 👍 )
Just a few small comments

[jotak]

Thanks, LGTM

[gwynnemonahan]

/label merge-review-needed

[gwynnemonahan]

/remove-label merge-review-needed

[memodi]

/label qe-approved

[gwynnemonahan]

/label merge-review-needed

[gwynnemonahan]

/remove-label merge-review-needed

There are some discrepancies between what is showing in GitHub and what is showing in VSCode, and I want to try and address those, based on the Rel Notes PR. Removing label for merge review.

[gwynnemonahan]

/label merge-review-needed

[lpettyjo]

Otherwise, LGTM. Let me know after you've addressed comments if you need a merge.

[openshift-ci]

@gwynnemonahan: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.