ngrok · russorat · Oct 17, 2023 · Oct 16, 2023
@@ -87,7 +87,7 @@ type SecretKeyRef struct {
 type EndpointWebhookVerification struct {
 	// a string indicating which webhook provider will be sending webhooks to this
 	// endpoint. Value must be one of the supported providers defined at
-	// https://ngrok.com/docs/cloud-edge#webhook-verification
+	// https://ngrok.com/docs/http/webhook-verification/#supported-providers
 	Provider string `json:"provider,omitempty"`
 	// SecretRef is a reference to a secret containing the secret used to validate
 	// requests from the given provider. All providers except AWS SNS require a secret

@@ -1,7 +1,7 @@
 # ngrok Region
 
 ngrok runs globally distributed tunnel servers around the world to enable fast, low latency traffic to your applications.
-See https://ngrok.com/docs/platform/pops/ for more information on ngrok's regions.
+See https://ngrok.com/docs/network-edge/#points-of-presence for more information on ngrok's regions.
 
 Similar to the agent, if you do not explicitly pick a region via helm when installing the controller, the controller will attempt to pick the region with the least latency, which is usually the one geographically closest to your machine.
 

@@ -24,19 +24,19 @@ This may stabilize to a first class CRD in the future, but for now, it's not rec
 | ngrokAPICommon | [ngrokAPICommon](#ngrokapicommon) | No | Common fields shared by all ngrok resources. |
 | hostports | []string | Yes | A list of hostports served by this edge. |
 | routes | []HTTPSEdgeRouteSpec | No | A list of routes served by this edge. |
-| tlsTermination | [EndpointTLSTerminationAtEdge](https://ngrok.com/docs/api#type-EndpointTLSTerminationAtEdge) | No | The TLS termination configuration for this edge. |
+| tlsTermination | [EndpointTLSTerminationAtEdge](https://ngrok.com/docs/api/resources/edges-https/#endpointtlsterminationatedge-parameters) | No | The TLS termination configuration for this edge. |
 
 ### HTTPSEdgeRouteSpec
 | Field | Type | Required | Description |
 | --- | --- | --- | --- |
 | ngrokAPICommon | [ngrokAPICommon](#ngrokapicommon) | No | Common fields shared by all ngrok resources. |
 | matchType | string | Yes | The type of match to use for this route. Valid values are: `exact_path` and `path_prefix`. |
 | match | string | Yes | The value to match against the request path. |
-| backend | [TunnelGroupBackend](https://ngrok.com/docs/api#type-TunnelGroupBackend) | Yes | The definition for the tunnel group backend that serves traffic for this edge. |
-| compression | [EndpointCompression](https://ngrok.com/docs/api#type-EndpointCompression) | No | Whether or not to enable compression for this route. |
-| ipRestriction | [EndpointIPPolicy](https://ngrok.com/docs/api#type-EndpointIPPolicy) | No | An IPRestriction to apply to this route. |
-| headers | [EndpointHeaders](https://ngrok.com/docs/api#type-EndpointHeaders) | No | Request/response headers to apply to this route. |
-| webhookVerification | [EndpointWebhookVerification](https://ngrok.com/docs/api#type-EndpointWebhookVerification) | No | Webhook verification configuration to apply to this route. |
+| backend | [TunnelGroupBackend](https://ngrok.com/docs/api/resources/tunnel-group-backends/) | Yes | The definition for the tunnel group backend that serves traffic for this edge. |
+| compression | [EndpointCompression](https://ngrok.com/docs/api/resources/edges-https-routes/#endpointcompression-parameters) | No | Whether or not to enable compression for this route. |
+| ipRestriction | [EndpointIPPolicy](https://ngrok.com/docs/api/resources/edges-https-routes/#endpointippolicymutate-parameters) | No | An IPRestriction to apply to this route. |
+| headers | [EndpointHeaders](https://ngrok.com/docs/api/resources/edges-https-routes/#endpointrequestheaders-parameters) | No | Request/response headers to apply to this route. |
+| webhookVerification | [EndpointWebhookVerification](https://ngrok.com/docs/api/resources/edges-https-routes/#endpointwebhookvalidation-parameters) | No | Webhook verification configuration to apply to this route. |
 
 ### HTTPSEdgeRouteStatus
 | Field | Type | Required | Description |
@@ -45,7 +45,7 @@ This may stabilize to a first class CRD in the future, but for now, it's not rec
 | uri | string | No | The URI for this route. |
 | match | string | No | The value to match against the request path. |
 | matchType | string | No | The type of match to use for this route. Valid values are: `exact_path` and `path_prefix`. |
-| backend | [TunnelGroupBackendStatus](https://ngrok.com/docs/api#type-TunnelGroupBackendStatus) | No | Stores the status of the tunnel group backend, mainly the ID of the backend. |
+| backend | [TunnelGroupBackendStatus](https://ngrok.com/docs/api/resources/tunnel-group-backends/) | No | Stores the status of the tunnel group backend, mainly the ID of the backend. |
 
 ### HTTPSEdgeStatus
 | Field | Type | Required | Description |

@@ -125,7 +125,7 @@ The Kubernetes ingress spec does not directly support TCP traffic. The ngrok Kub
 | --- | --- | --- | --- |
 | ngrokAPICommon | [ngrokAPICommon](#ngrokapicommon) | No | Common fields shared by all ngrok resources. |
 | backend | [TunnelGroupBackend](#tunnelgroupbackend) | Yes | The definition for the tunnel group backend that serves traffic for this edge. |
-| ipRestriction | [EndpointIPPolicy](https://ngrok.com/docs/api#type-EndpointIPPolicy) | No | An IPRestriction to apply to this route. |
+| ipRestriction | [EndpointIPPolicy](https://ngrok.com/docs/api/resources/tcp-edge-ip-restriction-module/) | No | An IPRestriction to apply to this route. |
 
 ### TunnelGroupBackend
 | Field | Type | Required | Description |
@@ -164,9 +164,9 @@ ngrok's TLS Edges function similarly to TCP Edges in that they may contain arbit
 | ngrokAPICommon | [ngrokAPICommon](#ngrokapicommon) | No | Common fields shared by all ngrok resources. |
 | backend | [TunnelGroupBackend](#tunnelgroupbackend) | Yes | The definition for the tunnel group backend that serves traffic for this edge. |
 | hostports | []string | Yes | A list of hostports served by this edge. |
-| ipRestriction | [EndpointIPPolicy](https://ngrok.com/docs/api#type-EndpointIPPolicy) | No | An IPRestriction to apply to this edge. |
-| tlsTermination | [TLSTermination](https://ngrok.com/docs/api/resources/tls-edge-tls-termination-module/) | No | TLS Termination behaviour for this edge. |
-| mutualTls | [MutualTLS](https://ngrok.com/docs/api/resources/tls-edge-mutual-tls-module/) | No | Mutual TLS validation for this edge. |
+| ipRestriction | [EndpointIPPolicy](https://ngrok.com/docs/api/resources/tls-edge-ip-restriction-module/) | No | An IPRestriction to apply to this edge. |
+| tlsTermination | [TLSTermination](https://ngrok.com/docs/api/resources/edges-tls/#endpointtlstermination-parameters) | No | TLS Termination behaviour for this edge. |
+| mutualTls | [MutualTLS](https://ngrok.com/docs/api/resources/edges-tls/#endpointmutualtlsmutate-parameters) | No | Mutual TLS validation for this edge. |
 
 ### TLSEdgeStatus
 | Field | Type | Required | Description |

@@ -1,6 +1,6 @@
 # Ingress to Edge Relationship
 
-This ingress controller aims to take the [ingress spec](https://kubernetes.io/docs/concepts/services-networking/ingress/#the-ingress-resource) and implement each specified concept into ngrok edges. The concept of an ngrok Edge is documented more [here](https://ngrok.com/docs/cloud-edge/). This document aims to explain how multiple ingress objects with rules and hosts that overlap combine to form edges in the ngrok API.
+This ingress controller aims to take the [ingress spec](https://kubernetes.io/docs/concepts/services-networking/ingress/#the-ingress-resource) and implement each specified concept into ngrok edges. The concept of an ngrok Edge is documented more [here](https://ngrok.com/docs/network-edge/). This document aims to explain how multiple ingress objects with rules and hosts that overlap combine to form edges in the ngrok API.
 
 In Short:
 - a host correlates directly to an edge

@@ -1,6 +1,6 @@
 # IP Restrictions
 
-ngrok offers the ability to restrict access to your edges by IP address via [IP Restrictions](https://ngrok.com/docs/cloud-edge/modules/ip-restrictions/).
+ngrok offers the ability to restrict access to your edges by IP address via [IP Restrictions](https://ngrok.com/docs/http/ip-restrictions/).
 These are configurable via the [IPPolicy](./crds.md#ip-policies) CRD and can be attached to Ingress objects via [NgrokModuleSet](./route-modules.md).
 
 <img src="../assets/images/Under-Construction-Sign.png" alt="Under Construction" width="350" />
@@ -1,7 +1,7 @@
 # Modules
 
 
-ngrok's Cloud Edge [Modules](https://ngrok.com/docs/cloud-edge/modules/) allow you to configure features like compression, IP Restrictions, OAuth, adding/removing headers, and more.
+ngrok's Cloud Edge [Modules](https://ngrok.com/docs/http/#modules) allow you to configure features like compression, IP Restrictions, OAuth, adding/removing headers, and more.
 
 <!-- TOC depthfrom:2 -->
 
@@ -125,7 +125,7 @@ using pre-made configurations.
 
 ### Circuit Breaker
 
-[Circuit breakers](https://ngrok.com/docs/cloud-edge/modules/circuit-breaker/) are used to protect upstream servers by rejecting traffic to them when they become overwhelmed.
+[Circuit breakers](https://ngrok.com/docs/http/circuit-breaker/) are used to protect upstream servers by rejecting traffic to them when they become overwhelmed.
 
 ```yaml
 kind: NgrokModuleSet
@@ -174,7 +174,7 @@ modules:
 
 #### Request
 
-The [Request Headers](https://ngrok.com/docs/cloud-edge/modules/request-headers/) module allows you to add and remove headers from HTTP requests before they are sent to your upstream server.
+The [Request Headers](https://ngrok.com/docs/http/request-headers/) module allows you to add and remove headers from HTTP requests before they are sent to your upstream server.
 
 ```yaml
 kind: NgrokModuleSet
@@ -193,7 +193,7 @@ modules:
 
 #### Response
 
-The [Response Headers module](https://ngrok.com/docs/cloud-edge/modules/response-headers/) allows you to add and remove headers from HTTP responses before they are returned to the client.
+The [Response Headers module](https://ngrok.com/docs/http/response-headers/) allows you to add and remove headers from HTTP responses before they are returned to the client.
 
 ```yaml
 kind: NgrokModuleSet
@@ -212,7 +212,7 @@ modules:
 
 ### IP Restrictions
 
-[IP Restrictions](https://ngrok.com/docs/cloud-edge/modules/ip-restrictions/) allow you to attach one or more IP policies to the route.
+[IP Restrictions](https://ngrok.com/docs/http/ip-restrictions/) allow you to attach one or more IP policies to the route.
 
 Policies may be specified by either their `ID` in the ngrok API or by the name of an `ippolicy.ingress.k8s.ngrok.com` Custom Resource if managed by the ingress controller.
 
@@ -245,7 +245,7 @@ modules:
 
 ### OAuth
 
-The [OAuth module](https://ngrok.com/docs/cloud-edge/modules/oauth/) enforces an OAuth authentication flow in front of any route it is enabled on.
+The [OAuth module](https://ngrok.com/docs/http/oauth/) enforces an OAuth authentication flow in front of any route it is enabled on.
 
 #### Ngrok Managed OAuth Application
 
@@ -304,7 +304,7 @@ modules:
 
 ### OpenID Connect (OIDC)
 
-The [OIDC module](https://ngrok.com/docs/cloud-edge/modules/openid-connect/) restricts endpoint access to only users authorized by a OpenID Identity Provider.
+The [OIDC module](https://ngrok.com/docs/http/openid-connect/) restricts endpoint access to only users authorized by a OpenID Identity Provider.
 
 ```yaml
 ---
@@ -337,7 +337,7 @@ modules:
 
 ### SAML
 
-The [SAML module](https://ngrok.com/docs/cloud-edge/modules/saml/) restricts endpoint access to only users authorized by a SAML IdP.
+The [SAML module](https://ngrok.com/docs/http/saml/) restricts endpoint access to only users authorized by a SAML IdP.
 
 ### TLS Termination
 
@@ -355,7 +355,7 @@ modules:
 
 ### Webhook Verification
 
-The webhook verification module allows ngrok to assert requests to your endpoint originate from a supported webhook provider like Slack or Github.
+The [webhook verification module](https://ngrok.com/docs/http/webhook-verification/) allows ngrok to assert requests to your endpoint originate from a supported webhook provider like Slack or Github.
 
 ```yaml
 ---

@@ -1,7 +1,7 @@
 # TCP and TLS Edges
 
-ngrok offers [TCP](https://ngrok.com/docs/cloud-edge/edges/tcp/) and
-[TLS](https://ngrok.com/docs/cloud-edge/edges/tcp/) Edges which can be used to
+ngrok offers [TCP](https://ngrok.com/docs/tcp/) and
+[TLS](https://ngrok.com/docs/tls/) Edges which can be used to
 provide ingress to TCP or TLS based services. Both are implemented as CRDs and
 function similarly in broad strokes, albeit with slightly different
 configuration options offered. [Their CRD reference](./crds.md#tcp-edges) is a
@@ -30,7 +30,7 @@ Create the edge CRD. These resources are fairly similar, and both require you to
 specify a [TunnelGroupBackend](./crds.md#tunnelgroupbackend). This consists of a
 list of labels that determine which specific [Tunnel](./crds.md#tunnels) should
 receive traffic from the edge. Both may also specify [IP
-Policies](https://ngrok.com/docs/api/resources/ip-policies/) for limiting access
+Policies](https://ngrok.com/docs/tls/ip-restrictions/) for limiting access
 to the edge. At the time of writing, these policies must be provided as a
 reference in the form `ipp_<id>`.