Skip to content

Commit 56973b5

Browse files
committed
api/redis: scope upgrade notices to upgrades, document existingSecret auth
1 parent 79abc08 commit 56973b5

3 files changed

Lines changed: 12 additions & 6 deletions

File tree

charts/bunkerweb/templates/NOTES.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
BunkerWeb has been successfully deployed!
22

3-
{{- if ne (include "bunkerweb.apiEnabled" .) "true" }}
3+
{{- if and .Release.IsUpgrade (ne (include "bunkerweb.apiEnabled" .) "true") }}
44

55
================================================================================
6-
NOTICE (chart 1.0.19)
6+
UPGRADE NOTICE (chart 1.0.19)
77
================================================================================
88

99
The external API is now DISABLED by default (was enabled in <= 1.0.18, where
@@ -12,7 +12,7 @@ default-on API, set api.enabled=true AND configure authentication
1212
(settings.api.useBearerToken / useUserPass / apiAclBootstrapFile).
1313
{{- end }}
1414

15-
{{- if and .Values.redis.enabled .Values.redis.useConfigFile }}
15+
{{- if and .Release.IsUpgrade .Values.redis.enabled .Values.redis.useConfigFile }}
1616

1717
================================================================================
1818
UPGRADE NOTICE (chart 1.0.17 / app 1.6.10)

charts/bunkerweb/templates/api-deployment.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ spec:
125125
- name: api-acl-bootstrap
126126
mountPath: /var/lib/bunkerweb/api_acl_bootstrap.json
127127
{{- end }}
128-
{{- if .Values.settings.api.apiAclBootstrapFile }}
128+
{{- if .Values.settings.api.apiAclBootstrapFile }}
129129
volumes:
130130
- name: api-acl-bootstrap
131131
configMap:

charts/bunkerweb/values.yaml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,13 +203,19 @@ settings:
203203
# Choose at least one method of authentication
204204
# API Bearer Token
205205
useBearerToken:
206-
# If enable, it will use settings.existingSecret
206+
# If true, the token is read from settings.existingSecret.
207+
# The auth guard only checks that existingSecret is set, NOT that it
208+
# contains the "api-token" key — that key MUST exist in the secret or
209+
# the API will crash-loop at runtime (render cannot inspect secret data).
207210
fromExistingSecret: false
208211
# If not using existingSecret, set the token here
209212
token: ""
210213
# Username and Password
211214
useUserPass:
212-
# If enable, it will use settings.existingSecret
215+
# If true, credentials are read from settings.existingSecret.
216+
# The guard only checks that existingSecret is set, NOT that it contains
217+
# the "api-username" and "api-password" keys — both MUST exist in the
218+
# secret or the API will crash-loop at runtime.
213219
fromExistingSecret: false
214220
# If not using existingSecret, set the credentials here
215221
apiUsername: ""

0 commit comments

Comments
 (0)