Repository navigation
Conversation
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Two active documentation issues remain: the possible component values omit the valid secrets value, and the Prometheus manifest leaves an unreplaced namespace placeholder that would fail validation.
2 open issues
What changed in this PR
Completes the Calico Enterprise 3.24 operator metrics documentation, including release and upgrade guidance, metric references, alerting examples, and BYO Prometheus configuration.
Changes:
- Adds operator metrics release notes and
METRICS_SCHEMEupgrade guidance. - Documents component values, license metric labels, certificate alert timing, and a custom alert rule.
- Adds mTLS and network policy guidance for scraping operator metrics with BYO Prometheus.
| File | Summary | Review notes |
|---|---|---|
calico-enterprise/release-notes/index.mdx |
Adds operator metrics release and upgrade notes. | No findings. |
calico-enterprise/operations/monitor/prometheus/byo-prometheus.mdx |
Adds operator mTLS requirements and an example egress policy for BYO Prometheus. | The example should instruct readers to replace the namespace placeholder as well as the pod selector. |
calico-enterprise/operations/monitor/metrics/operator-metrics.mdx |
Expands the metrics reference with component values, license labels, alert details, and a custom alert example. | Clarify that the component values are examples or include secrets; correct the certificate-management guidance to reflect the operator’s behavior with CSR-based certificate management. |
Review effort: Lite
| - Logs: `log-collector`, `log-collector-otel`, `log-storage`, `log-storage-access`, `log-storage-dashboards`, `log-storage-elastic`, `log-storage-esmetrics`, `log-storage-kubecontrollers`, `log-storage-secrets`, `log-storage-users` | ||
| - Threat defense and policy: `intrusion-detection`, `policy-recommendation`, `packet-capture` | ||
| - Traffic features: `applicationlayer`, `egressgateway`, `gatewayapi`, `istio` | ||
| - Hosts and clusters: `non-cluster-hosts`, `management-cluster-connection` |
Comment on lines
+396
to
+397
| The following example allows this traffic. | ||
| Replace the selector with one that matches your Prometheus pods. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Completes the operator metrics docs for Calico Enterprise 3.24: release note, upgrade note for METRICS_SCHEME, the package label on the license metrics, component values, an example alert rule, and mTLS and network policy guidance for bring-your-own Prometheus.
Jira: https://tigera.atlassian.net/browse/DOCS-3160
Preview
To do
Flags