Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

⚠️ Action Required: Replace Deprecated gcr.io/kubebuilder/kube-rbac-proxy #4823

Open
camilamacedo86 opened this issue Nov 30, 2024 · 4 comments

Comments

@camilamacedo86
Copy link

Description

⚠️ The image gcr.io/kubebuilder/kube-rbac-proxy is deprecated and will become unavailable.
You must move as soon as possible, sometime from early 2025, the GCR will go away.

Unfortunately, we're unable to provide any guarantees regarding timelines or potential extensions at this time. Images provided under GRC will be unavailable from March 18, 2025, as per announcement. However, gcr.io/kubebuilder/may be unavailable before this date due to efforts to deprecate infrastructure.

  • If your project uses gcr.io/kubebuilder/kube-rbac-proxy, it will be affected.
    Your project may fail to work if the image cannot be pulled. You must take action as soon as possible.

  • However, if your project is no longer using this image, no action is required, and you can close this issue.

Using the image gcr.io/kubebuilder/kube-rbac-proxy?

kube-rbac-proxy was historically used to protect the metrics endpoint. However, its usage has been discontinued in Kubebuilder. The default scaffold now leverages the WithAuthenticationAndAuthorization feature provided by Controller-Runtime.

This feature provides integrated support for securing metrics endpoints by embedding authentication (authn) and authorization (authz) mechanisms directly into the controller manager's metrics server, replacing the need for (https://github.com/brancz/kube-rbac-proxy) to secure metrics endpoints.

What To Do?

You must replace the deprecated image gcr.io/kubebuilder/kube-rbac-proxy with an alternative approach. For example:

  • Update your project to use WithAuthenticationAndAuthorization:

    You can fully upgrade your project to use the latest scaffolds provided by the tool or manually make the necessary changes. Refer to the FAQ and Discussion for detailed instructions on how to manually update your project and test the changes.

  • Alternatively, replace the image with another trusted source at your own risk, as its usage has been discontinued in Kubebuilder.

For further information, suggestions, and guidance:

NOTE: This issue was opened automatically as part of our efforts to identify projects that might be affected and to raise awareness about this change within the community. If your project is no longer using this image, feel free to close this issue.

We sincerely apologize for any inconvenience this may cause.

Thank you for your cooperation and understanding! 🙏

@zhaohuabing
Copy link
Member

zhaohuabing commented Dec 2, 2024

kube-rbac-proxy has alredy been removed from the EG chart since 0.6.0.

@camilamacedo86
Copy link
Author

Hi @zhaohuabing

It seems that the reason for this project came up is: https://github.com/envoyproxy/gateway/blob/main/site/content/en/v0.5/install/api.md?plain=1#L37

@zhaohuabing
Copy link
Member

zhaohuabing commented Dec 2, 2024

@camilamacedo86 Thanks for reminding us about the deprecation of kube-rbac-proxy. kube-rbac-proxy has been used in in Envoy Gateway v0.5, but not any more, that's why we still has the text in this file. Should we delete every text references of gcr.io/kubebuilder/kube-rbac-proxy to remove this warning?

@zhaohuabing zhaohuabing reopened this Dec 2, 2024
@camilamacedo86
Copy link
Author

Hi @zhaohuabing

You should no longer receive this warning since it was sent already.
I recommend you change the doc to avoid giving the wrong guidance to the users.
Furthermore, I would like to recommend that you export the metrics endpoint but ensure that it is well protected.

You can use the WithAuthenticationAndAuthorization feature provided by Controller-Runtime.

This feature provides integrated support for securing metrics endpoints by embedding authentication (authn) and authorization (authz) mechanisms directly into the controller manager's metrics server, replacing the need for (https://github.com/brancz/kube-rbac-proxy) to secure metrics endpoints.

Therefore, I would recommend you wait for the next release, 4.4.0, which will provide support for k8s 1.32 and, if possible, fully upgrade your project with the latest scaffold. This ensures a default implementation (similar to kube-rbac-proxy) with options to improve production readiness, such as configuring certificates securely (i.e. see the feature that will be available in the next release kubernetes-sigs/kubebuilder#4400).

This approach also allows you to take advantage of other improvements, bug fixes, and the latest updates. Indeed, ensure that your layout addresses all breaking changes introduced by controller runtime v0.20.0 over webhooks.

However, it seems that you are set regards be impacted by the image no longer be available.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants