kubernetes-sigs/cluster-api-operator

[documentation] `metrics-bind-addr` should be removed from cluster-api-operator documentation

Open

#765 opened on Mar 31, 2025

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Go (130 forks)auto 404
help wantedtriage/accepted

Repository metrics

Stars
 (282 stars)
PR merge metrics
 (PR metrics pending)

Description

metrics-bind-addr was removed in v1.9.0 release

https://github.com/kubernetes-sigs/cluster-api/pull/11140 https://github.com/kubernetes-sigs/cluster-api/blob/155e6604aea01770c979631265c057e5e7eff45e/CHANGELOG/v1.9.0.md

the flag's code was removed in https://github.com/kubernetes-sigs/cluster-api-operator/pull/665/files

but cluster-api-operator documentation still reffers to it https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/docs/README.md?plain=1#L158

Just removing this one line from the documentation might not be enough; I believe that the documentation on collecting metrics should be revisited.

Contributor guide

Research direction
Remove the line referencing `metrics bind addr` from docs/README.md line 158 and update the metrics collection documentation accordingly.
Tech stack
go
Domain
backendinfrastructure
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85