rancher-partner-charts/charts/ngrok/kubernetes-ingress-controller

ngrok Ingress Controller

This is the helm chart to install the ngrok ingress controller

Usage

Prerequisites

The cluster Must be setup with a secret named ngrok-ingress-controller-credentials with the following keys:

• AUTHTOKEN
• API_KEY

Install the controller with helm

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm has been set up correctly, add the repo as follows:

helm repo add ngrok https://ngrok.github.io/kubernetes-ingress-controller

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo ngrok to see the charts.

To install the ngrok-ingress-controller chart:

helm install my-ngrok-ingress-controller ngrok/kubernetes-ingress-controller

To uninstall the chart:

helm delete my-ngrok-ingress-controller

Parameters

Common parameters

Name	Description	Value
nameOverride	String to partially override generated resource names	""
fullnameOverride	String to fully override generated resource names	""
commonLabels	Labels to add to all deployed objects	{}
commonAnnotations	Annotations to add to all deployed objects	{}

Controller parameters

Name	Description	Value
podAnnotations	Used to apply custom annotations to the ingress pods.	{}
podLabels	Used to apply custom labels to the ingress pods.	{}
replicaCount	The number of controllers to run.	1
image.registry	The ngrok ingress controller image registry.	docker.io
image.repository	The ngrok ingress controller image repository.	ngrok/kubernetes-ingress-controller
image.tag	The ngrok ingress controller image tag. Defaults to the chart's appVersion if not specified	""
image.pullPolicy	The ngrok ingress controller image pull policy.	IfNotPresent
image.pullSecrets	An array of imagePullSecrets to be used when pulling the image.	[]
ingressClass.name	The name of the ingress class to use.	ngrok
ingressClass.create	Whether to create the ingress class.	true
ingressClass.default	Whether to set the ingress class as default.	false
controllerName	The name of the controller to look for matching ingress classes	k8s.ngrok.com/ingress-controller
watchNamespace	The namespace to watch for ingress resources. Defaults to all	""
credentials.secret.name	The name of the secret the credentials are in. If not provided, one will be generated using the helm release name.	""
credentials.apiKey	Your ngrok API key. If provided, it will be will be written to the secret and the authtoken must be provided as well.	""
credentials.authtoken	Your ngrok authtoken. If provided, it will be will be written to the secret and the apiKey must be provided as well.	""
region	ngrok region to create tunnels in. Defaults to connect to the closest geographical region.	""
serverAddr	This is the URL of the ngrok server to connect to. You should set this if you are using a custom ingress URL.	""
metaData	This is a map of key/value pairs that will be added as meta data to all ngrok api resources created	{}
affinity	Affinity for the controller pod assignment	{}
podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
nodeAffinityPreset.key	Node label key to match. Ignored if affinity is set.	""
nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set.	[]
priorityClassName	Priority class for pod scheduling	""
podDisruptionBudget.create	Enable a Pod Disruption Budget creation	false
podDisruptionBudget.minAvailable	Minimum number/percentage of pods that should remain scheduled	""
podDisruptionBudget.maxUnavailable	Maximum number/percentage of pods that may be made unavailable	1
resources.limits	The resources limits for the container	{}
resources.requests	The requested resources for the container	{}
extraVolumes	An array of extra volumes to add to the controller.	[]
extraVolumeMounts	An array of extra volume mounts to add to the controller.	[]
extraEnv	an object of extra environment variables to add to the controller.	{}
serviceAccount.create	Specifies whether a ServiceAccount should be created	true
serviceAccount.name	The name of the ServiceAccount to use.	""
serviceAccount.annotations	Additional annotations to add to the ServiceAccount	{}
log.level	The level to log at. One of 'debug', 'info', or 'error'.	info
log.stacktraceLevel	The level to report stacktrace logs one of 'info' or 'error'.	error
log.format	The log format to use. One of console, json.	json
lifecycle	an object containing lifecycle configuration	{}