Skip to content

Commit 2f2c27e

Browse files
authored
Update README.md with new rename (#516)
<!-- Thank you for contributing! Please make sure that your code changes are covered with tests. In case of new features or big changes remember to adjust the documentation. In case of an existing issue, reference it using one of the following: closes: #ISSUE related: #ISSUE How to write a good git commit message: http://chris.beams.io/posts/git-commit/ --> ## What *Describe what the change is solving* ## How *Describe the solution* ## Breaking Changes *Are there any breaking changes in this PR?*
2 parents 18e9495 + cfec027 commit 2f2c27e

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,12 @@ helm repo add ngrok https://charts.ngrok.com
5050

5151
Then, install the latest version (setting the appropriate values for your environment):
5252

53-
<!-- TODO(operator-rename): Once we've released the ngrok operator, change this back -->
5453
```sh
5554
export NAMESPACE=[YOUR_K8S_NAMESPACE]
5655
export NGROK_AUTHTOKEN=[AUTHTOKEN]
5756
export NGROK_API_KEY=[API_KEY]
5857

59-
helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
58+
helm install ngrok-operator ngrok/ngrok-operator \
6059
--namespace $NAMESPACE \
6160
--create-namespace \
6261
--set credentials.apiKey=$NGROK_API_KEY \
@@ -78,9 +77,8 @@ kubectl apply -f https://github.com/kubernetes-sigs/gateway-api/releases/downloa
7877

7978
Then, during the helm install set the experimental gateway flag.
8079

81-
<!-- TODO(operator-rename): Once we've released the ngrok operator helm chart, change this back -->
8280
```sh
83-
helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
81+
helm install ngrok-operator ngrok/ngrok-operator \
8482
--namespace $NAMESPACE \
8583
--create-namespace \
8684
--set credentials.apiKey=$NGROK_API_KEY \
@@ -91,10 +89,9 @@ helm install ngrok-ingress-controller ngrok/kubernetes-ingress-controller \
9189

9290
Apply the [sample combined manifest](manifest-bundle.yaml) from our repo:
9391

94-
<!-- TODO(operator-rename): Once we've released the ngrok operator, change this back -->
9592
```sh
96-
kubectl apply -n ngrok-ingress-controller \
97-
-f https://raw.githubusercontent.com/ngrok/kubernetes-ingress-controller/main/manifest-bundle.yaml
93+
kubectl apply -n ngrok-operator \
94+
-f https://raw.githubusercontent.com/ngrok/ngrok-operator/main/manifest-bundle.yaml
9895
```
9996

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

0 commit comments

Comments
 (0)