CRDs

Kubernetes has the concept of Custom Resource Definitions (CRDs) which allow you to define your own custom resources. This document will cover the CRDs you might use to achieve your goals with the ngrok Kubernetes Operator.

Warning: There are other CRDs not documented here that are used internally by the controller. It is not recommended to edit these, but inspecting them to query the state of the system could be useful at times. See the internal CRDs document for more details.

Ngrok Module Sets

NgrokModuleSets is a CRD that lets you define combinations of ngrok modules that can be set on your ingress objects and applied to all of their routes. For an in-depth guide on configuring NgrokModuleSets see the Route Modules Guide.

NgrokModuleSetModules

Field	Type	Description
compression	EndpointCompression	Configuration for compression for this module
headers	EndpointHeaders	Configuration for headers for this module
ipRestriction	EndpointIPPolicy	Configuration for IP restriction for this module
tlsTermination	EndpointTLSTerminationAtEdge	Configuration for TLS termination for this module
webhookVerification	EndpointWebhookVerification	Configuration for webhook verification for this module

NgrokModuleSet

Field	Type	Description
apiVersion	string	API version of the NgrokModuleSet custom resource definition
kind	string	Kind of the custom resource definition
metadata	ObjectMeta	Standard Kubernetes metadata
modules	NgrokModuleSetModules	The set of modules for this custom resource definition

NgrokTrafficPolicy

Field	Type	Description
apiVersion	string	API version of the NgrokTrafficPolicy
kind	string	Kind of the custom resource definition
metadata	ObjectMeta	Standard Kubernetes metadata
policy	json.RawMessage	See policy configuration

EndpointCompression

Field	Type	Description
enabled	boolean	Whether or not compression is enabled for this endpoint

EndpointIPPolicy

Field	Type	Description
ippolicies	[]string	List of IP policies for this endpoint

EndpointRequestHeaders

Field	Type	Description
add	map[string]string	Map of header key to header value that will be injected into the HTTP Request
remove	[]string	List of header names that will be removed from the HTTP Request

EndpointResponseHeaders

Field	Type	Description
add	map[string]string	Map of header key to header value that will be injected into the HTTP Response
remove	[]string	List of header names that will be removed from the HTTP Response

EndpointHeaders

Field	Type	Description
request	EndpointRequestHeaders	Configuration for request headers for this endpoint
response	EndpointResponseHeaders	Configuration for response headers for this endpoint

EndpointTLSTerminationAtEdge

Field	Type	Description
minVersion	string	Minimum TLS version to allow for connections to the edge

SecretKeyRef

Field	Type	Description
name	string	Name of the Kubernetes secret
key	string	Key in the secret to use

EndpointWebhookVerification

Field	Type	Description
provider	string	String indicating which webhook provider will be sending webhooks to this endpoint
secret	SecretKeyRef	Reference to a secret containing the secret used to validate requests from the given provider

IP Policies

The IPPolicy CRD manages the ngrok API resource directly. It is a first class CRD that you can manage to control these policies in your account.

It's optional to create IP Policies this way vs using the ngrok dashboard or terraform provider. Once created though, you can use it in your ingress objects using the annotations.

Field	Description	Required	Type	Example
metadata	Standard object metadata	No	metav1.ObjectMeta	name: my-ip-policy
spec.description	Description for the IP policy	No	string	{}
spec.metadata	Metadata for the IP Policy	No	string	{}
spec.rules	A list of rules that belong to the policy	No	[]IPPolicyRule	[{cidr: "1.2.3.4", action: "allow"}]
status.id	The unique identifier for this policy	No	string	"my-ip-policy-id"
status.rules	A list of IP policy rules and their status	No	[]IPPolicyRuleStatus	[{id: "my-rule-id", cidr: "1.2.3.4", action: "allow"}]

IPPolicyRule

Field	Description	Required	Type	Example
cidr	The CIDR block that the rule applies to	Yes	string	"1.2.3.4/24"
action	The action to take for the rule, either "allow" or "deny"	Yes	string	"allow"

IPPolicyRuleStatus

Field	Description	Required	Type	Example
id	The unique identifier for this rule	No	string	"my-rule-id"
cidr	The CIDR block that the rule applies to	No	string	"1.2.3.4/24"
action	The action to take for the rule, either "allow" or "deny"	No	string	"allow"

TCP Edges

The Kubernetes ingress spec does not directly support TCP traffic. The ngrok Kubernetes Operator supports TCP traffic via the TCP Edge resource. This is a first class CRD that you can manage to control these edges in your account. See the TCP and TLS Edges guide for more details.

Field	Type	Required	Description
apiVersion	string	Yes	The API version for this custom resource.
kind	string	Yes	The kind of the custom resource.
metadata	metav1.ObjectMeta	No	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#metadata
spec	TCPEdgeSpec	Yes	Specification of the TCP edge.
status	TCPEdgeStatus	No	Observed status of the TCP edge.

TCPEdgeSpec

Field	Type	Required	Description
description	string	No	A human-readable description of the edge.
metadata	string	No	Metadata for the edge.
backend	TunnelGroupBackend	Yes	The definition for the tunnel group backend that serves traffic for this edge.
ipRestriction	EndpointIPPolicy	No	An IPRestriction to apply to this route.

TunnelGroupBackend

Field	Type	Required	Description
description	string	No	A human-readable description of the backend.
metadata	string	No	Metadata for the backend.
labels	map[string]string	No	Labels to watch for tunnels on this backend.

TCPEdgeStatus

Field	Type	Required	Description
id	string	No	The unique identifier for this edge.
uri	string	No	The URI of the edge.
hostports	[]string	No	Hostports served by this edge.
backend	TunnelGroupBackendStatus	No	Stores the status of the tunnel group backend, mainly the ID of the backend.

TunnelGroupBackendStatus

Field	Type	Required	Description
id	string	No	The unique identifier for this backend.

TLS Edges

ngrok's TLS Edges function similarly to TCP Edges in that they may contain arbitrary application data, not just HTTP. As such, the Kubernetes Ingress spec isn't a perfect fit for them either. The ngrok Kubernetes Operator supports arbitrary TLS endpoints via the TLS Edge resource. This is a first class CRD that you can manage to control these edges in your account. See the TCP and TLS Edges guide for more details.

Field	Type	Required	Description
apiVersion	string	Yes	The API version for this custom resource.
kind	string	Yes	The kind of the custom resource.
metadata	metav1.ObjectMeta	No	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#metadata
spec	TLSEdgeSpec	Yes	Specification of the TCP edge.
status	TLSEdgeStatus	No	Observed status of the TCP edge.

TLSEdgeSpec

Field	Type	Required	Description
description	string	No	A human-readable description of the edge.
metadata	string	No	Metadata for the edge.
backend	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	No	An IPRestriction to apply to this edge.
tlsTermination	TLSTermination	No	TLS Termination behaviour for this edge.
mutualTls	MutualTLS	No	Mutual TLS validation for this edge.

TLSEdgeStatus

Field	Type	Required	Description
id	string	No	The unique identifier for this edge.
uri	string	No	The URI of the edge.
hostports	[]string	No	Hostports served by this edge.
backend	TunnelGroupBackendStatus	No	Stores the status of the tunnel group backend, mainly the ID of the backend.

Domains

Domains are automatically created by the controller based on the ingress objects host values. Standard ngrok subdomains will automatically be created and reserved for you. Custom domains will also be created and reserved, but will be up to you to configure the DNS records for them. See the custom domain guide for more details.

If you delete all the ingress objects for a particular host, as a safety precaution, the Operator does NOT delete the domains and thus does not unregister them. This ensures you don't lose domains while modifying or recreating ingress objects. You can still manually delete a domain CRD via kubectl delete domain <name> if you want to unregister it.

If using a TCP or TLS CRD directly, a Domain will not be created for you automatically, so you will need to create and manage it yourself. See the TCP and TLS Edges guide for details.

Field	Type	Required	Description
apiVersion	string	Yes	The API version for this custom resource.
kind	string	Yes	The kind of the custom resource.
metadata	metav1.ObjectMeta	No	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#metadata
spec	DomainSpec	Yes	Specification of the domain.
status	DomainStatus	No	Observed status of the domain.

DomainSpec

Field	Type	Required	Description
description	string	No	A human-readable description of the domain.
metadata	string	No	Metadata for the domain.
domain	string	Yes	The domain name to reserve.
region	string	Yes	The region in which to reserve the domain.

DomainStatus

Field	Type	Required	Description
id	string	No	The unique identifier of the domain.
domain	string	No	The domain that was reserved.
region	string	No	The region in which the domain was created.
uri	string	No	The URI of the reserved domain API resource.
cnameTarget	string	No	The CNAME target for the domain.

Tunnels

Tunnels are automatically created by the controller based on the ingress objects' rules' backends. A tunnel will be created for each backend service name and port combination. This results in tunnels being created with those labels which can be matched by various edge backends. Automatically-created are useful to inspect but are fully managed by the controller and should not be edited directly.

If using a TCP or TLS CRD, you may need to create and manage a Tunnel yourself. See the TCP and TLS Edges guide for details.

Field	Type	Required	Description
apiVersion	string	Yes	The API version for this custom resource.
kind	string	Yes	The kind of the custom resource.
metadata	metav1.ObjectMeta	No	Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions#metadata
spec	TunnelSpec	Yes	Specification of the tunnel.
status	TunnelStatus	No	Observed status of the tunnel.

TunnelSpec

Field	Type	Required	Description
forwardsTo	string	Yes	The name and port of the service to forward traffic to.
backend	TunnelBackend	Yes	The type of backend this tunnel forwards to.
labels	map[string]string	No	Key/value pairs that are attached to the tunnel.

TunnelBackend

Field	Type	Required	Description
protocol	string	Yes	The protocol understood by this backend. Either TCP or TLS.

TunnelStatus

Field	Type	Required	Description
No fields defined.