DOCS-2694 [GH#10755]: Stop telling operator users to create a Typha metrics service - #2899
Open
caseydavenport wants to merge 2 commits into
Open
DOCS-2694 [GH#10755]: Stop telling operator users to create a Typha metrics service#2899caseydavenport wants to merge 2 commits into
caseydavenport wants to merge 2 commits into
Conversation
The operator creates one in calico-system when typhaMetricsPort is set.
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Calico component-metrics monitoring docs to avoid instructing operator users to create a redundant Typha metrics Service, aligning the Operator instructions with the operator-managed calico-typha-metrics Service.
Changes:
- Replaced the Operator-tab Typha step that created
typha-metrics-svcwith guidance to use the operator-createdcalico-typha-metricsService. - Updated the Prometheus scrape config example to match the operator-created Service name.
- Removed the Operator-tab cleanup step that deleted
typha-metrics-svc(since users no longer create it there), across “next” and versions 3.29–3.32.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| calico/operations/monitor/monitor-component-metrics.mdx | Stops Operator users from creating a redundant Typha metrics Service; points Prometheus config at calico-typha-metrics. |
| calico_versioned_docs/version-3.32/operations/monitor/monitor-component-metrics.mdx | Backports the same Operator Typha metrics Service guidance and Prometheus config update to v3.32 docs. |
| calico_versioned_docs/version-3.31/operations/monitor/monitor-component-metrics.mdx | Backports the same Operator Typha metrics Service guidance and Prometheus config update to v3.31 docs. |
| calico_versioned_docs/version-3.30/operations/monitor/monitor-component-metrics.mdx | Backports the same Operator Typha metrics Service guidance and Prometheus config update to v3.30 docs. |
| calico_versioned_docs/version-3.29/operations/monitor/monitor-component-metrics.mdx | Backports the same Operator Typha metrics Service guidance and Prometheus config update to v3.29 docs. |
Collaborator
|
LGTM, ready to merge? |
ctauchen
approved these changes
Aug 10, 2026
ctauchen
left a comment
ctauchen
left a comment
Collaborator
There was a problem hiding this comment.
One small quibble, otherwise LGTM.
| <Tabs> | ||
| <TabItem label="Operator" value="Operator-8"> | ||
|
|
||
| When you set `typhaMetricsPort`, the operator automatically creates a service that exposes these metrics. You do not need to create one yourself. |
Collaborator
There was a problem hiding this comment.
When you set typhaMetricsPort to what? Better to be explicit.
ctauchen
changed the title
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.
Product Version(s):
Calico next, 3.32, 3.31, 3.30, 3.29
Issue:
projectcalico/calico#10755
Link to docs preview:
SME review:
DOCS review:
Additional information:
Setting
typhaMetricsPortalready gets you acalico-typha-metricsservice incalico-system, so the tutorial was walking operator users into creating a second, redundant one. The Operator tab now points at the operator's service instead, matching what the kube-controllers section already does.Merge checklist: