Skip to content

Commit

Permalink
chore(notes) warn if Manager without admin API (#951)
Browse files Browse the repository at this point in the history
Feedback from issue kong#11995 highlighted potential user confusion
due to the internal connection between Kong Manager and the Admin API.

To address this, a warning message will now be displayed to notify users
that the current configuration combination will not function as expected.
  • Loading branch information
nekolab authored Nov 20, 2023
1 parent 5c74afe commit 739bc28
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions charts/kong/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
### Improvements

* Support for `affinity` configuration has been added to migration job templates.
* Display a warning message when Kong Manager is enabled and the Admin API is disabled.

## 2.32.0

Expand Down
7 changes: 7 additions & 0 deletions charts/kong/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,17 @@ Once installed, please follow along the getting started guide to start using
Kong: https://docs.konghq.com/kubernetes-ingress-controller/latest/guides/getting-started/

{{ $warnings := list -}}

{{- if (hasKey .Values.ingressController "serviceAccount") -}}
{{- if (or (hasKey .Values.ingressController.serviceAccount "name") (hasKey .Values.ingressController.serviceAccount "annotations")) -}}
{{- $warnings = append $warnings "you have set either .ingressController.serviceAccount.name or .ingressController.serviceAccount.annotations. These settings have moved to .deployment.serviceAccount.name and .deployment.serviceAccount.annotations. You must move your configuration to the new location in values.yaml" -}}
{{- end -}}
{{- end -}}

{{- if and .Values.manager.enabled (or .Values.manager.http.enabled .Values.manager.tls.enabled) -}}
{{- if not (and .Values.admin.enabled (or .Values.admin.http.enabled .Values.admin.tls.enabled)) -}}
{{- $warnings = append $warnings "Kong Manager will not be functional because the Admin API is not enabled. Setting both .admin.enabled and .admin.http.enabled and/or .admin.tls.enabled to true to enable the Admin API over HTTP/TLS." -}}
{{- end -}}
{{- end -}}

{{- include "kong.deprecation-warnings" $warnings -}}

0 comments on commit 739bc28

Please sign in to comment.