github/deprecated-helm-charts
1
0
Fork 0
mirror of https://github.com/helm/charts.git synced 2026-08-23 22:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

[stable/kong] custom plugins support (#17908)

Browse Source 
* [stable/kong] custom plugins support

- Refactor out volumes and volumeMounts into helpers
- Allow users to easily mount custom plugins via secrets and configmaps
- Custom plugins containing custom DAOs are allowed as well

A guide will be published in near future on how to exactly use this
feature.

In a subsequent PR, we will de-duplicate env and initContainer sections
in the migrations jobs to reduce duplication.

Signed-off-by: Harry Bagdi <harrybagdi@gmail.com>

* automatically populate KONG_PLUGINS

Signed-off-by: Harry Bagdi <harrybagdi@gmail.com>

* fix typo

Signed-off-by: Harry Bagdi <harrybagdi@gmail.com>

* fix typos

Signed-off-by: Harry Bagdi <harrybagdi@gmail.com>
This commit is contained in:
Harry
2019-10-15 11:16:09 -07:00
committed by Kubernetes Prow Robot
parent 8391871341
commit eb2c69b757
8 changed files with 112 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stable/kong/Chart.yaml
+1 -1
View File
@@ -12,5 +12,5 @@ maintainers:
name: kong
sources:
- https://github.com/Kong/kong
version: 0.21.1
version: 0.22.0
appVersion: 1.3
stable/kong/README.md
+1
View File
@@ -101,6 +101,7 @@ and their default values.
| proxy.ingress.annotations | Ingress annotations. See documentation for your ingress controller for details | `{}` |
| updateStrategy | update strategy for deployment | `{}` |
| env | Additional [Kong configurations](https://getkong.org/docs/latest/configuration/) | |
| plugins | Install custom plugins into Kong via ConfigMaps or Secrets | `{}` |
| runMigrations | Run Kong migrations job | `true` |
| readinessProbe | Kong readiness probe | |
| livenessProbe | Kong liveness probe | |
stable/kong/templates/_helpers.tpl
+66
View File
@@ -136,6 +136,68 @@ Create the ingress servicePort value string
{{- end -}}
{{- end -}}
{{- define "kong.volumes" -}}
{{- range .Values.plugins.configMaps }}
- name: kong-plugin-{{ .pluginName }}
configMap:
name: {{ .name }}
{{- end }}
{{- range .Values.plugins.secrets }}
- name: kong-plugin-{{ .pluginName }}
secret:
secretName: {{ .name }}
{{- end }}
- name: custom-nginx-template-volume
configMap:
name: {{ template "kong.fullname" . }}-default-custom-server-blocks
{{- if (and (not .Values.ingressController.enabled) (eq .Values.env.database "off")) }}
- name: kong-custom-dbless-config-volume
configMap:
{{- if .Values.dblessConfig.configMap }}
name: {{ .Values.dblessConfig.configMap }}
{{- else }}
name: {{ template "kong.dblessConfig.fullname" . }}
{{- end }}
{{- end }}
{{- range $secretVolume := .Values.secretVolumes }}
- name: {{ . }}
secret:
secretName: {{ . }}
{{- end }}
{{- end -}}
{{- define "kong.volumeMounts" -}}
- name: custom-nginx-template-volume
mountPath: /kong
{{- if (and (not .Values.ingressController.enabled) (eq .Values.env.database "off")) }}
- name: kong-custom-dbless-config-volume
mountPath: /kong_dbless/
{{- end }}
{{- range .Values.secretVolumes }}
- name: {{ . }}
mountPath: /etc/secrets/{{ . }}
{{- end }}
{{- range .Values.plugins.configMaps }}
- name: kong-plugin-{{ .pluginName }}
mountPath: /opt/kong/plugins/{{ .pluginName }}
{{- end }}
{{- range .Values.plugins.secrets }}
- name: kong-plugin-{{ .pluginName }}
mountPath: /opt/kong/plugins/{{ .pluginName }}
{{- end }}
{{- end -}}
{{- define "kong.plugins" -}}
{{ $myList := list "bundled" }}
{{- range .Values.plugins.configMaps -}}
{{- $myList = append $myList .pluginName -}}
{{- end -}}
{{- range .Values.plugins.secrets -}}
{{ $myList = append $myList .pluginName -}}
{{- end }}
{{- $myList | join "," -}}
{{- end -}}
{{- define "kong.wait-for-db" -}}
- name: wait-for-db
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
@@ -149,6 +211,8 @@ Create the ingress servicePort value string
value: {{ template "kong.postgresql.fullname" . }}
- name: KONG_PG_PORT
value: "{{ .Values.postgresql.service.port }}"
- name: KONG_LUA_PACKAGE_PATH
value: "/opt/?.lua;;"
- name: KONG_PG_PASSWORD
valueFrom:
secretKeyRef:
@@ -161,6 +225,8 @@ Create the ingress servicePort value string
{{- end }}
{{- include "kong.env" . | nindent 2 }}
command: [ "/bin/sh", "-c", "until kong start; do echo 'waiting for db'; sleep 1; done; kong stop" ]
volumeMounts:
{{- include "kong.volumeMounts" . | nindent 4 }}
{{- end -}}
{{- define "kong.controller-container" -}}
stable/kong/templates/deployment.yaml
+6 -28
View File
@@ -57,6 +57,8 @@ spec:
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
env:
- name: KONG_LUA_PACKAGE_PATH
value: "/opt/?.lua;;"
{{- if not .Values.env.admin_listen }}
{{- if .Values.admin.useTLS }}
- name: KONG_ADMIN_LISTEN
@@ -166,6 +168,8 @@ spec:
- name: KONG_DECLARATIVE_CONFIG
value: "/kong_dbless/kong.yml"
{{- end }}
- name: KONG_PLUGINS
value: {{ template "kong.plugins" . }}
{{- include "kong.env" . | indent 8 }}
lifecycle:
preStop:
@@ -248,16 +252,7 @@ spec:
{{- end }}
{{- end }}
volumeMounts:
- name: custom-nginx-template-volume
mountPath: /kong
{{- if (and (not .Values.ingressController.enabled) (eq .Values.env.database "off")) }}
- name: kong-custom-dbless-config-volume
mountPath: /kong_dbless/
{{- end }}
{{- range .Values.secretVolumes }}
- name: {{ . }}
mountPath: /etc/secrets/{{ . }}
{{- end }}
{{- include "kong.volumeMounts" . | nindent 10 }}
readinessProbe:
{{ toYaml .Values.readinessProbe | indent 10 }}
livenessProbe:
@@ -275,21 +270,4 @@ spec:
tolerations:
{{ toYaml .Values.tolerations | indent 8 }}
volumes:
- name: custom-nginx-template-volume
configMap:
name: {{ template "kong.fullname" . }}-default-custom-server-blocks
{{- if (and (not .Values.ingressController.enabled) (eq .Values.env.database "off")) }}
- name: kong-custom-dbless-config-volume
configMap:
{{- if .Values.dblessConfig.configMap }}
name: {{ .Values.dblessConfig.configMap }}
{{- else }}
name: {{ template "kong.dblessConfig.fullname" . }}
{{- end }}
{{- end }}
{{- range $secretVolume := .Values.secretVolumes }}
- name: {{ . }}
secret:
secretName: {{ . }}
{{- end }}
{{- include "kong.volumes" . | nindent 8 -}}
stable/kong/templates/migrations-post-upgrade.yaml
+8
View File
@@ -50,6 +50,10 @@ spec:
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
env:
- name: KONG_LUA_PACKAGE_PATH
value: "/opt/?.lua;;"
- name: KONG_PLUGINS
value: {{ template "kong.plugins" . }}
- name: KONG_NGINX_DAEMON
value: "off"
{{- if .Values.enterprise.enabled }}
@@ -72,5 +76,9 @@ spec:
{{- end }}
{{- include "kong.env" . | indent 8 }}
command: [ "/bin/sh", "-c", "kong migrations finish" ]
volumeMounts:
{{- include "kong.volumeMounts" . | nindent 8 }}
restartPolicy: OnFailure
volumes:
{{- include "kong.volumes" . | nindent 6 -}}
{{- end }}
stable/kong/templates/migrations-pre-upgrade.yaml
+8
View File
@@ -50,6 +50,10 @@ spec:
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
env:
- name: KONG_LUA_PACKAGE_PATH
value: "/opt/?.lua;;"
- name: KONG_PLUGINS
value: {{ template "kong.plugins" . }}
- name: KONG_NGINX_DAEMON
value: "off"
{{- if .Values.enterprise.enabled }}
@@ -72,5 +76,9 @@ spec:
{{- end }}
{{- include "kong.env" . | indent 8 }}
command: [ "/bin/sh", "-c", "kong migrations up" ]
volumeMounts:
{{- include "kong.volumeMounts" . | nindent 8 }}
restartPolicy: OnFailure
volumes:
{{- include "kong.volumes" . | nindent 6 -}}
{{- end }}
stable/kong/templates/migrations.yaml
+8
View File
@@ -45,6 +45,10 @@ spec:
image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
env:
- name: KONG_PLUGINS
value: {{ template "kong.plugins" . }}
- name: KONG_LUA_PACKAGE_PATH
value: "/opt/?.lua;;"
- name: KONG_NGINX_DAEMON
value: "off"
{{- if .Values.enterprise.enabled }}
@@ -67,5 +71,9 @@ spec:
{{- end }}
{{- include "kong.env" . | indent 8 }}
command: [ "/bin/sh", "-c", "kong migrations bootstrap" ]
volumeMounts:
{{- include "kong.volumeMounts" . | nindent 8 }}
restartPolicy: OnFailure
volumes:
{{- include "kong.volumes" . | nindent 6 -}}
{{- end }}
stable/kong/values.yaml
+14
View File
@@ -358,6 +358,20 @@ postgresql:
service:
port: 5432
# Custom Kong plugins can be loaded into Kong by mounting the plugin code
# into the file-system of Kong container.
# The plugin code should be present in ConfigMap or Secret inside the same
# namespace as Kong is being installed.
# The `name` property refers to the name of the ConfigMap or Secret
# itself, while the pluginName refers to the name of the plugin as it appears
# in Kong.
plugins: {}
# configMaps:
# - pluginName: rewriter
# name: kong-plugin-rewriter
# secrets:
# - pluginName: rewriter
# name: kong-plugin-rewriter
# Kong Ingress Controller's primary purpose is to satisfy Ingress resources
# created in k8s. It uses CRDs for more fine grained control over routing and
# for Kong specific configuration.