Skip to content

Update readme to remove preview branding #747

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.

Sign up for GitHub

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

Merged
iambmelt merged 5 commits into from
Jan 28, 2026
Merged

Update readme to remove preview branding #747

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ddf2269
Update readme to remove preview branding
iambmelt Jan 26, 2026
95ff403
Apply suggestion from @iambmelt
iambmelt Jan 26, 2026
69e8705
Apply suggestion from @iambmelt
iambmelt Jan 26, 2026
49688b6
Apply suggestion from @iambmelt
iambmelt Jan 28, 2026
d029238
CR feedback
iambmelt Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ helm install ngrok-operator ngrok/ngrok-operator \

For a more in-depth installation guide follow our step-by-step [Getting Started](https://ngrok.com/docs/using-ngrok-with/k8s/) guide.

#### Gateway API Preview
#### Gateway API

To install the developer preview of the gateway api we'll make the following changes to the above instructions.
To install the CRD of the gateway API we'll make the following changes to the above instructions.

Install the v1 gateway CRD before the helm installation.
```sh
Expand All @@ -91,7 +91,7 @@ helm install ngrok-operator ngrok/ngrok-operator \
--create-namespace \
--set credentials.apiKey=$NGROK_API_KEY \
--set credentials.authtoken=$NGROK_AUTHTOKEN \
--set useExperimentalGatewayApi=true # gateway preview
--set useExperimentalGatewayApi=true # gateway preview
```
### YAML Manifests

Expand All @@ -110,10 +110,6 @@ The full documentation for the ngrok Kubernetes Operator can be found on our [k8

## Known Issues

> **Note**
>
> This project is currently in beta as we continue testing and receiving feedback. The functionality and CRD contracts may change. It is currently used internally at ngrok for providing ingress to some of our production workloads.

1. Current issues can be found in the GitHub issues. [Known/suspected bugs](https://github.com/ngrok/ngrok-operator/issues?q=is%3Aopen+is%3Aissue+label%3Abug) are labeled as `bug`.

## Support
Expand Down