Skip to content

Commit 8a47329

Browse files
📖 update metrics documentation to bring more clarity (#4358)
:doc: update metrics documentation to bring more clarity
1 parent e07823e commit 8a47329

File tree

1 file changed

+6
-17
lines changed

1 file changed

+6
-17
lines changed

docs/book/src/reference/metrics.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,18 @@ publishes [a collection of performance metrics](/reference/metrics-reference.md)
66
<aside class="note warning">
77
<h1>IMPORTANT: If you are using `kube-rbac-proxy`</h1>
88

9-
**Images provided under `gcr.io/kubebuilder/` will be unavailable from March 18, 2025.**
9+
Please stop using the image `gcr.io/kubebuilder/kube-rbac-proxy` as soon as possible.
10+
Your projects will be affected and may fail to work if the image cannot be pulled.
11+
12+
**Images provided under `gcr.io/kubebuilder/` will be unavailable from early 2025.**
1013

1114
- **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.
1215

1316
- **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).
1417
In this case, you might want to upgrade your project or simply ensure that you have applied the same code changes to it.
1518

16-
> Please ensure that you update your configurations accordingly to avoid any disruptions.
17-
18-
### ❓ Why is this happening?
19-
20-
Kubebuilder has been rebuilding and re-tagging these images for several years. However, due to recent infrastructure changes for projects under the Kubernetes umbrella, we now require the use of shared infrastructure. But as [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy) is in a process to be a part of it, but not yet, sadly we cannot build and promote these images using the new k8s infrastructure. To follow up the ongoing process and changes required for the project be accepted by, see: https://github.com/brancz/kube-rbac-proxy/issues/238
21-
22-
Moreover, Google Cloud Platform has [deprecated the Container Registry](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr), which has been used to promote these images.
23-
24-
Additionally, ongoing changes and the phase-out of the previous GCP infrastructure mean that **Kubebuilder maintainers are no longer able to support, build, or ensure the promotion of these images.** For further information, please check the proposal for this change and its motivations [here](https://github.com/kubernetes-sigs/kubebuilder/pull/2345).
25-
26-
### How the metrics endpoint can be protected ?
27-
28-
- **(Protection enabled by default from release `v4.1.0`)** By using Controller-Runtime's feature [WithAuthenticationAndAuthorization](https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/metrics/filters#WithAuthenticationAndAuthorization) which can handle `authn/authz` similar what was provided via `kube-rbac-proxy`.
29-
- By using NetworkPolicies. ([example](https://github.com/prometheus-operator/kube-prometheus/discussions/1907#discussioncomment-3896712))
30-
- By integrating cert-manager with your metrics service you can secure the endpoint via TLS encryption
31-
- **(Not support or promoted by Kubebuilder)** By still using [kube-rbac-proxy](https://github.com/brancz/kube-rbac-proxy) and the image provided by the project ([quay.io/brancz/kube-rbac-proxy](https://quay.io/repository/brancz/kube-rbac-proxy)) or from any other source
19+
> This infrastructure is outside of our control, we cannot guarantee any timeline or any extensions.
20+
> For further information, see: [kubebuilder/discussions/3907](https://github.com/kubernetes-sigs/kubebuilder/discussions/3907)
3221
3322
</aside>
3423

0 commit comments

Comments
 (0)