Skip to content

Commit d31a0b5

Browse files
nic-6443nic-6443
authored
chore: release 0.1.11 gateway chart (#149)
Signed-off-by: Nic <[email protected]>
1 parent 71479c2 commit d31a0b5

File tree

8 files changed

+40
-223
lines changed

8 files changed

+40
-223
lines changed

‎charts/gateway/Chart.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ type: application
1414
# This is the chart version. This version number should be incremented each time you make changes
1515
# to the chart and its templates, including the app version.
1616
# Versions are expected to follow Semantic Versioning (https://semver.org/)
17-
version: 0.1.10
17+
version: 0.1.11
1818

1919
# This is the version number of the application being deployed. This version number should be
2020
# incremented each time you make changes to the application. Versions are not expected to
2121
# follow Semantic Versioning. They should reflect the version the application is using.
22-
appVersion: "3.2.0"
22+
appVersion: "3.2.16.3"
2323

2424
dependencies:
2525
- name: etcd

‎charts/gateway/README.md‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ The command removes all the Kubernetes components associated with the chart and
6262
| apisix.enableServerTokens | bool | `true` | Whether the APISIX version number should be shown in Server header |
6363
| apisix.enabled | bool | `true` | Enable or disable API7 Gateway itself |
6464
| apisix.extraEnvVars | list | `[]` | extraEnvVars An array to add extra env vars e.g: extraEnvVars: - name: FOO value: "bar" - name: FOO2 valueFrom: secretKeyRef: name: SECRET_NAME key: KEY |
65+
| apisix.extraEnvVarsCM | string | `""` | |
66+
| apisix.extraEnvVarsSecret | string | `""` | |
6567
| apisix.hostNetwork | bool | `false` | |
6668
| apisix.http.luaSharedDict.access-tokens | string | `"1m"` | |
6769
| apisix.http.luaSharedDict.balancer-ewma | string | `"10m"` | |
@@ -90,7 +92,7 @@ The command removes all the Kubernetes components associated with the chart and
9092
| apisix.httpRouter | string | `"radixtree_host_uri"` | Defines how apisix handles routing: - radixtree_uri: match route by uri(base on radixtree) - radixtree_host_uri: match route by host + uri(base on radixtree) - radixtree_uri_with_parameter: match route by uri with parameters |
9193
| apisix.image.pullPolicy | string | `"Always"` | API7 Gateway image pull policy |
9294
| apisix.image.repository | string | `"api7/api7-ee-3-gateway"` | API7 Gateway image repository |
93-
| apisix.image.tag | string | `"3.2.7.1"` | API7 Gateway image tag Overrides the image tag whose default is the chart appVersion. |
95+
| apisix.image.tag | string | `"3.2.16.3"` | API7 Gateway image tag Overrides the image tag whose default is the chart appVersion. |
9496
| apisix.kind | string | `"Deployment"` | Use a `DaemonSet` or `Deployment` |
9597
| apisix.luaModuleHook | object | `{"configMapRef":{"mounts":[{"key":"","path":""}],"name":""},"enabled":false,"hookPoint":"","luaPath":""}` | Whether to add a custom lua module |
9698
| apisix.luaModuleHook.configMapRef | object | `{"mounts":[{"key":"","path":""}],"name":""}` | configmap that stores the codes |
@@ -127,14 +129,6 @@ The command removes all the Kubernetes components associated with the chart and
127129
| autoscaling.targetMemoryUtilizationPercentage | int | `80` | |
128130
| autoscaling.version | string | `"v2"` | HPA version, the value is "v2" or "v2beta1", default "v2" |
129131
| configurationSnippet | object | `{"httpAdmin":"","httpEnd":"","httpSrv":"","httpSrvLocation":"","httpStart":"","main":"","stream":""}` | Custom configuration snippet. |
130-
| customPlugins | object | `{"enabled":false,"luaPath":"/opts/custom_plugins/?.lua","plugins":[{"attrs":{},"configMap":{"mounts":[{"key":"the-file-name","path":"mount-path"}],"name":"configmap-name"},"name":"plugin-name"}]}` | customPlugins allows you to mount your own HTTP plugins. |
131-
| customPlugins.enabled | bool | `false` | Whether to configure some custom plugins |
132-
| customPlugins.luaPath | string | `"/opts/custom_plugins/?.lua"` | the lua_path that tells APISIX where it can find plugins, note the last ';' is required. |
133-
| customPlugins.plugins[0] | object | `{"attrs":{},"configMap":{"mounts":[{"key":"the-file-name","path":"mount-path"}],"name":"configmap-name"},"name":"plugin-name"}` | plugin name. |
134-
| customPlugins.plugins[0].attrs | object | `{}` | plugin attrs |
135-
| customPlugins.plugins[0].configMap | object | `{"mounts":[{"key":"the-file-name","path":"mount-path"}],"name":"configmap-name"}` | plugin codes can be saved inside configmap object. |
136-
| customPlugins.plugins[0].configMap.mounts | list | `[{"key":"the-file-name","path":"mount-path"}]` | since keys in configmap is flat, mountPath allows to define the mount path, so that plugin codes can be mounted hierarchically. |
137-
| customPlugins.plugins[0].configMap.name | string | `"configmap-name"` | name of configmap. |
138132
| deployment.certs | object | `{"cert":"","cert_key":"","certsSecret":"","mTLSCACert":"","mTLSCACertSecret":""}` | certs used for certificates in decoupled mode |
139133
| deployment.certs.cert | string | `""` | cert name in certsSecret |
140134
| deployment.certs.cert_key | string | `""` | cert key in certsSecret |
@@ -178,8 +172,6 @@ The command removes all the Kubernetes components associated with the chart and
178172
| etcd.prefix | string | `"/apisix"` | apisix configurations prefix |
179173
| etcd.timeout | int | `30` | Set the timeout value in seconds for subsequent socket operations from apisix to etcd cluster |
180174
| etcd.user | string | `""` | if etcd.enabled is false, username for external etcd. If etcd.enabled is true, use etcd.auth.rbac.rootPassword instead. |
181-
| extPlugin.cmd | list | `["/path/to/apisix-plugin-runner/runner","run"]` | the command and its arguements to run as a subprocess |
182-
| extPlugin.enabled | bool | `false` | Enable External Plugins. See [external plugin](https://apisix.apache.org/docs/apisix/next/external-plugin/) |
183175
| extraInitContainers | list | `[]` | Additional `initContainers`, See [Kubernetes initContainers](https://kubernetes.io/docs/concepts/workloads/pods/init-containers/) for the detail. |
184176
| extraVolumeMounts | list | `[]` | Additional `volume`, See [Kubernetes Volumes](https://kubernetes.io/docs/concepts/storage/volumes/) for the detail. |
185177
| extraVolumes | list | `[]` | Additional `volume`, See [Kubernetes Volumes](https://kubernetes.io/docs/concepts/storage/volumes/) for the detail. |
@@ -214,7 +206,6 @@ The command removes all the Kubernetes components associated with the chart and
214206
| nginx.workerProcesses | string | `"auto"` | |
215207
| nginx.workerRlimitNofile | string | `"20480"` | |
216208
| pluginAttrs | object | `{}` | Set APISIX plugin attributes, see [config-default.yaml](https://github.com/apache/apisix/blob/master/conf/config-default.yaml#L376) for more details |
217-
| plugins | list | `[]` | Customize the list of APISIX plugins to enable. By default, APISIX's default plugins are automatically used. See [config-default.yaml](https://github.com/apache/apisix/blob/master/conf/config-default.yaml) |
218209
| rbac.create | bool | `false` | |
219210
| serviceAccount.annotations | object | `{}` | |
220211
| serviceAccount.create | bool | `false` | |
@@ -229,12 +220,17 @@ The command removes all the Kubernetes components associated with the chart and
229220
| serviceMonitor.name | string | `""` | name of the serviceMonitor, by default, it is the same as the apisix fullname |
230221
| serviceMonitor.namespace | string | `""` | namespace where the serviceMonitor is deployed, by default, it is the same as the namespace of the apisix |
231222
| serviceMonitor.path | string | `"/apisix/prometheus/metrics"` | path of the metrics endpoint |
232-
| stream_plugins | list | `[]` | Customize the list of APISIX stream_plugins to enable. By default, APISIX's default stream_plugins are automatically used. See [config-default.yaml](https://github.com/apache/apisix/blob/master/conf/config-default.yaml) |
233223
| updateStrategy | object | `{}` | |
234224
| vault.enabled | bool | `false` | Enable or disable the vault integration |
235225
| vault.host | string | `""` | The host address where the vault server is running. |
236226
| vault.prefix | string | `""` | Prefix allows you to better enforcement of policies. |
237227
| vault.timeout | int | `10` | HTTP timeout for each request. |
238228
| vault.token | string | `""` | The generated token from vault instance that can grant access to read data from the vault. |
239-
| wasmPlugins.enabled | bool | `false` | Enable Wasm Plugins. See [wasm plugin](https://apisix.apache.org/docs/apisix/next/wasm/) |
240-
| wasmPlugins.plugins | list | `[]` | |
229+
230+
## Upgrading
231+
232+
### To 0.1.11
233+
234+
Remove configuration items such as `plugins`, `stream_plugins`, and `custom_plugins` that are no longer needed in API7 EE.
235+
236+
**This version of the helm chart needs to be used with API7 EE gateway version 3.2.16.3 or above.**

‎charts/gateway/README.md.gotmpl‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,12 @@ The command removes all the Kubernetes components associated with the chart and
3434
## Parameters
3535

3636
{{ template "chart.valuesSection" . }}
37+
38+
39+
## Upgrading
40+
41+
### To 0.1.11
42+
43+
Remove configuration items such as `plugins`, `stream_plugins`, and `custom_plugins` that are no longer needed in API7 EE.
44+
45+
**This version of the helm chart needs to be used with API7 EE gateway version 3.2.16.3 or above.**

‎charts/gateway/templates/_helpers.tpl‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,6 @@ prometheus:
8888
export_uri: {{ .Values.serviceMonitor.path }}
8989
metric_prefix: {{ .Values.serviceMonitor.metricPrefix }}
9090
{{- end }}
91-
{{- if .Values.customPlugins.enabled }}
92-
{{- range $plugin := .Values.customPlugins.plugins }}
93-
{{- if $plugin.attrs }}
94-
{{ $plugin.name }}: {{- $plugin.attrs | toYaml | nindent 2 }}
95-
{{- end }}
96-
{{- end }}
97-
{{- end }}
9891
{{- end -}}
9992

10093
{{- define "apisix.pluginAttrs" -}}

‎charts/gateway/templates/_pod.tpl‎

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,15 @@ spec:
5353
name: {{ .Values.admin.credentials.secretName }}
5454
key: viewer
5555
{{- end }}
56+
envFrom:
57+
{{- if .Values.apisix.extraEnvVarsCM }}
58+
- configMapRef:
59+
name: {{ include "apisix.tplvalues.render" (dict "value" .Values.apisix.extraEnvVarsCM "context" $) }}
60+
{{- end }}
61+
{{- if .Values.apisix.extraEnvVarsSecret }}
62+
- secretRef:
63+
name: {{ include "apisix.tplvalues.render" (dict "value" .Values.apisix.extraEnvVarsSecret "context" $) }}
64+
{{- end }}
5665

5766
ports:
5867
- name: http
@@ -155,24 +164,6 @@ spec:
155164
- mountPath: /etcd-ssl
156165
name: etcd-ssl
157166
{{- end }}
158-
{{- if .Values.customPlugins.enabled }}
159-
{{- range $plugin := .Values.customPlugins.plugins }}
160-
{{- range $mount := $plugin.configMap.mounts }}
161-
{{- if ne $plugin.configMap.name "" }}
162-
- mountPath: {{ $mount.path }}
163-
name: plugin-{{ $plugin.configMap.name }}
164-
subPath: {{ $mount.key }}
165-
{{- end }}
166-
{{- end }}
167-
{{- end }}
168-
{{- end }}
169-
{{- if .Values.apisix.luaModuleHook.enabled }}
170-
{{- range $mount := .Values.apisix.luaModuleHook.configMapRef.mounts }}
171-
- mountPath: {{ $mount.path }}
172-
name: lua-module-hook
173-
subPath: {{ $mount.key }}
174-
{{- end }}
175-
{{- end }}
176167
{{- if .Values.extraVolumeMounts }}
177168
{{- toYaml .Values.extraVolumeMounts | nindent 8 }}
178169
{{- end }}
@@ -235,20 +226,6 @@ spec:
235226
fieldPath: metadata.uid
236227
name: id
237228
{{- end }}
238-
{{- if .Values.customPlugins.enabled }}
239-
{{- range $plugin := .Values.customPlugins.plugins }}
240-
{{- if ne $plugin.configMap.name "" }}
241-
- name: plugin-{{ $plugin.configMap.name }}
242-
configMap:
243-
name: {{ $plugin.configMap.name }}
244-
{{- end }}
245-
{{- end }}
246-
{{- end }}
247-
{{- if .Values.apisix.luaModuleHook.enabled }}
248-
- name: lua-module-hook
249-
configMap:
250-
name: {{ .Values.apisix.luaModuleHook.configMapRef.name }}
251-
{{- end }}
252229
{{- if .Values.extraVolumes }}
253230
{{- toYaml .Values.extraVolumes | nindent 4 }}
254231
{{- end }}

‎charts/gateway/templates/configmap.yaml‎

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ data:
2828
enable_admin: {{ .Values.admin.enabled }}
2929
enable_admin_cors: {{ .Values.admin.cors }}
3030
enable_debug: false
31-
{{- if or .Values.customPlugins.enabled .Values.apisix.luaModuleHook.enabled }}
32-
extra_lua_path: {{ .Values.customPlugins.luaPath }};{{ .Values.apisix.luaModuleHook.luaPath }}
33-
{{- end }}
3431
3532
{{- if .Values.apisix.luaModuleHook.enabled }}
3633
lua_module_hook: {{ .Values.apisix.luaModuleHook.hookPoint | quote }}
@@ -216,49 +213,13 @@ data:
216213
prefix: {{ .Values.vault.prefix }}
217214
{{- end }}
218215
219-
{{- if .Values.plugins }}
220-
plugins: # plugin list
221-
{{- range $plugin := .Values.plugins }}
222-
{{- if ne $plugin "" }}
223-
- {{ $plugin }}
224-
{{- end }}
225-
{{- end }}
226-
{{- if .Values.customPlugins.enabled }}
227-
{{- range $plugin := .Values.customPlugins.plugins }}
228-
- {{ $plugin.name }}
229-
{{- end }}
230-
{{- end }}
231-
{{- end }}
232-
{{- if .Values.stream_plugins }}
233-
stream_plugins:
234-
{{- range $plugin := .Values.stream_plugins }}
235-
{{- if ne $plugin "" }}
236-
- {{ $plugin }}
237-
{{- end }}
238-
{{- end }}
239-
{{- end }}
240-
241-
{{- if .Values.extPlugin.enabled }}
242-
ext-plugin:
243-
cmd:
244-
{{- range $arg := .Values.extPlugin.cmd }}
245-
- {{ $arg }}
246-
{{- end }}
247-
{{- end }}
248-
249-
{{- if or .Values.pluginAttrs .Values.customPlugins.enabled .Values.serviceMonitor.enabled}}
216+
{{- if or .Values.pluginAttrs .Values.serviceMonitor.enabled}}
250217
{{- $pluginAttrs := include "apisix.pluginAttrs" . -}}
251218
{{- if gt (len ($pluginAttrs | fromYaml)) 0 }}
252219
plugin_attr: {{- $pluginAttrs | nindent 6 }}
253220
{{- end }}
254221
{{- end }}
255222
256-
{{- if .Values.wasmPlugins.enabled }}
257-
wasm:
258-
plugins:
259-
{{- toYaml .Values.wasmPlugins.plugins | nindent 8 }}
260-
{{- end }}
261-
262223
deployment:
263224
role: {{ .Values.deployment.role }}
264225
{{- if or (eq .Values.deployment.role "traditional") (eq .Values.deployment.role "control_plane") }}

‎charts/gateway/values.schema.json‎

Lines changed: 1 addition & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,5 @@
11
{
22
"$schema": "https://json-schema.org/draft-07/schema#",
33
"properties": {
4-
"plugins": {
5-
"description": "APISIX plugins to be enabled",
6-
"type": "array",
7-
"items": {
8-
"type": "string"
9-
},
10-
"minItems": 0,
11-
"uniqueItems": true
12-
},
13-
"stream_plugins": {
14-
"description": "APISIX stream_plugins to be enabled",
15-
"type": "array",
16-
"items": {
17-
"type": "string"
18-
},
19-
"minItems": 0,
20-
"uniqueItems": true
21-
},
22-
"customPlugins": {
23-
"description": "customPlugins allows you to mount your own HTTP plugins",
24-
"type": "object",
25-
"properties": {
26-
"enabled": {
27-
"type": "boolean"
28-
},
29-
"luaPath": {
30-
"type": "string"
31-
},
32-
"plugins": {
33-
"type": "array",
34-
"items": {
35-
"type": "object",
36-
"properties": {
37-
"name": {
38-
"type": "string",
39-
"minLength": 1
40-
},
41-
"attrs": {
42-
"type": "object"
43-
},
44-
"configMap": {
45-
"type": "object",
46-
"properties": {
47-
"name": {
48-
"type": "string",
49-
"minLength": 1
50-
},
51-
"mounts": {
52-
"type": "array",
53-
"items": {
54-
"type": "object",
55-
"properties": {
56-
"key": {
57-
"type": "string",
58-
"minLength": 1
59-
},
60-
"path": {
61-
"type": "string",
62-
"minLength": 1
63-
}
64-
},
65-
"required": [
66-
"key",
67-
"path"
68-
]
69-
}
70-
}
71-
},
72-
"required": [
73-
"name",
74-
"mounts"
75-
]
76-
}
77-
},
78-
"required": [
79-
"name",
80-
"configMap"
81-
]
82-
}
83-
}
84-
},
85-
"required": [
86-
"enabled",
87-
"luaPath",
88-
"plugins"
89-
]
90-
}
914
}
92-
}
5+
}

0 commit comments

Comments
 (0)