Skip to content

Commit bbf687b

Browse files
📖 follow up of update metrics documentation to bring more clarity #4358 (#4359)
1 parent 45925f3 commit bbf687b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/book/src/reference/metrics.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
By default, controller-runtime builds a global prometheus registry and
44
publishes [a collection of performance metrics](/reference/metrics-reference.md) for each controller.
55

6+
67
<aside class="note warning">
78
<h1>IMPORTANT: If you are using `kube-rbac-proxy`</h1>
89

@@ -11,10 +12,14 @@ Your projects will be affected and may fail to work if the image cannot be pulle
1112

1213
**Images provided under `gcr.io/kubebuilder/` will be unavailable from early 2025.**
1314

14-
- **Projects initialized with Kubebuilder versions `v3.14` or lower** utilize [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy) to protect the metrics endpoint. Therefore, you might want to continue using kube-rbac-proxy by simply replacing the image or changing how the metrics endpoint is protected in your project.
15+
- **Projects initialized with Kubebuilder versions `v3.14` or lower** utilize [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy) to protect the metrics endpoint.
16+
In this case, you might want to upgrade your project to the latest release or ensure that you have applied the same or similar code changes.
17+
18+
- **However, projects initialized with Kubebuilder versions `v4.1.0` or higher** have similar protection using `authn/authz`
19+
enabled by default via Controller-Runtime's feature [WithAuthenticationAndAuthorization](https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/metrics/filters#WithAuthenticationAndAuthorization).
1520

16-
- **However, projects initialized with Kubebuilder versions `v4.1.0` or higher** have a similar protection using authn/authz enabled by default via Controller-Runtime's feature [WithAuthenticationAndAuthorization](https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/metrics/filters#WithAuthenticationAndAuthorization).
17-
In this case, you might want to upgrade your project or simply ensure that you have applied the same code changes to it.
21+
If you want to continue using [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy) then you MUST change
22+
your project to use the image from another source.
1823

1924
> This infrastructure is outside of our control, we cannot guarantee any timeline or any extensions.
2025
> For further information, see: [kubebuilder/discussions/3907](https://github.com/kubernetes-sigs/kubebuilder/discussions/3907)

0 commit comments

Comments
 (0)