Skip to content

Commit

Permalink
chore(k8s): make registering a domain an explicit step
Browse files Browse the repository at this point in the history
We've gotten a lot of feedback that it is not clear you must register the domain through the dashboard. This PR makes it so that is required step before you get to setting the domain field and explains to the user they will need it later.
  • Loading branch information
nijikokun authored and russorat committed Oct 25, 2023
1 parent a9f85b4 commit e32524b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/using-ngrok-with/k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ To started with the ngrok Ingress Controller for Kubernetes:
1. Access the [ngrok Dashboard](https://dashboard.ngrok.com)
1. Click [Your Authtoken](https://dashboard.ngrok.com/get-started/your-authtoken). Copy the Authtoken to a text editor.
1. Click [API](https://dashboard.ngrok.com/api) and follow the instructions to create a new API key. Copy the API key to a text editor.
1. Click [Cloud Edge > Domains](https://dashboard.ngrok.com/cloud-edge/domains) and register or claim a domain. Save this value, you will need it later. This is the URL you will use to access your service from anywhere.

## Step 2: Setup your Kubernetes cluster and install the ngrok Ingress Controller

Expand Down Expand Up @@ -70,7 +71,7 @@ To started with the ngrok Ingress Controller for Kubernetes:
--set credentials.authtoken=$NGROK_AUTHTOKEN
```

1. Create a manifest file (for example `ngrok-manifest.yaml`) with the following contents. You will need to replace the `NGROK_DOMAIN` on line 45 with your own custom value. This is the URL you will use to access your service from anywhere. If you're on a free account, it must be on a static subdomain which you can claim by logging into your account and following the instructions on the claim static subdomain banner. For paid accounts, you can use a custom domain or a subdomain of `ngrok.app` or `ngrok.dev` (for example, `username-loves-ingress.ngrok.app` or `k8s.example.com`).
1. Create a manifest file (for example `ngrok-manifest.yaml`) with the following contents. You will need to replace the `NGROK_DOMAIN` on line 45 with the domain you registered in Step 1.

:::tip Notes:

Expand Down

1 comment on commit e32524b

@vercel
Copy link

@vercel vercel bot commented on e32524b Oct 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

ngrok-docs – ./

ngrok-docs.vercel.app
ngrok-docs-git-main-ngrok-dev.vercel.app
ngrok-docs-ngrok-dev.vercel.app

Please sign in to comment.