How to Create Endpoints in the ngrok Kubernetes Operator

The ngrok Kubernetes Operator offers CloudEndpoint and AgentEndpoint as custom resource types that let you create endpoints in ngrok. The using CRDs guide goes over the details and differences about how to configure each one. This page covers the different types of endpoints you can create using either CloudEndpoint or AgentEndpoint.

HTTP endpoints

The following examples showcase how you can create endpoints that accept http:// cleartext requests.

AgentEndpoint
CloudEndpoint

The example showcases an upstream that accepts http:// requests, but you can also use https:// for the upstream. For AgentEndpoints, the upstream.url scheme doesn’t need to match the scheme of the public URL.

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
name: https-agent-endpoint
namespace: default
spec:
url: http://example-http-domain.ngrok.app
upstream:
  url: http://example-service.default:8080
bindings:
- public

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: CloudEndpoint
metadata:
name: http-cloud-endpoint
spec:
url: http://example-http-domain.ngrok.app
bindings:
- public
trafficPolicy:
  policy:
    on_http_request:
    - actions:
      - type: forward-internal
        config:
          url: http://example-service.internal:8080

HTTPS endpoints

The following examples showcase how you can create endpoints that accept https:// encrypted requests. For HTTPS endpoints, ngrok automatically terminates TLS connections for your HTTPS endpoints. If you’d like to control TLS termination yourself, you can use the terminate-tls Traffic Policy action.

AgentEndpoint
CloudEndpoint

The example showcases an upstream that accepts https:// requests, but you can also use http:// for the upstream. For AgentEndpoints, the upstream.url scheme doesn’t need to match the scheme of the public URL.

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
name: https-agent-endpoint
namespace: default
spec:
url: https://example-http-domain.ngrok.app
upstream:
  url: https://example-service.default:8443
bindings: 
- public

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: CloudEndpoint
metadata:
name: https-cloud-endpoint
spec:
url: https://example-https-domain.ngrok.app
bindings: 
- public
trafficPolicy:
  policy:
    on_http_request: 
    - actions: 
      - type: forward-internal
        config:
          url: https://example-service.internal:8443

TCP endpoints

The following examples showcase how you can create endpoints that accept tcp:// requests. You can use TCP endpoints to forward raw TCP traffic. To create a TCP endpoint, you must first reserve a TCP address through the ngrok dashboard. This step isn’t necessary for internal endpoints. See the bindings page for more information about public/internal/k8s endpoints.

AgentEndpoint
CloudEndpoint

The example showcases an upstream that accepts tcp:// requests, but you can also use tls:// for the upstream. For AgentEndpoints, the upstream.url scheme doesn’t need to match the scheme of the public URL.

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
name: tcp-agent-endpoint
namespace: default
spec:
url: tcp://example-http-domain.ngrok.app
upstream:
  url: tcp://example-service.default:8000
bindings: 
- public

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: CloudEndpoint
metadata:
name: tcp-cloud-endpoint
spec:
url: tcp://example-tcp-domain.ngrok.app
bindings: 
- public
trafficPolicy:
policy:
  on_http_request: 
  - actions: 
    - type: forward-internal
      config:
        url: tcp://example-service.internal:8000
bindings: 
- public

TLS endpoints

The following examples showcase how you can create endpoints that accept tls:// requests. TLS endpoints enable you to deliver any network service that runs over a TLS-based protocol. TLS endpoints make no assumptions about the wrapped protocol being transported. For TLS endpoints, ngrok doesn’t terminate the TLS connection by default, and it’s up to you to handle TLS termination in your upstream service.

AgentEndpoint
CloudEndpoint

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: AgentEndpoint
metadata:
name: tls-agent-endpoint
namespace: default
spec:
url: tls://example-tls-domain.ngrok.app
upstream:
  url: tls://example-service.default:9000
bindings:
- public

apiVersion: ngrok.k8s.ngrok.com/v1alpha1
kind: CloudEndpoint
metadata:
name: tls-cloud-endpoint
spec:
url: tls://example-tls-domain.ngrok.app
bindings:
- public
trafficPolicy:
  policy:
    on_http_request:
    - actions:
      - type: forward-internal
        config:
          url: tls://example-service.internal:9000
bindings:
- public

Getting Started

Use Cases

Examples

Connectivity

Traffic Policy

Observability

Network

Resources

Identity & Access

How to Create Endpoints in the ngrok Kubernetes Operator

HTTP endpoints

HTTPS endpoints

TCP endpoints

TLS endpoints