Skip to content

Commit

Permalink
Update README.md with new rename (#516)
Browse files Browse the repository at this point in the history
<!-- 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?*
  • Loading branch information
hjkatz authored Nov 15, 2024
2 parents 18e9495 + cfec027 commit 2f2c27e
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,12 @@ helm repo add ngrok https://charts.ngrok.com

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

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

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

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

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

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

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

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

0 comments on commit 2f2c27e

Please sign in to comment.