feat: Gateway-API as an alternative to the Ingress in five annotation charts
Validate Helm Charts / Detect changed charts (pull_request) Successful in 4s
Validate Helm Charts / Resource quantities (pull_request) Successful in 14s
Validate Helm Charts / Selector match (pull_request) Successful in 14s
Validate Helm Charts / HTTPRoute match (pull_request) Successful in 14s
Validate Helm Charts / Build freesailarr (pull_request) Successful in 7s
Validate Helm Charts / Build outline (pull_request) Successful in 7s
Validate Helm Charts / Build paperless-ngx (pull_request) Successful in 8s
Validate Helm Charts / Build zipline (pull_request) Successful in 8s
Validate Helm Charts / Build calibre-web-automated (pull_request) Successful in 7s
Validate Helm Charts / Trivy config calibre-web-automated (pull_request) Successful in 19s
Validate Helm Charts / Trivy config freesailarr (pull_request) Successful in 24s
Validate Helm Charts / Trivy config outline (pull_request) Successful in 17s
Validate Helm Charts / Trivy config paperless-ngx (pull_request) Successful in 19s
Validate Helm Charts / Trivy config zipline (pull_request) Successful in 19s
Install-test / Install-test calibre-web-automated (pull_request) Successful in 2m11s
Install-test / Install-test freesailarr (pull_request) Successful in 3m55s
Install-test / Install-test outline (pull_request) Successful in 2m44s
Install-test / Install-test paperless-ngx (pull_request) Successful in 3m52s
Install-test / Install-test zipline (pull_request) Successful in 2m6s
Validate Helm Charts / Install-test (pull_request) Successful in 14m50s
Validate Helm Charts / Detect changed charts (pull_request) Successful in 4s
Validate Helm Charts / Resource quantities (pull_request) Successful in 14s
Validate Helm Charts / Selector match (pull_request) Successful in 14s
Validate Helm Charts / HTTPRoute match (pull_request) Successful in 14s
Validate Helm Charts / Build freesailarr (pull_request) Successful in 7s
Validate Helm Charts / Build outline (pull_request) Successful in 7s
Validate Helm Charts / Build paperless-ngx (pull_request) Successful in 8s
Validate Helm Charts / Build zipline (pull_request) Successful in 8s
Validate Helm Charts / Build calibre-web-automated (pull_request) Successful in 7s
Validate Helm Charts / Trivy config calibre-web-automated (pull_request) Successful in 19s
Validate Helm Charts / Trivy config freesailarr (pull_request) Successful in 24s
Validate Helm Charts / Trivy config outline (pull_request) Successful in 17s
Validate Helm Charts / Trivy config paperless-ngx (pull_request) Successful in 19s
Validate Helm Charts / Trivy config zipline (pull_request) Successful in 19s
Install-test / Install-test calibre-web-automated (pull_request) Successful in 2m11s
Install-test / Install-test freesailarr (pull_request) Successful in 3m55s
Install-test / Install-test outline (pull_request) Successful in 2m44s
Install-test / Install-test paperless-ngx (pull_request) Successful in 3m52s
Install-test / Install-test zipline (pull_request) Successful in 2m6s
Validate Helm Charts / Install-test (pull_request) Successful in 14m50s
Group 2 of the #114 sweep: the charts whose behaviour hangs off an nginx annotation - calibre-web-automated, outline, paperless-ngx, zipline (proxy-body-size) and freesailarr (rewrite-target). Each gets the form the pilot (cyberchef, PR #115) fixed and group 1 (PR #116) repeated: an httpRoute block off by default, a template rendering ONLY an HTTPRoute with parentRefs - no Gateway, no gatewayClassName, no Certificate, no implementation-specific policy object - render aborts on both modes at once (naming both value paths), on an empty parentRefs and on a missing hostname, empty hostnames meaning [ingress.domain], a schema entry closed against unknown keys with an open parentRef definition, and a NOTES.txt that names the active mode and what the mode costs. Minor, additive, defaults unchanged: `helm template` with each chart's CI values is byte-identical to origin/main for all five. The upload limit is DOCUMENTED, not rebuilt (decision 2 of the issue). The Gateway API knows no body size; a policy object would bind the chart to one implementation. So the Gateway branch of NOTES.txt says, per chart and in the chart's own terms, that the value is NOT ENFORCED and names where to set it: an e-book library (calibre), an upload service (zipline), the web-UI half of the document intake while the consume directory keeps no limit at all (paperless), and the open #12 pair (outline). Four findings that were not in the plan, each argued in the file it changes: freesailarr gated freesailarr.sharedIngressApps on ingress.enabled, and that list is read by the <APP>__SERVER__URLBASE variables as well as by the routing objects. In Gateway mode it would have come out EMPTY while the route served radarr, sonarr and prowlarr under their prefixes: UrlBase unset, assets and API calls linked at the host root, broken UI behind a Ready pod. The helper's two guards (seerr/mediathekarr only at "/", no duplicate paths) would have gone unenforced there too. Fixed with freesailarr.published (ingress.enabled OR httpRoute.enabled) - the same shape as sure.publishedOverTls in group 1, and identical to ingress.enabled while httpRoute.enabled is false. Measured: on origin/main with ingress.enabled: false the render emits ZERO URLBASE variables; with this change in Gateway mode it emits three. paperless-ngx was the last chart in the repository rendering its Ingress UNCONDITIONALLY. Without an ingress.enabled switch there is no second value path for the mutual-exclusion abort to name, and the Ingress plus its unconditional required() on clusterIssuer would have kept rendering in Gateway mode - a value demanded for nothing, which is issue #114's "Folge 1" and README guideline 12. The switch was added, defaulting to true, so the render is unchanged. paperless-ngx PAPERLESS_URL had no required() of its own: it relied on the Ingress template's, which stops firing the moment the Ingress is switchable. With httpRoute.hostnames set and ingress.domain empty it would have rendered "https://" and refused every login POST as a CSRF failure. It now carries its own required(), naming what the value is for. calibre-web-automated claimed, in values.yaml and in its schema, that ingress.domain is read nowhere but in the Ingress template. The HTTPRoute reads it, so the claim now holds only while both modes are off. Corrected rather than left standing - the same correction garage needed in group 1. freesailarr is where the Gateway API is LESS machinery than what it replaces, not a translation of it. rewrite-target applies per Ingress OBJECT, so qBittorrent (no base path, prefix must be stripped) needed a second Ingress on the shared host, which then had to repeat the first object's TLS secret name, omit the cert-manager annotation conditionally so only one Certificate is requested, and match an ImplementationSpecific regex path for the rewrite's capture group. A URLRewrite filter applies per RULE: one route, one rule per app, the filter on qBittorrent's rule, a plain PathPrefix. All four crutches gone. It is also the only chart without httpRoute.hostnames - it has no ingress.domain either, and a chart-global hostname list could not say which of the ten apps it belonged to, so the hostnames stay in ingress.host and <app>.ingress.host. CI: one render overlay per chart under ci/httproute/, so the assertion is not vacuum-green - ci/run-httproute-match-test.sh goes from 20 held assertions over 10 charts to 36 over 15. freesailarr's overlay moves bazarr onto a host of its own, so the shared-host route AND the per-app route are both rendered; without that the per-app branch would be exercised by nothing. The install-test fixtures stay in Ingress mode: the install runs one configuration per chart, cyberchef already pays that price against the real Gateway-API CRDs, and for paperless-ngx that fixture is the only install of the valkey-subchart path anywhere. README also carries a stale figure fixed here: the HTTPRoute test was still documented at the pilot's 4 assertions over 2 charts, although group 1 had taken it to 20 over 10. Not proven, by construction: that traffic flows. No Gateway controller runs in CI. Not run locally either: k3d, Docker, Trivy. The Gateway branch of NOTES.txt is EXECUTED by the render test (a template error in it fails the job, verified) but its text is printed by no pipeline stage - helm template does not emit notes, and the install-test installs in Ingress mode. Part of #114
This commit is contained in:
34 files changed
+1794
-74
No files matched your search
@@ -8,12 +8,18 @@
|
||||
{{- $valkeySvc := printf "%s-valkey-service" .Release.Name -}}
|
||||
{{- $pre := default (list) $scripts.preConsumptionScripts -}}
|
||||
{{- $post := default (list) $scripts.postConsumptionScripts -}}
|
||||
{{- $httpRoute := .Values.httpRoute | default dict -}}
|
||||
{{- $hostnames := $httpRoute.hostnames | default list -}}
|
||||
{{- if not $hostnames -}}
|
||||
{{- $hostnames = list .Values.ingress.domain -}}
|
||||
{{- end -}}
|
||||
Paperless-ngx {{ .Chart.AppVersion }} — release {{ .Release.Name }} in namespace {{ .Release.Namespace }}.
|
||||
|
||||
ACCESS
|
||||
{{- if .Values.ingress.enabled }}
|
||||
|
||||
ACCESS — INGRESS MODE (ingress.enabled: true, httpRoute.enabled: false)
|
||||
https://{{ .Values.ingress.domain }}
|
||||
|
||||
This chart has no ingress.enabled switch — the Ingress is always rendered.
|
||||
The certificate is requested by cert-manager through the
|
||||
"{{ .Values.ingress.clusterIssuer }}" cluster issuer; until it has been issued the browser
|
||||
shows a warning. Follow it with
|
||||
@@ -32,12 +38,87 @@ ACCESS
|
||||
PAPERLESS_CSRF_TRUSTED_ORIGINS through paperless.env for as long as you need
|
||||
it. Changing ingress.domain later changes PAPERLESS_URL with it, and the
|
||||
pods have to restart before they notice.
|
||||
{{- else if $httpRoute.enabled }}
|
||||
|
||||
ACCESS — GATEWAY MODE (httpRoute.enabled: true, ingress.enabled: false)
|
||||
{{- range $hostnames }}
|
||||
https://{{ . }}
|
||||
{{- end }}
|
||||
|
||||
This release renders an HTTPRoute ({{ .Release.Name }}-{{ .Chart.Name }}-httproute) and NOTHING
|
||||
else of the routing path — no Gateway, no class, no Certificate. Three things
|
||||
therefore belong to the cluster and not to this chart, and if any is missing
|
||||
the address above does not answer:
|
||||
|
||||
1. The Gateway-API CRDs. Without them this install would have failed.
|
||||
2. The Gateway named in httpRoute.parentRefs
|
||||
{{- range $httpRoute.parentRefs }}
|
||||
{{ .name }}{{ if .namespace }} in namespace {{ .namespace }}{{ end }}{{ if .sectionName }}, listener {{ .sectionName }}{{ end }}
|
||||
{{- end }}
|
||||
must exist AND its listener must allow routes from this namespace
|
||||
({{ .Release.Namespace }}) in allowedRoutes. A rejected attachment shows
|
||||
up only in the route's status:
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} get httproute {{ .Release.Name }}-{{ .Chart.Name }}-httproute -o yaml
|
||||
|
||||
Read status.parents[].conditions — "Accepted: True" and
|
||||
"ResolvedRefs: True" is a working attachment. An empty status means no
|
||||
controller has looked at the route at all.
|
||||
3. The TLS certificate for the hostname, on the Gateway's listener.
|
||||
ingress.clusterIssuer is NOT used in this mode and is not required: the
|
||||
chart renders no Certificate, so there is no
|
||||
tls-{{ .Release.Name }}-{{ .Chart.Name }}-ingress secret and nothing for cert-manager to do.
|
||||
|
||||
ingress.domain is still required in this mode and is {{ .Values.ingress.domain }}: it is also
|
||||
PAPERLESS_URL ("https://{{ .Values.ingress.domain }}"), the only origin this release declares to
|
||||
Django, and the route does not replace it. If you set httpRoute.hostnames to
|
||||
a name ingress.domain does not carry, the route publishes one host while
|
||||
Django trusts another — pages load and every login POST is refused as a CSRF
|
||||
failure. Set both together, and remember the pods have to restart before they
|
||||
notice a changed domain.
|
||||
|
||||
YOUR WEB-UI UPLOAD LIMIT IS NOT paperless.files.maxUploadFileSize ANY MORE.
|
||||
That value ({{ .Values.paperless.files.maxUploadFileSize }}) is NOT ENFORCED in this mode. The chart renders it
|
||||
into nginx.ingress.kubernetes.io/proxy-body-size, and the Gateway API has NO
|
||||
counterpart — it knows no body size at all, that is implementation-specific
|
||||
policy — so this chart deliberately renders no policy object, which would
|
||||
bind it to one implementation. Whatever limit the Gateway enforces caps
|
||||
uploads through the web UI, and the symptom is the proxy's error rather than a
|
||||
message from paperless. Set it at the Gateway or through its
|
||||
implementation's own policy object, next to the Gateway and not here.
|
||||
|
||||
The consume directory is unaffected: it passes no proxy and has no size limit
|
||||
in any mode, so a document too large for the web UI still gets in that way.
|
||||
|
||||
ingress.annotations is inert in this mode for the same reason — the Gateway
|
||||
API has no annotation channel.
|
||||
{{- else }}
|
||||
|
||||
ACCESS — NEITHER INGRESS NOR HTTPROUTE
|
||||
ingress.enabled and httpRoute.enabled are both false, so this release is not
|
||||
published: no Ingress, no HTTPRoute and no certificate, and
|
||||
ingress.clusterIssuer is not needed.
|
||||
|
||||
ingress.domain IS still required and is {{ .Values.ingress.domain }}: the chart hands it to the
|
||||
container as PAPERLESS_URL ("https://{{ .Values.ingress.domain }}"), the only origin this
|
||||
release declares. Reach the instance inside the cluster with
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} port-forward svc/{{ .Release.Name }}-{{ .Chart.Name }}-service 8000:80
|
||||
|
||||
Pages then load over http://localhost:8000, but expect the login POST to be
|
||||
refused as a CSRF failure — that origin is not PAPERLESS_URL. Add
|
||||
PAPERLESS_CSRF_TRUSTED_ORIGINS through paperless.env for as long as you need
|
||||
it. paperless.files.maxUploadFileSize ({{ .Values.paperless.files.maxUploadFileSize }}) does nothing in this mode:
|
||||
it exists only as an ingress-nginx annotation.
|
||||
{{- end }}
|
||||
{{ if eq $replicas "0" }}
|
||||
SCALED TO ZERO
|
||||
{{ if .Values.scaleDown }}scaleDown: true{{ else }}paperless.replicas: 0{{ end }} — the StatefulSet runs with replicas: 0, so the URL above
|
||||
does not answer until you set it back and upgrade again. PVCs, Secrets,
|
||||
Service and Ingress stay in place, so neither the documents nor the
|
||||
certificate are touched.
|
||||
Service{{ if .Values.ingress.enabled }} and Ingress stay in place, so neither the documents nor the
|
||||
certificate are touched.{{ else if $httpRoute.enabled }} and HTTPRoute stay in place, so the documents are not touched —
|
||||
the route then resolves to a Service with no endpoints and the Gateway
|
||||
answers its own error.{{ else }} stay in place, so the documents are not touched.{{ end }}
|
||||
{{- if .Values.smbConnection.enabled }}
|
||||
{{- if .Values.scaleDown }}
|
||||
scaleDown also suspends the SMB consume CronJob, so nothing is moved off the
|
||||
@@ -227,11 +308,24 @@ HOW DOCUMENTS GET IN
|
||||
paperless.files.storage ({{ .Values.paperless.files.storage }}) sizes only the main volume, which holds
|
||||
data/, media/ and export/ as subPaths.
|
||||
|
||||
{{- if .Values.ingress.enabled }}
|
||||
Uploads through the web UI take the second route and pass the Ingress, where
|
||||
the chart sets a body-size cap of {{ .Values.paperless.files.maxUploadFileSize }} (paperless.files.maxUploadFileSize,
|
||||
rendered into both the nginx.ingress and nginx.org annotations). A larger
|
||||
file is rejected by the ingress controller with a 413 before paperless ever
|
||||
sees it — the consume directory has no such limit.
|
||||
{{- else if $httpRoute.enabled }}
|
||||
Uploads through the web UI take the second route, and in GATEWAY MODE
|
||||
paperless.files.maxUploadFileSize ({{ .Values.paperless.files.maxUploadFileSize }}) is NOT ENFORCED: it exists only as
|
||||
an ingress-nginx annotation and the Gateway API has no body-size field, so
|
||||
the cap is whatever the Gateway enforces. The consume directory has no limit
|
||||
in either mode.
|
||||
{{- else }}
|
||||
Uploads through the web UI take the second route, but nothing publishes this
|
||||
release and paperless.files.maxUploadFileSize ({{ .Values.paperless.files.maxUploadFileSize }}) is rendered nowhere:
|
||||
it exists only as an ingress-nginx annotation. The consume directory has no
|
||||
limit either way.
|
||||
{{- end }}
|
||||
{{- if .Values.smbConnection.enabled }}
|
||||
|
||||
SMB CONSUME IS ON — AND IT MOVES ONLY TOP-LEVEL PDFs
|
||||
|
||||
Reference in new issue
Block a user