Usage:
[flags]
[command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
version Show JSON version information
Flags:
--admission-webhook-cert string Admission server PEM certificate value. Mutually exclusive with --admission-webhook-cert-file.
--admission-webhook-cert-file string Admission server PEM certificate file path. If both this and the cert value is unset, defaults to /admission-webhook/tls.crt. Mutually exclusive with --admission-webhook-cert.
--admission-webhook-key string Admission server PEM private key value. Mutually exclusive with --admission-webhook-key-file.
--admission-webhook-key-file string Admission server PEM private key file path. If both this and the key value is unset, defaults to /admission-webhook/tls.key. Mutually exclusive with --admission-webhook-key.
--admission-webhook-listen string The address to start admission controller on (ip:port). Setting it to 'off' disables the admission controller. (default "off")
--anonymous-reports Send anonymized usage data to help improve Kong. (default true)
--apiserver-burst int The Kubernetes API RateLimiter maximum burst queries per second. (default 300)
--apiserver-host string The Kubernetes API server URL. If not set, the controller will use cluster config discovery.
--apiserver-qps int The Kubernetes API RateLimiter maximum queries per second. (default 100)
--cache-sync-timeout duration The time limit set to wait for syncing controllers' caches. Set to 0 to use default from controller-runtime. (default 2m0s)
--cluster-domain string The cluster domain. This is used e.g. in generating addresses for upstream services.
--combined-services-from-different-httproutes Combine rules from different HTTPRoutes that are sharing the same combination of backends to one Kong service to reduce total number of Kong services.
--configmap-label-selector string Limits the configmaps ingested to those having this label set to "true". (default "konghq.com/configmap")
--dump-config Enable config dumps via web interface host:10256/debug/config.
--dump-sensitive-config Include credentials and TLS secrets in configs exposed with --dump-config flag.
--election-id string Election id to use for status update. (default "5b374a9e.konghq.com")
--election-namespace string Leader election namespace to use when running outside a cluster.
--emit-kubernetes-events Emit Kubernetes events for successful configuration applies, translation failures and configuration apply failures on managed objects. (default true)
--enable-controller-gwapi-gateway Enable the Gateway API Gateway controller. (default true)
--enable-controller-gwapi-grpcroute Enable the Gateway API GRPCRoute controller. (default true)
--enable-controller-gwapi-httproute Enable the Gateway API HTTPRoute controller. (default true)
--enable-controller-gwapi-reference-grant Enable the Gateway API ReferenceGrant controller. (default true)
--enable-controller-ingress-class-networkingv1 Enable the networking.k8s.io/v1 IngressClass controller. (default true)
--enable-controller-ingress-class-parameters Enable the IngressClassParameters controller. (default true)
--enable-controller-ingress-networkingv1 Enable the networking.k8s.io/v1 Ingress controller. (default true)
--enable-controller-kong-custom-entity Enable the KongCustomEntity controller. (default true)
--enable-controller-kong-license Enable the KongLicense controller. (default true)
--enable-controller-kong-service-facade Enable the KongServiceFacade controller. (default true)
--enable-controller-kong-upstream-policy Enable the KongUpstreamPolicy controller. (default true)
--enable-controller-kong-vault Enable the KongVault controller. (default true)
--enable-controller-kongclusterplugin Enable the KongClusterPlugin controller. (default true)
--enable-controller-kongconsumer Enable the KongConsumer controller. (default true)
--enable-controller-kongingress Enable the KongIngress controller. (default true)
--enable-controller-kongplugin Enable the KongPlugin controller. (default true)
--enable-controller-service Enable the Service controller. (default true)
--enable-controller-tcpingress Enable the TCPIngress controller. (default true)
--enable-controller-udpingress Enable the UDPIngress controller. (default true)
--enable-drain-support Include terminating endpoints in Kong upstreams with weight=0 for graceful connection draining.
--enable-reverse-sync Send configuration to Kong even if the configuration checksum has not changed since previous update.
--feature-gates mapStringBool A set of comma separated key=value pairs that describe feature gates for alpha/beta/experimental features. See the Feature Gates documentation for information and available options: https://github.com/Kong/kubernetes-ingress-controller/blob/main/FEATURE_GATES.md.
--gateway-api-controller-name string The controller name to match on Gateway API resources. (default "konghq.com/kic-gateway-controller")
--gateway-discovery-readiness-check-interval duration Interval of readiness checks on gateway admin API clients for discovery. (default 10s)
--gateway-discovery-readiness-check-timeout duration Timeout of readiness checks on gateway admin clients. (default 5s)
--gateway-to-reconcile namespaced-name Gateway namespaced name in "namespace/name" format. Makes KIC reconcile only the specified Gateway.
--health-probe-bind-address string The address the probe endpoint binds to. (default ":10254")
-h, --help help for this command
--ingress-class string Name of the ingress class to route through this controller. (default "kong")
--init-cache-sync-duration duration The initial delay to wait for Kubernetes object caches to be synced before the initial configuration. (default 5s)
--kong-admin-ca-cert string PEM-encoded CA certificate to verify Kong's Admin TLS certificate. Mutually exclusive with --kong-admin-ca-cert-file.
--kong-admin-ca-cert-file string Path to PEM-encoded CA certificate file to verify Kong's Admin TLS certificate. Mutually exclusive with --kong-admin-ca-cert.
--kong-admin-concurrency int Max number of concurrent requests sent to Kong's Admin API. (default 10)
--kong-admin-filter-tag strings Tag(s) in comma-separated format (or specify this flag multiple times). They are used to manage and filter entities in Kong. This setting will be silently ignored if the Kong instance has no tags support. (default [managed-by-ingress-controller])
--kong-admin-header strings Header(s) (key:value) in comma-separated format (or specify this flag multiple times) to add to every Admin API call.
--kong-admin-init-retries uint Number of attempts that will be made initially on controller startup to connect to the Kong Admin API. (default 60)
--kong-admin-init-retry-delay duration The time delay between every attempt (on controller startup) to connect to the Kong Admin API. (default 1s)
--kong-admin-svc namespaced-name Kong Admin API Service namespaced name in "namespace/name" format, to use for Kong Gateway service discovery.
--kong-admin-svc-port-names strings Name(s) of ports on Kong Admin API service in comma-separated format (or specify this flag multiple times) to take into account when doing gateway discovery. (default [admin-tls,kong-admin-tls])
--kong-admin-tls-client-cert string Mutual TLS (mTLS) client certificate for authentication. Mutually exclusive with --kong-admin-tls-client-cert-file.
--kong-admin-tls-client-cert-file string Mutual TLS (mTLS) client certificate file for authentication. Mutually exclusive with --kong-admin-tls-client-cert.
--kong-admin-tls-client-key string Mutual TLS (mTLS) client key for authentication. Mutually exclusive with --kong-admin-tls-client-key-file.
--kong-admin-tls-client-key-file string Mutual TLS (mTLS) client key file for authentication. Mutually exclusive with --kong-admin-tls-client-key.
--kong-admin-tls-server-name string SNI name to use to verify the certificate presented by Kong in TLS.
--kong-admin-tls-skip-verify Disable verification of TLS certificate of Kong's Admin endpoint.
--kong-admin-token string The Kong Enterprise RBAC token used by the controller. Mutually exclusive with --kong-admin-token-file.
--kong-admin-token-file string Path to the Kong Enterprise RBAC token file used by the controller. Mutually exclusive with --kong-admin-token.
--kong-admin-url strings Kong Admin URL(s) in comma-separated format (or specify this flag multiple times) to connect to in the format "protocol://address:port". (default [http://localhost:8001])
--kong-workspace string Kong Enterprise workspace to configure. Leave this empty if not using Kong workspaces.
--konnect-address string Base address of Konnect API. (default "https://us.kic.api.konghq.com")
--konnect-config-sync-concurrency int Max number of concurrent requests sent to Konnect when syncing configuration. (default 4)
--konnect-control-plane-id string An ID of a control plane that is to be synchronized with data plane configuration.
--konnect-disable-consumers-sync Disable synchronization of consumers with Konnect.
--konnect-initial-license-polling-period duration Polling period to be used before the first license is retrieved. (default 1m0s)
--konnect-license-polling-period duration Polling period to be used after the first license is retrieved. (default 12h0m0s)
--konnect-license-storage-enabled Store licenses fetched from Konnect to Secrets locally to use them later when connection to Konnect is broken. Only effective when --konnect-licensing-enabled is true. (default true)
--konnect-licensing-enabled Retrieve licenses from Konnect if available. Overrides licenses provided via the environment.
--konnect-refresh-node-period duration Period of uploading status of KIC and controlled Kong instances. (default 1m0s)
--konnect-sync-enabled Enable synchronization of data plane configuration with a Konnect control plane.
--konnect-tls-client-cert string Konnect TLS client certificate.
--konnect-tls-client-cert-file string Konnect TLS client certificate file path.
--konnect-tls-client-key string Konnect TLS client key.
--konnect-tls-client-key-file string Konnect TLS client key file path.
--konnect-upload-config-period duration Period of uploading Kong configuration. (default 30s)
--kubeconfig string Path to the kubeconfig file.
--log-format string Format of logs of the controller. Allowed values are text and json. (default "text")
--log-level string Level of logging for the controller. Allowed values are trace, debug, info, and error. (default "info")
--metrics-access-filter config.MetricsAccessFilter Specifies the filter access function to be used for accessing the metrics endpoint (possible values: off, rbac). (default "off")
--metrics-bind-address string The address the metric endpoint binds to. (default ":10255")
--profiling Enable profiling via web interface host:10256/debug/pprof/.
--proxy-sync-seconds float32 Define the rate (in seconds) in which configuration updates will be applied to the Kong Admin API. (default 3)
--proxy-timeout-seconds float32 Sets the timeout (in seconds) for all requests to Kong's Admin API. (default 30)
--publish-service namespaced-name Service fronting Ingress resources in "namespace/name" format. The controller will update Ingress status information with this Service's endpoints.
--publish-service-udp namespaced-name Service fronting UDP routing resources in "namespace/name" format. The controller will update UDP route status information with this Service's endpoints. If omitted, the same Service will be used for both TCP and UDP routes.
--publish-status-address strings Addresses in comma-separated format (or specify this flag multiple times), for use in lieu of "publish-service" when that Service lacks useful address information (for example, in bare-metal environments).
--publish-status-address-udp strings Addresses in comma-separated format (or specify this flag multiple times), for use in lieu of "publish-service-udp" when that Service lacks useful address information (for example, in bare-metal environments).
--secret-label-selector string Limits the secrets ingested to those having this label set to "true". If not specified, all secrets are ingested.
--skip-ca-certificates Disable syncing CA certificate syncing (for use with multi-workspace environments).
--sync-period duration Determine the minimum frequency at which watched resources are reconciled. Set to 0 to use default from controller-runtime. (default 10h0m0s)
--term-delay duration The time delay to sleep before SIGTERM or SIGINT will shut down the ingress controller.
--update-status Indicates if the ingress controller should update the status of resources (e.g. IP/Hostname for v1.Ingress, etc.). (default true)
--update-status-queue-buffer-size int Buffer size of the underlying channels used to update the status of resources. (default 8192)
--use-last-valid-config-for-fallback When recovering from config push failures, use the last valid configuration cache to backfill broken objects. It can only be used with the FallbackConfiguration feature gate enabled.
--watch-namespace strings Namespace(s) in comma-separated format (or specify this flag multiple times) to watch for Kubernetes resources. Defaults to all namespaces.
Use " [command] --help" for more information about a command.
Options (102)
| Option | Description | Source |
|---|---|---|
--admission-webhook-cert string | Admission server PEM certificate value. | help |
--admission-webhook-cert-file string | Admission server PEM certificate file path. | help |
--admission-webhook-key string | Admission server PEM private key value. | help |
--admission-webhook-key-file string | Admission server PEM private key file path. | help |
--admission-webhook-listen string | The address to start admission controller on (ip:port). | help |
--anonymous-reports | Send anonymized usage data to help improve Kong. | help |
--apiserver-burst int | The Kubernetes API RateLimiter maximum burst queries per second. | help |
--apiserver-host string | The Kubernetes API server URL. | help |
--apiserver-qps int | The Kubernetes API RateLimiter maximum queries per second. | help |
--cache-sync-timeout duration | The time limit set to wait for syncing controllers' caches. | help |
--cluster-domain string | The cluster domain. | help |
--combined-services-from-different-httproutes | Combine rules from different HTTPRoutes that are sharing the same combination of backends to one Kong service to reduce total number of Kong services. | help |
--configmap-label-selector string | Limits the configmaps ingested to those having this label set to "true". | help |
--dump-config | Enable config dumps via web interface host:10256/debug/config. | help |
--dump-sensitive-config | Include credentials and TLS secrets in configs exposed with --dump-config flag. | help |
--election-id string | Election id to use for status update. | help |
--election-namespace string | Leader election namespace to use when running outside a cluster. | help |
--emit-kubernetes-events | Emit Kubernetes events for successful configuration applies, translation failures and configuration apply failures on managed objects. | help |
--enable-controller-gwapi-gateway | Enable the Gateway API Gateway controller. | help |
--enable-controller-gwapi-grpcroute | Enable the Gateway API GRPCRoute controller. | help |
--enable-controller-gwapi-httproute | Enable the Gateway API HTTPRoute controller. | help |
--enable-controller-gwapi-reference-grant | Enable the Gateway API ReferenceGrant controller. | help |
--enable-controller-ingress-class-networkingv1 | Enable the networking.k8s.io/v1 IngressClass controller. | help |
--enable-controller-ingress-class-parameters | Enable the IngressClassParameters controller. | help |
--enable-controller-ingress-networkingv1 | Enable the networking.k8s.io/v1 Ingress controller. | help |
--enable-controller-kong-custom-entity | Enable the KongCustomEntity controller. | help |
--enable-controller-kong-license | Enable the KongLicense controller. | help |
--enable-controller-kong-service-facade | Enable the KongServiceFacade controller. | help |
--enable-controller-kong-upstream-policy | Enable the KongUpstreamPolicy controller. | help |
--enable-controller-kong-vault | Enable the KongVault controller. | help |
--enable-controller-kongclusterplugin | Enable the KongClusterPlugin controller. | help |
--enable-controller-kongconsumer | Enable the KongConsumer controller. | help |
--enable-controller-kongingress | Enable the KongIngress controller. | help |
--enable-controller-kongplugin | Enable the KongPlugin controller. | help |
--enable-controller-service | Enable the Service controller. | help |
--enable-controller-tcpingress | Enable the TCPIngress controller. | help |
--enable-controller-udpingress | Enable the UDPIngress controller. | help |
--enable-drain-support | Include terminating endpoints in Kong upstreams with weight=0 for graceful connection draining. | help |
--enable-reverse-sync | Send configuration to Kong even if the configuration checksum has not changed since previous update. | help |
--feature-gates mapStringBool | A set of comma separated key=value pairs that describe feature gates for alpha/beta/experimental features. | help |
--gateway-api-controller-name string | The controller name to match on Gateway API resources. | help |
--gateway-discovery-readiness-check-interval duration | Interval of readiness checks on gateway admin API clients for discovery. | help |
--gateway-discovery-readiness-check-timeout duration | Timeout of readiness checks on gateway admin clients. | help |
--gateway-to-reconcile namespaced-name | Gateway namespaced name in "namespace/name" format. | help |
--health-probe-bind-address string | The address the probe endpoint binds to. | help |
-h, --help | help for this command | help |
--ingress-class string | Name of the ingress class to route through this controller. | help |
--init-cache-sync-duration duration | The initial delay to wait for Kubernetes object caches to be synced before the initial configuration. | help |
--kong-admin-ca-cert string | PEM-encoded CA certificate to verify Kong's Admin TLS certificate. | help |
--kong-admin-ca-cert-file string | Path to PEM-encoded CA certificate file to verify Kong's Admin TLS certificate. | help |
--kong-admin-concurrency int | Max number of concurrent requests sent to Kong's Admin API. | help |
--kong-admin-filter-tag strings | Tag(s) in comma-separated format (or specify this flag multiple times). | help |
--kong-admin-header strings | Header(s) (key:value) in comma-separated format (or specify this flag multiple times) to add to every Admin API call. | help |
--kong-admin-init-retries uint | Number of attempts that will be made initially on controller startup to connect to the Kong Admin API. | help |
--kong-admin-init-retry-delay duration | The time delay between every attempt (on controller startup) to connect to the Kong Admin API. | help |
--kong-admin-svc namespaced-name | Kong Admin API Service namespaced name in "namespace/name" format, to use for Kong Gateway service discovery. | help |
--kong-admin-svc-port-names strings | Name(s) of ports on Kong Admin API service in comma-separated format (or specify this flag multiple times) to take into account when doing gateway discovery. | help |
--kong-admin-tls-client-cert string | Mutual TLS (mTLS) client certificate for authentication. | help |
--kong-admin-tls-client-cert-file string | Mutual TLS (mTLS) client certificate file for authentication. | help |
--kong-admin-tls-client-key string | Mutual TLS (mTLS) client key for authentication. | help |
--kong-admin-tls-client-key-file string | Mutual TLS (mTLS) client key file for authentication. | help |
--kong-admin-tls-server-name string | SNI name to use to verify the certificate presented by Kong in TLS. | help |
--kong-admin-tls-skip-verify | Disable verification of TLS certificate of Kong's Admin endpoint. | help |
--kong-admin-token string | The Kong Enterprise RBAC token used by the controller. | help |
--kong-admin-token-file string | Path to the Kong Enterprise RBAC token file used by the controller. | help |
--kong-admin-url strings | Kong Admin URL(s) in comma-separated format (or specify this flag multiple times) to connect to in the format "protocol://address:port". | help |
--kong-workspace string | Kong Enterprise workspace to configure. | help |
--konnect-address string | Base address of Konnect API. | help |
--konnect-config-sync-concurrency int | Max number of concurrent requests sent to Konnect when syncing configuration. | help |
--konnect-control-plane-id string | An ID of a control plane that is to be synchronized with data plane configuration. | help |
--konnect-disable-consumers-sync | Disable synchronization of consumers with Konnect. | help |
--konnect-initial-license-polling-period duration | Polling period to be used before the first license is retrieved. | help |
--konnect-license-polling-period duration | Polling period to be used after the first license is retrieved. | help |
--konnect-license-storage-enabled | Store licenses fetched from Konnect to Secrets locally to use them later when connection to Konnect is broken. | help |
--konnect-licensing-enabled | Retrieve licenses from Konnect if available. | help |
--konnect-refresh-node-period duration | Period of uploading status of KIC and controlled Kong instances. | help |
--konnect-sync-enabled | Enable synchronization of data plane configuration with a Konnect control plane. | help |
--konnect-tls-client-cert string | Konnect TLS client certificate. | help |
--konnect-tls-client-cert-file string | Konnect TLS client certificate file path. | help |
--konnect-tls-client-key string | Konnect TLS client key. | help |
--konnect-tls-client-key-file string | Konnect TLS client key file path. | help |
--konnect-upload-config-period duration | Period of uploading Kong configuration. | help |
--kubeconfig string | Path to the kubeconfig file. | help |
--log-format string | Format of logs of the controller. | help |
--log-level string | Level of logging for the controller. | help |
--metrics-access-filter config.MetricsAccessFilter | Specifies the filter access function to be used for accessing the metrics endpoint (possible values: off, rbac). | help |
--metrics-bind-address string | The address the metric endpoint binds to. | help |
--profiling | Enable profiling via web interface host:10256/debug/pprof/. | help |
--proxy-sync-seconds float32 | Define the rate (in seconds) in which configuration updates will be applied to the Kong Admin API. | help |
--proxy-timeout-seconds float32 | Sets the timeout (in seconds) for all requests to Kong's Admin API. | help |
--publish-service namespaced-name | Service fronting Ingress resources in "namespace/name" format. | help |
--publish-service-udp namespaced-name | Service fronting UDP routing resources in "namespace/name" format. | help |
--publish-status-address strings | Addresses in comma-separated format (or specify this flag multiple times), for use in lieu of "publish-service" when that Service lacks useful address information (for example, in bare-metal… | help |
--publish-status-address-udp strings | Addresses in comma-separated format (or specify this flag multiple times), for use in lieu of "publish-service-udp" when that Service lacks useful address information (for example, in bare-metal… | help |
--secret-label-selector string | Limits the secrets ingested to those having this label set to "true". | help |
--skip-ca-certificates | Disable syncing CA certificate syncing (for use with multi-workspace environments). | help |
--sync-period duration | Determine the minimum frequency at which watched resources are reconciled. | help |
--term-delay duration | The time delay to sleep before SIGTERM or SIGINT will shut down the ingress controller. | help |
--update-status | Indicates if the ingress controller should update the status of resources (e.g. IP/Hostname for v1.Ingress, etc.). | help |
--update-status-queue-buffer-size int | Buffer size of the underlying channels used to update the status of resources. | help |
--use-last-valid-config-for-fallback | When recovering from config push failures, use the last valid configuration cache to backfill broken objects. | help |
--watch-namespace strings | Namespace(s) in comma-separated format (or specify this flag multiple times) to watch for Kubernetes resources. | help |