Skip to content
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.

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

fix: rename k8s ingress controller to k8s operator #950

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/agent/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ POST/api/tunnels

### Parameters

Parameter names and behaviors are identical to those those defined in the configuration file. Use the [tunnel definitions](/agent/config#tunnel-configurations) section as a reference for configuration parameters and their behaviors.
Parameter names and behaviors are identical to those those defined in the configuration file. Use the [tunnel definitions](/agent/config/v2/#tunnel-configurations) section as a reference for configuration parameters and their behaviors.

### Example request body

Expand Down
6 changes: 3 additions & 3 deletions docs/agent/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ title: Changelog
- Added `--url` agent CLI flag for creation of HTTP(S), TLS, and TCP protocol endpoints.
- Deprecated `--domain`, `--scheme`, and `--remote-addr` agent CLI flags, which have been replaced by `--url`.
- Added `--metadata` and `--description` agent CLI flags when using `--url`.
- Added `endpoints:` as a new field used for [endpoint creation](/docs/agent/config/v3/#full-example).
- Added `endpoints:` as a new field used for [endpoint creation](/docs/agent/config/v3/).
- A new `agent:` field has been added to the agent configuration format for V3.
- v3 supports _both_ tunnels and endpoints. Tunnels are now considered deprecated when using config v3.
- Some agent configuration fields have been renamed in v3.
Expand All @@ -29,7 +29,7 @@ title: Changelog
- Added `--url` agent CLI flag for creation of HTTP(S), TLS, and TCP protocol endpoints.
- Deprecated `--domain`, `--scheme`, and `--remote-addr` agent CLI flags, which have been replaced by `--url`.
- Added `--metadata` and `--description` agent CLI flags when using `--url`.
- Added `endpoints:` as a new field used for [endpoint creation](/docs/agent/config/v3/#full-example).
- Added `endpoints:` as a new field used for [endpoint creation](/docs/agent/config/v3/).
- A new `agent:` field has been added to the agent configuration format for V3.
- v3 supports _both_ tunnels and endpoints. Tunnels are now considered deprecated when using config v3.
- Some agent configuration fields have been renamed in v3.
Expand Down Expand Up @@ -157,7 +157,7 @@ title: Changelog
- Updated `--config` option to be accepted in any position with cli command.
- Fixed `ngrok config add-authtoken <AUTHTOKEN>` to also save the default version if it does not exist in the config file.
- Fixed rare race condition where agent would crash unexpectedly.
- Added DNS rebinding protection which includes [`web_allow_hosts`](/agent/config#web_allow_hosts) configuration.
- Added DNS rebinding protection which includes [`web_allow_hosts`](/agent/config/v3/#web_allow_hosts) configuration.

### ngrok Agent 3.1.0 - \[2022-09-14\]

Expand Down
2 changes: 1 addition & 1 deletion docs/agent/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ ngrok config add-authtoken 1rlHSX3HqrqmOWZdeJ6bIv8rfuo_4cmS1QswRGyxcQD8NOukF

## ngrok config add-server-addr

The `ngrok config add-server-addr` command updates the server address ([`server_addr`](/docs/agent/config/#server_addr)) in the configuration file. This is useful when your account is using [Custom Agent Ingress](/docs/agent/ingress/#customize-agent-ingress-address) and need to configure the `server_addr` to point to your new ingress domain.
The `ngrok config add-server-addr` command updates the connect url ([`connect_url`](/docs/agent/config/v3/#connect_url)) in the configuration file. This is useful when your account is using [Custom Agent Ingress](/docs/agent/ingress/#customize-agent-ingress-address) and need to configure the `connect_url` to point to your new ingress domain.

### Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/agent/config/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,5 @@ merging are as follows:

## Configuration File Formats

- [Version 3](/docs/agent/config/v3)
- [Version 2](/docs/agent/config/v2) (_deprecated_)
- [Version 3](/docs/agent/config/v3/)
- [Version 2](/docs/agent/config/v2/) (_deprecated_)
24 changes: 12 additions & 12 deletions docs/agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ ngrok config add-authtoken <TOKEN>

This command updates the `authtoken` property in your [ngrok configuration file](/agent/config).

Use a separate authtoken for each agent you configure. You can [provision additional authtokens on your ngrok dashboard](https://dashboard.ngrok.com/tunnels/authtokens) or [via API](/agent/config/#authtoken). Separate authtokens isolate the security risk
Use a separate authtoken for each agent you configure. You can [provision additional authtokens on your ngrok dashboard](https://dashboard.ngrok.com/tunnels/authtokens) or [via API](/agent/config/v3/#authtoken). Separate authtokens isolate the security risk
if an authtoken is compromised. It also allows you to configure
[ACLs](#authtoken-acls) on a per agent basis.

Expand Down Expand Up @@ -172,10 +172,10 @@ The ngrok agent supports environment variables for some configuration.
Environment variables take precedence over the corresponding values specified
in the configuration file.

| Name | Configuration Property |
| ----------------- | --------------------------------------- |
| `NGROK_AUTHTOKEN` | [`authtoken`](/agent/config/#authtoken) |
| `NGROK_API_KEY` | [`api_key`](/agent/config/#api_key) |
| Name | Configuration Property |
| ----------------- | ------------------------------------------ |
| `NGROK_AUTHTOKEN` | [`authtoken`](/agent/config/v3/#authtoken) |
| `NGROK_API_KEY` | [`api_key`](/agent/config/v3/#api_key) |

## Running ngrok in the background {#background-service}

Expand All @@ -202,7 +202,7 @@ In most cases, installing ngrok as a service requires administrator privileges.

Create an ngrok [configuration file](#configuration-file). For this example,
we'll assume it's `C:\ngrok\ngrok.yml`. In your configuration file, make sure
you include the [`authtoken`](/agent/config#authtoken) property and define all
you include the [`authtoken`](/agent/config/v3/#authtoken) property and define all
of the tunnels that you want to start. Then run:

```bash
Expand Down Expand Up @@ -305,7 +305,7 @@ Even though the Equinox service was [shut down in 2021](https://equinox.io/blog/

When the ngrok agent dials the ngrok service to establish its TLS connections,
it resolves DNS for the [connection address](/agent/ingress/) which is defined
by the [`server_addr`](/agent/config/#server_addr) configuration property.
by the [`connect_url`](/agent/config/v3/#connect_url) configuration property.
ngrok attempts to resolve DNS using multiple mechanisms so that it can
establish connectivity even in network environments where DNS service is
failing. ngrok attempts to resolve the IPs of its service using the following
Expand All @@ -318,7 +318,7 @@ mechanisms:

Instead of using the system's default DNS resolvers, you can configure
the DNS servers the ngrok agent uses for resolution with the
[`dns_resolver_ips`](/agent/config/#dns_resolver_ips) configuration option.
[`dns_resolver_ips`](/agent/config/v3/#dns_resolver_ips) configuration option.

### TLS Verification

Expand All @@ -336,8 +336,8 @@ certificate returned by the ngrok service has not been revoked. It is possible t
Once the ngrok agent has established connectivity to the ngrok service, it
periodically sends application-level heartbeat messages to validate the
liveness of the connection. You may customize this behavior via the
[`heartbeat_interval`](/agent/config/#heartbeat_interval) and
[`heartbeat_tolerance`](/agent/config/#heartbeat_tolerance) configuration
[`heartbeat_interval`](/agent/config/v3/#heartbeat_interval) and
[`heartbeat_tolerance`](/agent/config/v3/#heartbeat_tolerance) configuration
parameters.

If the ngrok agent does not receive a response to its heartbeat within the
Expand Down Expand Up @@ -437,10 +437,10 @@ ngrok update
By default, the ngrok agent automatically checks for available updates when it
runs. If an update is available, it will prompt you to update by pressing
`Ctrl+U`. You can configure whether the agent checks for updates via the
[`update_check` config parameter](/agent/config/#update_check).
[`update_check` config parameter](/agent/config/v3/#update_check).

You can configure which release channel (e.g. `stable`, `beta`) the agent uses
for updates via the [`update_channel` config parameter](/agent/config/#update_channel).
for updates via the [`update_channel` config parameter](/agent/config/v3/#update_channel).

## IP Restrictions

Expand Down
4 changes: 2 additions & 2 deletions docs/agent/ingress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import CustomIngressSshExample from "/examples/ssh/custom-agent-ingress.mdx";
The Agent Ingress Address is the network address that the ngrok agent and agent
SDKs use to connect to the ngrok service. The default agent ingress address is
`connect.ngrok-agent.com:443`. This is defined in your agent configuration file
under the [`server_addr`](/docs/agent/config/#server_addr) parameter.
under the [`connect_url`](/docs/agent/config/v3/#connect_url) parameter.

## Customize Agent Ingress Address

Expand Down Expand Up @@ -63,7 +63,7 @@ records on the domain you chose.
### Update agent configuration

Finally, you must reconfigure your ngrok agent or agent SDKs to use your new
agent ingress address by adding the [`server_addr`](/docs/agent/config/#server_addr)
agent ingress address by adding the [`connect_url`](/docs/agent/config/v3/#connect_url)
option to your ngrok agent's configuration file. You can use the helper command
[`ngrok config add-server-addr`](/docs/agent/cli/#ngrok-config-add-server-addr) to do this.

Expand Down
16 changes: 8 additions & 8 deletions docs/getting-started/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import StaticDomainKubernetesPathExample from "/examples/k8s/http-static-domain-

# Quickstart: Kubernetes Operator

This quickstart will use the [ngrok Kubernetes Operator](https://github.com/ngrok/kubernetes-ingress-controller) to put an application running on a Kubernetes Cluster on the internet and add some basic policies.
This quickstart will use the [ngrok Kubernetes Operator](https://github.com/ngrok/ngrok-operator) to put an application running on a Kubernetes Cluster on the internet and add some basic policies.

## What is the ngrok Kubernetes Operator?

Expand All @@ -37,10 +37,10 @@ The ngrok Kubernetes Operator is the best way to use ngrok if your applications

## Step 1: Install Kubernetes Operator

Installing the ngrok Operator is easy using Helm.
Installing the ngrok Kubernetes Operator is easy using Helm.

<Tabs groupId="k8s" queryString="k8s-install">
<TabItem value="ingress" label="Ingress Controller" default>
<TabItem value="ingress" label="Kubernetes Operator" default>
<K8sIngressInstallExample />
</TabItem>
<TabItem value="gatewayAPI" label="Gateway API">
Expand All @@ -53,7 +53,7 @@ Installing the ngrok Operator is easy using Helm.
This would create an Edge on with the Domain `example.ngrok.app` that routes traffic to the Kubernetes service `example-service` running on port `80`.

<Tabs groupId="k8s" queryString="k8s-basic">
<TabItem value="ingress" label="Ingress Controller" default>
<TabItem value="ingress" label="Kubernetes Operator" default>
<StaticDomainKubernetesExample />
</TabItem>
<TabItem value="gatewayAPI" label="Gateway API">
Expand All @@ -66,7 +66,7 @@ This would create an Edge on with the Domain `example.ngrok.app` that routes tra
This would create an Edge on with the Domain `example.ngrok.app` that routes traffic from `example.ngrok.app/foo` to the Kubernetes service `example-service` running on port `80`.

<Tabs groupId="k8s" queryString="k8s-basic-path">
<TabItem value="ingress" label="Ingress Controller" default>
<TabItem value="ingress" label="Kubernetes Operator" default>
<StaticDomainKubernetesPathExample />
</TabItem>
<TabItem value="gatewayAPI" label="Gateway API">
Expand All @@ -77,7 +77,7 @@ This would create an Edge on with the Domain `example.ngrok.app` that routes tra
## Step 4: Modify Headers For Incoming Requests

<Tabs groupId="k8s" queryString="k8s-request-headers">
<TabItem value="ingress" label="Ingress Controller" default>
<TabItem value="ingress" label="Kubernetes Operator" default>
<K8sIngressModifyHeadersExample />
</TabItem>
<TabItem value="gatewayAPI" label="Gateway API">
Expand All @@ -88,7 +88,7 @@ This would create an Edge on with the Domain `example.ngrok.app` that routes tra
## Step 5: Redirect Traffic

<Tabs groupId="k8s" queryString="k8s-request-redirect">
<TabItem value="ingress" label="Ingress Controller" default>
<TabItem value="ingress" label="Kubernetes Operator" default>
<K8sIngressRedirectExample />
</TabItem>
<TabItem value="gatewayAPI" label="Gateway API">
Expand All @@ -98,7 +98,7 @@ This would create an Edge on with the Domain `example.ngrok.app` that routes tra

## Next Steps

- Star the [Kubernetes Operator GitHub repo](https://github.com/ngrok/kubernetes-ingress-controller) and follow
- Star the [ngrok Kubernetes Operator GitHub repo](https://github.com/ngrok/ngrok-operator) and follow
it for updates.
- Browse our [examples of HTTP Endpoints](/http/?cty=k8s) to see other ways ngrok can augment your application.
- Bring your own [custom domain to ngrok](/http/#bring-your-own-domain)
4 changes: 2 additions & 2 deletions docs/guides/device-gateway/arm64.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import Tabs from "@theme/Tabs";

In this guide, you'll learn how to install ngrok on any Linux ARM64 device to forward traffic from public endpoints to your upstream services or for remote management. You'll also create some a traffic policy to protect your device from unauthorized traffic.

This guide is specific to ARM64 devices on Linux—if you're using a different device or CPU architecture, first check whether your platform meets the ngrok agent's [system and resource requirements](/docs/agent/index.mdx##system-requirements). We also have other guides that may fit your use case more precisely:
This guide is specific to ARM64 devices on Linux—if you're using a different device or CPU architecture, first check whether your platform meets the ngrok agent's [system and resource requirements](/docs/agent/#system-requirements). We also have other guides that may fit your use case more precisely:

- [Linux AMD64 devices](/docs/guides/device-gateway/linux.md)
- [Raspberry Pi](/docs/guides/device-gateway/raspberry-pi.md)
Expand All @@ -26,7 +26,7 @@ This guide is specific to ARM64 devices on Linux—if you're using a different d
To follow this guide, you need:

- An [ngrok account](https://dashboard.ngrok.com/signup) (some features require a [pay-as-you-go plan](https://ngrok.com/pricing))
- Any ARM64 device running Linux (see our [system requirements](/docs/agent/index.mdx##system-requirements) for all supported architectures)
- Any ARM64 device running Linux (see our [system requirements](/docs/agent/#system-requirements) for all supported architectures)

## Step 1: Install the ngrok Agent

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here you will find a set of guides to help you with common (and not so common) t
| [Per-client Authtokens](/agent/#authtokens) | Learn best practices when deploying many ngrok agents |
| [Rewriting the Host Header](/http/#rewrite-host-header) | Learn how to rewrite the incoming host header for routing traffic to different local services |
| [non-HTTP Services on TLS Tunnels](/tls/) | Learn how to configure non-HTTP services using our TLS tunnels |
| [Multiple Tunnels Same ngrok Agent](/agent/config#tunnel-configurations) | Learn how to use a single ngrok agent session to open many tunnels |
| [Multiple Tunnels Same ngrok Agent](/agent/config/v2/#tunnel-configurations) | Learn how to use a single ngrok agent session to open many tunnels |
| [Securing your Tunnels](/guides/securing-your-tunnels) | Learn how to secure your ngrok tunnels from prying eyes |
| [Serving Local Directories](/http/#file-serving) | Learn how to use ngrok as a file server to quickly share directories with anyone |
| [Wildcard Domains](/network-edge/domains-and-tcp-addresses#wildcard-domains) | Learn how wildcard domains work in ngrok and configure your own |
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Your count of resources against a limit refreshes on the first day of each month

## How it works

ngrok’s plans are designed to suit the use cases of individuals, teams, and organizations using ngrok to create secure ingress for development and production workloads. Each license at ngrok roughly represents a developer using an ngrok agent for building an application. It includes the ability to run an ngrok agent (or use the agent SDKs or Kubernetes Ingress Controller) with a custom domain or TCP Address.
ngrok’s plans are designed to suit the use cases of individuals, teams, and organizations using ngrok to create secure ingress for development and production workloads. Each license at ngrok roughly represents a developer using an ngrok agent for building an application. It includes the ability to run an ngrok agent (or use the agent SDKs or ngrok Kubernetes Operator) with a custom domain or TCP Address.

## What's the difference between the usage-based and seat-based plans?

Expand Down Expand Up @@ -93,7 +93,7 @@ Features included for free on all plans
- Web Inspection Agent
- Replay Requests
- ngrok SDKs
- ngrok Kubernetes Ingress Controller
- ngrok Kubernetes Operator
- Remote Agent Management
- Circuit Breaking
- Automatic Certificates and Encryption
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/running-behind-firewalls.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ When working with the network team, you'll want to set up the following exceptio
Setting up a custom ingress domain can be useful because it ensures that no one can bring their own ngrok account. In this case, the network admins could continue to block traffic to our normal ingress domains and only allow the custom branded ingress domains. For this, you'll need to:

- Set up a [custom ingress domain in your ngrok Dashboard](https://dashboard.ngrok.com/tunnels/ingress)
- Edit your ngrok agent configuration file with a [`server_addr`](/agent/config/#server_addr) parameter, set to the custom ingress domain of your choosing
- Edit your ngrok agent configuration file with a [`connect_url`](/agent/config/v3/#connect_url) parameter, set to the custom ingress domain of your choosing

### Certificate Revocation List

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/securing-your-tunnels.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ For custom domains, use ngrok's [Automated TLS certificates](/network-edge/tls-c

### Using a custom ingress domain

If your organization uses a custom ingress domain, your default ngrok configuration will not work. Edit your ngrok agent configuration to add a [`server_addr`](/agent/config#server_addr) parameter to use the custom ingress domain of your organization.
If your organization uses a custom ingress domain, your default ngrok configuration will not work. Edit your ngrok agent configuration to add a [`connect_url`](/agent/config/v3/#connect_url) parameter to use the custom ingress domain of your organization.

## Tunnel Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/how-ngrok-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ lightweight and easy to install.
the command line while developing and testing.
1. **As an SDK embedded in your app:** Include a small [Agent SDK](/agent-sdks) library
directly into your application software that returns a socket-like object.
1. **As a Kubernetes Controller:** Run our [Ingress Controller](/k8s/) in a
1. **As a Kubernetes Controller:** Run our [ngrok Kubernetes Operator](/k8s/) in a
Kubernetes environment.

## ngrok vs. Traditional reverse proxies
Expand Down
2 changes: 1 addition & 1 deletion docs/http/ip-restrictions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Allow TCP connections from `110.0.0.0/8` and `220.12.0.0/16` but not from
A connection is allowed only if its source IP matches at least one rule with an
'allow' action and does not match any rule with a 'deny' action.

When using Edges and the Kubernetes Ingress Controller, if the IP Restrictions
When using Edges and the ngrok Kubernetes Operator, if the IP Restrictions
module references multiple IP Policies, then the rules of all referenced IP
Policies are unioned together for evaluation.

Expand Down
Loading