Project and Helm Chart Rename

[hjkatz]

Hello and thank you for using the ngrok kubernetes-ingress-controller!

ngrok is committed to developing the feature suite of this project.
We are beginning to expand the product areas that this operator will support.

As such the scope of this project is growing and will change.

Specifically we intend to do the following:

• Rename the project to better reflect its purpose
  • from ngrok/kubernetes-ingress-controller
  • to ngrok/ngrok-operator
• Re-home the Helm Chart
  • from https://ngrok.github.io/kubernetes-ingress-controller
  • to https://charts.ngrok.com/ngrok-operator
• Release future versions of the project with tag: ngrok-operator-vX.Y.Z

We plan to make these changes on Wednesday September 11th, 2024.

Any changes to this will be announced here.

Thank you,
ngrok

---

FAQ

When will the rename happen?

Wednesday September 11th, 2024

How will the rename happen?

We are aiming for passivity and discoverability. As such we will take the following steps:

• Rename the repo to ngrok/ngrok-operator
• Fork the repo to a new ngrok/kubernetes-ingress-controller
• Archive the old repo ngrok/kubernetes-ingress-controller

This will enable all Helm charts, CI jobs, etc... to remain working.

But, Github will not automatically redirect URLs from ngrok/kubernetes-ingress-controller -> ngrok/ngrok-operator. We will leave an archive message and update the README.md to help assist with discoverability.

What do I need to do if I already installed the kubernetes-ingress-controller?

If you have already installed the Helm chart under the old name ngrok/kubernetes-ingress-controller, then you will need to do the following the next time you upgrade the release version:

1. Run: $ helm repo add ngrok charts.ngrok.com --force-update
2. Run: $ helm repo update
3. Upgrade as desired: $ helm upgrade

This will allow you to migrate seamlessly to the newly named ngrok/ngrok-operator Helm chart.

Note: If you do not update the helm repo to charts.ngrok.com then you WILL NOT receive new releases or updates to the ngrok operator.

Where can I find documentation?

Docs will remain located at https://ngrok.com/docs/k8s/

Where can I get additional help?

Please reach out to our support team: https://ngrok.com/support