helm/infrastructure/subcharts/kong/example-values/README.md

   1 # Example values.yaml configurations
   2
   3 The YAML files in this directory provide basic example configurations for
   4 common Kong deployment scenarios on Kubernetes.
   5
   6 * [minimal-kong-controller.yaml](minimal-kong-controller.yaml) installs Kong
   7   open source with the ingress controller in DB-less mode.
   8
   9 * [minimal-kong-standalone.yaml](minimal-kong-standalone.yaml) installs Kong
  10   open source and Postgres with no controller.
  11
  12 * [minimal-kong-enterprise-dbless.yaml](minimal-kong-enterprise-dbless.yaml)
  13   installs Kong for Kubernetes with Kong Enterprise with the ingress controller
  14   in DB-less mode.
  15
  16 * [minimal-k4k8s-with-kong-enterprise.yaml](minimal-k4k8s-with-kong-enterprise.yaml)
  17   installs Kong for Kubernetes with Kong Enterprise with the ingress controller
  18   and PostgreSQL. It does not enable Enterprise features other than Kong
  19   Manager, and does not expose it or the Admin API via a TLS-secured ingress.
  20
  21 * [full-k4k8s-with-kong-enterprise.yaml](full-k4k8s-with-kong-enterprise.yaml)
  22   installs Kong for Kubernetes with Kong Enterprise with the ingress controller
  23   in PostgreSQL. It enables all Enterprise services.
  24
  25 * [minimal-kong-hybrid-control.yaml](minimal-kong-hybrid-control.yaml) and
  26   [minimal-kong-hybrid-data.yaml](minimal-kong-hybrid-data.yaml) install
  27   separate releases for hybrid mode control and data plane nodes, using the
  28   built-in PostgreSQL chart on the control plane release. They require some
  29   pre-work to [create certificates](https://github.com/Kong/charts/blob/main/charts/kong/README.md#certificates)
  30   and configure the control plane location. See comments in the file headers
  31   for additional details.
  32
  33   Note that you should install the control plane release first if possible:
  34   data planes must be able to talk with a control plane node before they can
  35   come online. Starting control planes first is not strictly required (data
  36   plane nodes will retry their connection for a while before Kubernetes
  37   restarts them, so starting control planes second, but around the same time
  38   will usually work), but is the smoothest option.
  39
  40 * [minimal-kong-enterprise-hybrid-control.yaml](minimal-kong-enterprise-hybrid-control.yaml) and
  41   [minimal-kong-enterprise-hybrid-data.yaml](minimal-kong-enterprise-hybrid-data.yaml) install
  42   separate releases of Kong Enterprise for hybrid mode control and data plane nodes, using the
  43   built-in PostgreSQL chart on the control plane release. They require some
  44   pre-work to [create certificates](https://github.com/Kong/charts/blob/main/charts/kong/README.md#certificates)
  45   and configure the control plane location. See comments in the file headers
  46   for additional details.
  47
  48   Note that you should install the control plane release first if possible:
  49   data planes must be able to talk with a control plane node before they can
  50   come online. Starting control planes first is not strictly required (data
  51   plane nodes will retry their connection for a while before Kubernetes
  52   restarts them, so starting control planes second, but around the same time
  53   will usually work), but is the smoothest option.
  54
  55 * [minimal-kong-gd-controller.yaml](minimal-kong-gd-controller.yaml) and
  56   [minimal-kong-gd-gateway.yaml](minimal-kong-gd-gateway.yaml) install a
  57   single controller and cluster of gateway instances. The controller release
  58   configuration must specify the names of the gateway proxy and admin
  59   Services. The examples use `gw` as the gateway release name. If you wish to
  60   use another name, set the controller configuration to match. For example, if
  61   you use `hydrogen` as your gateway release name, set
  62   `proxy.nameOverride=hydrogen-kong-proxy` and
  63   `ingressController.adminApiService.name=hydrogen-kong-admin`.
  64
  65 * [minimal-kong-gd-controller-konnect.yaml](minimal-kong-gd-controller-konnect.yaml) and
  66   [minimal-kong-gd-gateway.yaml](minimal-kong-gd-gateway.yaml) install a single Ingress
  67   Controller with Kong's Konnect sync feature enabled and a cluster of gateway instances.
  68   In order to make it work, `ingressController.konnect.runtimeGroupID` has to be
  69   supplied and a `konnect-client-tls` secret has to be created upfront.
  70
  71 All Enterprise examples require some level of additional user configuration to
  72 install properly. Read the comments at the top of each file for instructions.