Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for KIC 3.4.0 #8298

Merged
merged 3 commits into from
Dec 19, 2024
+1,076 −29
Merged

Update docs for KIC 3.4.0 #8298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c933b00
Synchronize auto-generated KIC API reference
team-k8s-bot Dec 19, 2024
58659b6
complete release docs
mlavacca Dec 19, 2024
d717b44
Update app/_data/kong_versions.yml
mlavacca Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion app/_data/kong_versions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,10 +304,13 @@
- release: "3.3.x"
version: "3.3.1"
edition: "kubernetes-ingress-controller"
latest: true
- release: "3.4.x"
version: "3.4.0"
edition: "kubernetes-ingress-controller"
latest: true
mlavacca marked this conversation as resolved.
Show resolved Hide resolved
- release: "3.5.x"
version: "3.5.0"
edition: "kubernetes-ingress-controller"
label: unreleased
- edition: gateway-operator
mlavacca marked this conversation as resolved.
Show resolved Hide resolved
version: 1.0.3
Expand Down
130 changes: 130 additions & 0 deletions app/_src/kubernetes-ingress-controller/reference/cli-arguments-3.4.x.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
---
title: CLI Arguments
---

Learn about the various settings and configurations of the controller can be tweaked
using CLI flags.

## Environment variables

Each flag defined in the table below can also be configured using
an environment variable. The name of the environment variable is `CONTROLLER_`
string followed by the name of flag in uppercase.

For example, `--ingress-class` can be configured using the following
environment variable:

```
CONTROLLER_INGRESS_CLASS=kong-foobar
```

It is recommended that all the configuration is done through environment variables
and not CLI flags.

<!-- vale off -->

<!-- This document is generated by KIC's 'generate.docs' make target, DO NOT EDIT -->

## Flags

| Flag | Type | Description | Default |
| ---- | ---- | ----------- | ------- |
| `--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. | `off` |
| `--anonymous-reports` | `bool` | Send anonymized usage data to help improve Kong. | `true` |
| `--apiserver-burst` | `int` | The Kubernetes API RateLimiter maximum burst queries per second. | `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. | `100` |
| `--cache-sync-timeout` | `duration` | The time limit set to wait for syncing controllers' caches. Set to 0 to use default from controller-runtime. | `2m0s` |
| `--cluster-domain` | `string` | The cluster domain. This is used e.g. in generating addresses for upstream services. | |
| `--configmap-label-selector` | `string` | Limits the configmaps ingested to those having this label set to "true". | `konghq.com/configmap` |
| `--dump-config` | `bool` | Enable config dumps via web interface host:10256/debug/config. | `false` |
| `--dump-sensitive-config` | `bool` | Include credentials and TLS secrets in configs exposed with --dump-config flag. | `false` |
| `--election-id` | `string` | Election id to use for status update. | `5b374a9e.konghq.com` |
| `--election-namespace` | `string` | Leader election namespace to use when running outside a cluster. | |
| `--emit-kubernetes-events` | `bool` | Emit Kubernetes events for successful configuration applies, translation failures and configuration apply failures on managed objects. | `true` |
| `--enable-controller-gwapi-gateway` | `bool` | Enable the Gateway API Gateway controller. | `true` |
| `--enable-controller-gwapi-grpcroute` | `bool` | Enable the Gateway API GRPCRoute controller. | `true` |
| `--enable-controller-gwapi-httproute` | `bool` | Enable the Gateway API HTTPRoute controller. | `true` |
| `--enable-controller-gwapi-reference-grant` | `bool` | Enable the Gateway API ReferenceGrant controller. | `true` |
| `--enable-controller-ingress-class-networkingv1` | `bool` | Enable the networking.k8s.io/v1 IngressClass controller. | `true` |
| `--enable-controller-ingress-class-parameters` | `bool` | Enable the IngressClassParameters controller. | `true` |
| `--enable-controller-ingress-networkingv1` | `bool` | Enable the networking.k8s.io/v1 Ingress controller. | `true` |
| `--enable-controller-kong-custom-entity` | `bool` | Enable the KongCustomEntity controller. | `true` |
| `--enable-controller-kong-license` | `bool` | Enable the KongLicense controller. | `true` |
| `--enable-controller-kong-service-facade` | `bool` | Enable the KongServiceFacade controller. | `true` |
| `--enable-controller-kong-upstream-policy` | `bool` | Enable the KongUpstreamPolicy controller. | `true` |
| `--enable-controller-kong-vault` | `bool` | Enable the KongVault controller. | `true` |
| `--enable-controller-kongclusterplugin` | `bool` | Enable the KongClusterPlugin controller. | `true` |
| `--enable-controller-kongconsumer` | `bool` | Enable the KongConsumer controller. | `true` |
| `--enable-controller-kongingress` | `bool` | Enable the KongIngress controller. | `true` |
| `--enable-controller-kongplugin` | `bool` | Enable the KongPlugin controller. | `true` |
| `--enable-controller-service` | `bool` | Enable the Service controller. | `true` |
| `--enable-controller-tcpingress` | `bool` | Enable the TCPIngress controller. | `true` |
| `--enable-controller-udpingress` | `bool` | Enable the UDPIngress controller. | `true` |
| `--enable-reverse-sync` | `bool` | Send configuration to Kong even if the configuration checksum has not changed since previous update. | `false` |
| `--feature-gates` | `list of string=bool` | 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. | `konghq.com/kic-gateway-controller` |
| `--gateway-discovery-dns-strategy` | `dns-strategy` | DNS strategy to use when creating Gateway's Admin API addresses. One of: ip, service, pod. | `"ip"` |
| `--gateway-discovery-readiness-check-interval` | `duration` | Interval of readiness checks on gateway admin API clients for discovery. | `10s` |
| `--gateway-discovery-readiness-check-timeout` | `duration` | Timeout of readiness checks on gateway admin clients. | `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. | `:10254` |
| `--ingress-class` | `string` | Name of the ingress class to route through this controller. | `kong` |
| `--init-cache-sync-duration` | `duration` | The initial delay to wait for Kubernetes object caches to be synced before the initial configuration. | `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. | `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. | `[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. | `60` |
| `--kong-admin-init-retry-delay` | `duration` | The time delay between every attempt (on controller startup) to connect to the Kong Admin API. | `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. | `[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` | `bool` | Disable verification of TLS certificate of Kong's Admin endpoint. | `false` |
| `--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". | `[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. | `https://us.kic.api.konghq.com` |
| `--konnect-control-plane-id` | `string` | An ID of a control plane that is to be synchronized with data plane configuration. | |
| `--konnect-disable-consumers-sync` | `bool` | Disable synchronization of consumers with Konnect. | `false` |
| `--konnect-initial-license-polling-period` | `duration` | Polling period to be used before the first license is retrieved. | `1m0s` |
| `--konnect-license-polling-period` | `duration` | Polling period to be used after the first license is retrieved. | `12h0m0s` |
| `--konnect-licensing-enabled` | `bool` | Retrieve licenses from Konnect if available. Overrides licenses provided via the environment. | `false` |
| `--konnect-refresh-node-period` | `duration` | Period of uploading status of KIC and controlled Kong instances. | `1m0s` |
| `--konnect-sync-enabled` | `bool` | Enable synchronization of data plane configuration with a Konnect control plane. | `false` |
| `--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. | `30s` |
| `--kubeconfig` | `string` | Path to the kubeconfig file. | |
| `--log-format` | `string` | Format of logs of the controller. Allowed values are text and json. | `text` |
| `--log-level` | `string` | Level of logging for the controller. Allowed values are trace, debug, info, and error. | `info` |
| `--metrics-bind-address` | `string` | The address the metric endpoint binds to. | `:10255` |
| `--profiling` | `bool` | Enable profiling via web interface host:10256/debug/pprof/. | `false` |
| `--proxy-sync-seconds` | `float` | Define the rate (in seconds) in which configuration updates will be applied to the Kong Admin API. | `3` |
| `--proxy-timeout-seconds` | `float` | Sets the timeout (in seconds) for all requests to Kong's Admin API. | `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` | `bool` | Disable syncing CA certificate syncing (for use with multi-workspace environments). | `false` |
| `--sync-period` | `duration` | Determine the minimum frequency at which watched resources are reconciled. Set to 0 to use default from controller-runtime. | `10h0m0s` |
| `--term-delay` | `duration` | The time delay to sleep before SIGTERM or SIGINT will shut down the ingress controller. | `0s` |
| `--update-status` | `bool` | Indicates if the ingress controller should update the status of resources (e.g. IP/Hostname for v1.Ingress, etc.). | `true` |
| `--update-status-queue-buffer-size` | `int` | Buffer size of the underlying channels used to update the status of resources. | `8192` |
| `--use-last-valid-config-for-fallback` | `bool` | 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. | `false` |
| `--watch-namespace` | `strings` | Namespace(s) in comma-separated format (or specify this flag multiple times) to watch for Kubernetes resources. Defaults to all namespaces. | `[]` |

<!-- vale on -->
Loading
Loading