From d3227df0443e2137779c7ad0d814e3939c662e7e Mon Sep 17 00:00:00 2001 From: jonstacks Date: Tue, 17 Jan 2023 21:35:34 +0000 Subject: [PATCH] Update README.md with readme-generator-for-helm --- helm/ingress-controller/README.md | 48 +++++++++++++++---------------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/helm/ingress-controller/README.md b/helm/ingress-controller/README.md index 1b76e814..717bacdd 100644 --- a/helm/ingress-controller/README.md +++ b/helm/ingress-controller/README.md @@ -45,29 +45,29 @@ To uninstall the chart: ### Controller parameters -| Name | Description | Value | -| ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| `podAnnotations` | Used to inject custom annotations directly into | `{}` | -| `replicaCount` | The number of controllers and agents to run. | `1` | -| `image.registry` | The ngrok ingress controller image registry. | `docker.io` | +| Name | Description | Value | +| ---------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| `podAnnotations` | Used to inject custom annotations directly into | `{}` | +| `replicaCount` | The number of controllers and agents 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. | `latest` | -| `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. | `true` | -| `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 empty to utilize the global network | `""` | -| `serverAddr` | This is the URL of the ngrok server to connect to. You should set this if you are using a custom ingress URL. | `""` | -| `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 | `{}` | +| `image.tag` | The ngrok ingress controller image tag. | `latest` | +| `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. | `true` | +| `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 empty to utilize the global network | `""` | +| `serverAddr` | This is the URL of the ngrok server to connect to. You should set this if you are using a custom ingress URL. | `""` | +| `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 | `{}` |