bitnamicharts/kong

Bitnami Kong 软件包

Kong 是一个开源微服务API网关和平台，旨在管理高可用性、容错和分布式系统的微服务请求。

Kong 概述

商标声明：本软件列表由Bitnami打包。产品中提及的相关商标归各自公司所有，使用这些商标并不意味着任何关联或认可。

快速入门

console
helm install my-release oci://registry-1.docker.io/bitnamicharts/kong

希望在生产环境中使用Kong？请尝试VMware Tanzu Application Catalog，这是Bitnami目录的商业版本。

⚠️ 重要通知：Bitnami目录即将发生的变化

自2025年8月28日起，Bitnami将升级其公共目录，在新的Bitnami Secure Images计划下提供精选的强化、安全聚焦镜像集。作为此过渡的一部分：

• 首次向社区用户提供流行容器镜像的安全优化版本访问权限。
• Bitnami将开始在其免费层级中弃用对非强化、基于Debian的软件镜像的支持，并将逐步从公共目录中移除非最新标签。因此，社区用户将只能访问数量减少的强化镜像，这些镜像仅以“latest”标签发布，适用于开发目的。
• 从8月28日开始，在两周内，所有现有容器镜像（包括旧版本或特定版本标签，如2.50.0、10.6）将从公共目录（docker.io/bitnami）迁移到“Bitnami Legacy”仓库（docker.io/bitnamilegacy），且不再接收更新。
• 对于生产工作负载和长期支持，建议用户采用Bitnami Secure Images，包括强化容器、更小的***面、CVE透明度（通过VEX/KEV）、SBOM以及企业支持。

这些变化旨在通过推广软件供应链完整性和最新部署的最佳实践，提高所有Bitnami用户的安全态势。更多详情，请访问https://github.com/bitnami/containers/issues/83267%E3%80%82

简介

本Helm图表使用Helm包管理器在Kubernetes集群上引导https://github.com/bitnami/containers/tree/main/bitnami/kong%E9%83%A8%E7%BD%B2%E3%80%82%E5%AE%83%E8%BF%98%E5%8C%85%E5%90%ABhttps://github.com/bitnami/containers/tree/main/bitnami/kong-ingress-controller%E5%AE%B9%E5%99%A8%EF%BC%8C%E7%94%A8%E4%BA%8E%E9%80%9A%E8%BF%87Kong%E7%AE%A1%E7%90%86Ingress%E8%B5%84%E6%BA%90%E3%80%82

Kong核心之外的额外功能通过插件扩展。Kong构建在NGINX等可靠技术之上，并提供易于使用的RESTful API来操作和配置系统。

先决条件

• Kubernetes 1.23+
• Helm 3.8.0+
• 底层基础设施支持PV供应器

安装图表

要使用发布名称my-release安装图表：

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/kong

注意：您需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm图表仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

这些命令使用默认配置在Kubernetes集群上部署Kong。参数部分列出了可在安装过程中配置的参数。

提示：使用helm list列出所有发布。

配置和安装详情

资源请求和限制

Bitnami图表允许为图表部署内的所有容器设置资源请求和限制。这些配置位于resources值中（参见参数表）。为生产工作负载设置请求至关重要，且应根据具体用例进行调整。

为简化此过程，图表包含resourcesPreset值，可根据不同预设自动设置resources部分。有关这些预设，请查看https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15%E3%80%82%E4%BD%86%E5%9C%A8%E7%94%9F%E4%BA%A7%E5%B7%A5%E4%BD%9C%E8%B4%9F%E8%BD%BD%E4%B8%AD%EF%BC%8C%E4%B8%8D%E5%BB%BA%E8%AE%AE%E4%BD%BF%E7%94%A8%60resourcesPreset%60%EF%BC%8C%E5%9B%A0%E4%B8%BA%E5%AE%83%E5%8F%AF%E8%83%BD%E6%97%A0%E6%B3%95%E5%AE%8C%E5%85%A8%E9%80%82%E5%BA%94%E6%82%A8%E7%9A%84%E7%89%B9%E5%AE%9A%E9%9C%80%E6%B1%82%E3%80%82%E6%9C%89%E5%85%B3%E5%AE%B9%E5%99%A8%E8%B5%84%E6%BA%90%E7%AE%A1%E7%90%86%E7%9A%84%E6%9B%B4%E5%A4%9A%E4%BF%A1%E6%81%AF%EF%BC%8C%E8%AF%B7%E5%8F%82%E9%98%85Kubernetes%E5%AE%98%E6%96%B9%E6%96%87%E6%A1%A3%E3%80%82

滚动标签与不可变标签

强烈建议在生产环境中使用不可变标签。这可确保如果相同标签更新为不同镜像时，部署不会自动更改。

如果主容器有新版本、重大更改或严重漏洞，Bitnami将发布新图表以更新其容器。

Prometheus指标

通过将metrics.enabled设置为true，可将此图表与Prometheus集成。这将在所有Pod中启用Kong原生Prometheus端口，并创建metrics服务，可在metrics.service部分下配置。此metrics服务将包含必要的注解，以便被Prometheus自动抓取。

Prometheus要求

要使集成正常工作，必须安装Prometheus或Prometheus Operator。安装https://github.com/bitnami/charts/tree/main/bitnami/prometheus%E6%88%96https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%EF%BC%8C%E5%8F%AF%E8%BD%BB%E6%9D%BE%E5%9C%A8%E9%9B%86%E7%BE%A4%E4%B8%AD%E9%83%A8%E7%BD%B2%E5%8F%AF%E7%94%A8%E7%9A%84Prometheus%E3%80%82

与Prometheus Operator集成

该图表可部署ServiceMonitor对象，以与Prometheus Operator安装集成。为此，需将值metrics.serviceMonitor.enabled设置为true。确保集群中已安装Prometheus OperatorCustomResourceDefinitions，否则将失败并显示以下错误：

text
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"

安装https://github.com/bitnami/charts/tree/main/bitnami/kube-prometheus%E4%BB%A5%E8%8E%B7%E5%8F%96%E5%BF%85%E8%A6%81%E7%9A%84CRD%E5%92%8CPrometheus Operator。

数据库后端

Bitnami Kong图表允许设置两种数据库后端：PostgreSQL或Cassandra。对于每种选项，有两种额外可能性：部署包含数据库安装的子图表，或使用现有数据库。以下列出不同选项（替换下划线之间的占位符）：

• 部署PostgreSQL子图表（默认）

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/kong

注意：您需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm图表仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

• 使用外部PostgreSQL数据库

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/kong \
    --set postgresql.enabled=false \
    --set postgresql.external.host=_HOST_OF_YOUR_POSTGRESQL_INSTALLATION_ \
    --set postgresql.external.password=_PASSWORD_OF_YOUR_POSTGRESQL_INSTALLATION_ \
    --set postgresql.external.user=_USER_OF_YOUR_POSTGRESQL_INSTALLATION_

注意：您需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm图表仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

• 部署Cassandra子图表

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/kong \
    --set database=cassandra \
    --set postgresql.enabled=false \
    --set cassandra.enabled=true

注意：您需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm图表仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

• 使用现有Cassandra安装

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/kong \
    --set database=cassandra \
    --set postgresql.enabled=false \
    --set cassandra.enabled=false \
    --set cassandra.external.hosts[0]=_CONTACT_POINT_0_OF_YOUR_CASSANDRA_CLUSTER_ \
    --set cassandra.external.hosts[1]=_CONTACT_POINT_1_OF_YOUR_CASSANDRA_CLUSTER_ \
    ...
    --set cassandra.external.user=_USER_OF_YOUR_CASSANDRA_INSTALLATION_ \
    --set cassandra.external.password=_PASSWORD_OF_YOUR_CASSANDRA_INSTALLATION_

注意：您需要将占位符REGISTRY_NAME和REPOSITORY_NAME替换为Helm图表仓库和存储库的引用。例如，对于Bitnami，需使用REGISTRY_NAME=registry-1.docker.io和REPOSITORY_NAME=bitnamicharts。

无数据库模式（DB-less）

Kong 1.1新增了无需数据库运行Kong的功能，仅使用内存存储实体：我们称之为无数据库模式（DB-less）。运行Kong无数据库模式时，实体配置通过第二个YAML或JSON格式的配置文件完成，使用声明式配置（参考链接）。

如kong官方Docker安装的步骤4所述，只需添加环境变量KONG_DATABASE=off。

备份和恢复

要在Kubernetes上备份和恢复Helm图表部署，需使用Kubernetes备份/恢复工具Velero备份源部署的持久卷，并将其附加到新部署。有关使用Velero的说明，请参阅本指南。

如何启用无数据库模式

1. 将database值设置为除“postgresql”或“cassandra”之外的任何值。例如database: "off"
2. 使用kong.extraEnvVars值设置KONG_DATABASE环境变量：

yaml
kong.extraEnvVars:
- name: KONG_DATABASE
  value: "off"

边车容器和初始化容器

如果需要在Kong所在的同一Pod中运行额外容器（例如额外的指标或日志导出器），可通过sidecars配置参数实现。只需根据Kubernetes容器规范定义容器。

yaml
sidecars:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

类似地，可使用initContainers参数添加额外的初始化容器。

yaml
initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

添加额外环境变量

如需添加额外环境变量（用于高级操作，如自定义初始化脚本），可使用kong.extraEnvVars属性。

yaml
kong:
  extraEnvVars:
    - name: KONG_LOG_LEVEL
      value: error

或者，可使用包含环境变量的ConfigMap或Secret。为此，使用kong.extraEnvVarsCM或kong.extraEnvVarsSecret值。

Kong Ingress Controller和Kong迁移作业也允许通过ingressController.extraEnvVars、ingressController.extraEnvVarsCM、ingressController.extraEnvVarsSecret、migration.extraEnvVars、migration.extraEnvVarsCM和migration.extraEnvVarsSecret值进行此类配置。

使用自定义初始化脚本

对于高级操作，Bitnami Kong图表允许使用自定义初始化脚本，这些脚本将挂载到/docker-entrypoint.init-db。可使用ConfigMap或Secret（针对敏感数据）挂载这些额外脚本。然后使用kong.initScriptsCM和kong.initScriptsSecret值。

console
elasticsearch.hosts[0]=elasticsearch-host
elasticsearch.port=9200
initScriptsCM=special-scripts
initScriptsSecret=special-scripts-sensitive

部署额外资源

在某些情况下，可能需要部署额外对象，如KongPlugins、KongConsumers等。为此，图表允许使用extraDeploy参数添加其他对象的完整规范。以下示例将在部署时激活插件。

yaml
## 要部署的额外对象（值将作为模板计算）
##
extraDeploy:
  - |
    apiVersion: configuration.konghq.com/v1
    kind: KongPlugin
    metadata:
      name: {{ include "common.names.fullname" . }}-plugin-correlation
      namespace: {{ .Release.Namespace }}
      labels: {{- include "common.labels.standard" ( dict "customLabels" .Values.commonLabels "context" $ ) | nindent 6 }}
    config:
      header_name: my-request-id
    plugin: correlation-id

设置Pod亲和性

此图表允许使用affinity参数设置自定义亲和性。有关Pod亲和性的更多信息，请参阅kubernetes文档。

作为替代方案，可使用https://github.com/bitnami/charts/tree/main/bitnami/common#affinities%E5%9B%BE%E8%A1%A8%E4%B8%AD%E6%8F%90%E4%BE%9B%E7%9A%84Pod%E4%BA%B2%E5%92%8C%E6%80%A7%E3%80%81Pod%E5%8F%8D%E4%BA%B2%E5%92%8C%E6%80%A7%E5%92%8C%E8%8A%82%E7%82%B9%E4%BA%B2%E5%92%8C%E6%80%A7%E9%A2%84%E8%AE%BE%E9%85%8D%E7%BD%AE%E3%80%82%E4%B8%BA%E6%AD%A4%EF%BC%8C%E8%AE%BE%E7%BD%AE%60podAffinityPreset%60%E3%80%81%60podAntiAffinityPreset%60%E6%88%96%60nodeAffinityPreset%60%E5%8F%82%E6%95%B0%E3%80%82

参数

全局参数

通用参数

Kong通用参数