Files
helm-charts/paperless-ngx/templates/NOTES.txt
T
jklein bd1fdc09a0
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
feat: Gateway-API as an alternative to the Ingress in five annotation charts
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
2026-10-12 18:15:29 +00:00

481 lines
27 KiB
Plaintext

{{- $replicas := include "paperless-ngx.replicas" (dict "scaleDown" .Values.scaleDown "replicas" .Values.paperless.replicas) -}}
{{- $startup := fromYaml (include "paperless-ngx.startupProbe" .Values.paperless.startupProbe) -}}
{{- $barcodes := fromYaml (include "paperless-ngx.barcodes" .Values.paperless.files.barcodes) -}}
{{- $pod := printf "%s-%s-sfs-0" .Release.Name .Chart.Name -}}
{{- $scripts := .Values.paperless.scripts | default dict -}}
{{- $valkeySub := (.Values.valkeySubchart | default dict).enabled -}}
{{- $valkeyAuth := ((.Values.valkey | default dict).secrets | default dict).authSecretRef -}}
{{- $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 }}.
{{- if .Values.ingress.enabled }}
ACCESS — INGRESS MODE (ingress.enabled: true, httpRoute.enabled: false)
https://{{ .Values.ingress.domain }}
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
kubectl -n {{ .Release.Namespace }} get certificate tls-{{ .Release.Name }}-{{ .Chart.Name }}-ingress
ingress.domain is more than the Ingress host: the chart also hands it to the
container as PAPERLESS_URL ("https://{{ .Values.ingress.domain }}"), and that is the only
origin this release declares. While DNS or the certificate are still missing:
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. Forward the
port to look around, use the domain to log in, or add
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{{ 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
share while the release is down.
{{- else }}
The SMB consume CronJob is NOT suspended by this: only scaleDown sets
suspend: true. It keeps moving PDFs off the share onto a consume volume that
nothing is reading — they are gone from the share and not yet in paperless.
{{- end }}
{{- end }}
{{ end }}
WHAT THE 1PASSWORD ITEMS MUST CONTAIN
The chart creates OnePasswordItem CRs that carry an item path only; the
operator turns each into a Kubernetes Secret whose keys are the FIELD NAMES
of the item. Those names are decided here and appear nowhere in 1Password,
so they are exactly what you would otherwise read out of the templates. A
missing field does not fail the install — the release goes through and the
pod then hangs in CreateContainerConfigError naming the key it could not
find (kubectl -n {{ .Release.Namespace }} describe pod {{ $pod }}).
secrets.databaseSecretRef → {{ .Values.secrets.databaseSecretRef }}
Secret {{ .Release.Name }}-{{ .Chart.Name }}-db-secret, fields:
server database host — the field is called "server", not "host"
port database port
database database name
username database user
password database password
The engine is pinned to postgresql; there is no value to change it.
secrets.redisSecretRef → {{ .Values.secrets.redisSecretRef }}
Secret {{ .Release.Name }}-{{ .Chart.Name }}-redis-secret, fields:
redis-connection-url e.g. redis://:PASSWORD@redis:6379
key-prefix PAPERLESS_REDIS_PREFIX — set this per release when
several releases share one Redis, or two instances
will consume each other's task queue
auth-conf the COMPLETE line "requirepass PASSWORD", not a
bare password. Read by the bundled Valkey only, so
it is {{ if $valkeySub }}REQUIRED for this release — see the Valkey
section below{{ else }}unused while valkeySubchart.enabled is
false, and the item needs it only once you switch
the bundled Valkey on{{ end }}.
secrets.paperlessSecretRef → {{ .Values.secrets.paperlessSecretRef }}
Secret {{ .Release.Name }}-{{ .Chart.Name }}-secret, fields:
username used TWICE: as PAPERLESS_ADMIN_USER and as
PAPERLESS_ADMIN_MAIL, so it has to work as both a
login name and an address
password PAPERLESS_ADMIN_PASSWORD
paperless-secret-key Django's SECRET_KEY
PAPERLESS_ADMIN_* is only acted on while that superuser does not exist yet.
Editing the password field after the first start changes nothing; reset it
in the pod instead:
kubectl -n {{ .Release.Namespace }} exec -it {{ $pod }} -- \
python3 /usr/src/paperless/src/manage.py changepassword <user>
{{- if .Values.smbConnection.enabled }}
secrets.smbConnectionSecretRef → {{ .Values.secrets.smbConnectionSecretRef }}
Secret {{ .Release.Name }}-{{ .Chart.Name }}-smb-secret. This one is not read by any pod: it is
wired into the PersistentVolume as nodeStageSecretRef, and the
smb.csi.k8s.io driver reads the fields itself — usually username and
password, plus domain where the server wants one. The chart names no key
here, so a wrong field name surfaces as a mount failure on the CronJob's
pod — a describe on that pod, never a missing variable.
{{- end }}
{{- if .Values.secrets.oidcSecretRef }}
secrets.oidcSecretRef IS SET AND IS READ BY NOTHING
"{{ .Values.secrets.oidcSecretRef }}" — no template in this chart references
that value. No OnePasswordItem is created for it and no Secret appears. The
OIDC client id travels as plain env from oidc.provider.clientId, and no
client secret is configured at all (see the OIDC section below). Whatever
you put in that item has no effect on this release.
{{- end }}
CHANGING A SECRET'S CONTENT RESTARTS NOTHING
Helm never sees the content of a OnePasswordItem, so it cannot hash it, and
this chart carries no checksum annotation at all. Pointing a *SecretRef at a
DIFFERENT item rolls the pods; editing a value INSIDE the same item does not
— the operator updates the Kubernetes Secret while the running container
keeps the old value in its environment. After such a rotation:
kubectl -n {{ .Release.Namespace }} rollout restart statefulset/{{ .Release.Name }}-{{ .Chart.Name }}-sfs
Rotating paperless-secret-key logs every session out. Rotating the database
fields points the release at whatever that new endpoint contains, empty or
not, and the next start migrates it.
POSTGRES IS NOT PART OF THIS CHART{{ if not $valkeySub }}, AND NEITHER IS REDIS{{ end }}
{{ if $valkeySub }}The database{{ else }}Both{{ end }} ha{{ if $valkeySub }}s{{ else }}ve{{ end }} to exist and be reachable before the first start.{{ if not $valkeySub }} They fail in
opposite ways, and only one of them is loud:{{ end }}
- Without the database paperless does not come up at all. All three probes
ask for "/" on port 8000, so you get no useful error: the pod never turns
Ready and the startup probe kills it after
{{ $startup.periodSeconds }}s x {{ $startup.failureThreshold }} = {{ mul $startup.periodSeconds $startup.failureThreshold }}s. Read the container log, not the pod events.
- Without Redis the web UI comes up and looks healthy. Redis is the Celery
broker: consumption, OCR, the scheduled tasks and the index updates simply
never run, and documents dropped into the consume directory stay there.
A wrong redis-connection-url costs you the whole processing side and
nothing turns red.{{ if $valkeySub }} This release brings its own Valkey (below), so
the address is in your hands — which is exactly why the url is the one
thing to check first.{{ end }}
{{ if $valkeySub }}
THIS RELEASE BRINGS ITS OWN VALKEY — ONE MANDATORY STEP IS IN THE VAULT
valkeySubchart.enabled is true, so the release contains a Valkey of its own:
StatefulSet {{ .Release.Name }}-valkey-sfs, Service {{ $valkeySvc }}, its own
NetworkPolicy, and a PersistentVolumeClaim (persistence is on — this is a
queue, see below).
1. THE CONNECTION URL MUST POINT AT IT. This is a step, not a hint: the url
lives in the vault and the chart cannot write it. In the item
"{{ .Values.secrets.redisSecretRef }}", field redis-connection-url:
redis://:PASSWORD@{{ $valkeySvc }}:6379
Pointing elsewhere is not an error anywhere: paperless talks to that other
Redis, the Valkey next to it runs along unused, and nothing reports it.
2. THE PASSWORD IS IN THE ITEM TWICE — once inside redis-connection-url and
once in the "requirepass PASSWORD" line of auth-conf. Both are the same
password, and a rotation has to touch BOTH fields. Change only one and
paperless can no longer authenticate against its own Valkey. After any
such change, restart both workloads by hand (Helm cannot see inside a
1Password item, so nothing rolls automatically):
kubectl -n {{ .Release.Namespace }} rollout restart statefulset/{{ .Release.Name }}-{{ .Chart.Name }}-sfs
kubectl -n {{ .Release.Namespace }} rollout restart statefulset/{{ .Release.Name }}-valkey-sfs
3. AUTH-CONF IS A CONFIGURATION LINE, NOT A PASSWORD. The Valkey mounts the
field as a file and includes it, so the password never reaches a process
list or an environment variable. An init container refuses to start the
pod unless a line beginning with "requirepass " is really there — without
that check a typo would leave a Valkey running with NO password and
looking perfectly healthy.
{{- if and $valkeyAuth (ne ($valkeyAuth | toString) ($.Values.secrets.redisSecretRef | toString)) }}
NOTE: valkey.secrets.authSecretRef points at a DIFFERENT item than
secrets.redisSecretRef:
valkey.secrets.authSecretRef → {{ $valkeyAuth }}
secrets.redisSecretRef → {{ .Values.secrets.redisSecretRef }}
That is supported and may well be deliberate — the bundled Valkey is then fed
from its own item. It is only worth knowing that you now keep TWO items in
step: the password in auth-conf over there and the one inside
redis-connection-url here have to stay identical.
{{- end }}
BOTH ITEMS' FIELDS LAND IN BOTH SECRETS. A OnePasswordItem materializes every
field of the item it names, so with one shared item the Valkey's Secret also
carries redis-connection-url and key-prefix, and this chart's redis Secret
also carries auth-conf. Untidy and harmless — nothing mounts a field it does
not reference. It is mentioned so it does not get "cleaned up".
IT IS CONFIGURED AS A QUEUE, and that is a decision: persistence on, eviction
policy "noeviction". PAPERLESS_REDIS is the Celery broker, so its contents are
work that must not vanish — "allkeys-lru" would evict across the whole
keyspace and a backlog of waiting tasks is exactly what LRU reads as cold.
The price: the same instance also serves the Django cache, so when it fills,
writes are REFUSED rather than old keys dropped — new tasks included. The
answer is to give it more memory (valkey.valkey.resources.requests.memory),
never to switch the policy. values.yaml argues this in full.
SCALEDOWN DOES NOT REACH IT. scaleDown: true scales paperless to zero and
leaves the Valkey running, which is the right way round for a queue: the
backlog stays where it is.
{{- end }}
THE FIRST START MIGRATES, AND THE STARTUP PROBE IS THE CLOCK
Every start runs the database migrations before the server answers, and the
first start after an upgrade to 3.x also rebuilds the search index from
scratch (Whoosh → Tantivy). The startup probe grants
{{ $startup.failureThreshold }} x {{ $startup.periodSeconds }}s = {{ mul $startup.periodSeconds $startup.failureThreshold }}s before the kubelet restarts the container — and a
restart lands in the middle of a migration. On a large archive, raise
paperless.startupProbe.failureThreshold BEFORE the app-version jump, not
after the crash loop has started.
Migrations are one-way. "helm rollback" puts the old image back on a database
the new one has already rewritten. Back up before bumping the app version,
and back up both halves — the metadata lives in Postgres, the documents on
the PVC.
HOW DOCUMENTS GET IN
Everything in /usr/src/paperless/consume is picked up by the consumer. That
directory is its own volume, {{ .Release.Name }}-{{ .Chart.Name }}-consume-volume-claim, and its size is
NOT paperless.files.storage: the claim is hardcoded to 1Gi (ReadWriteMany)
in the template, and both PVCs are hardcoded to storage class "longhorn".
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
CronJob {{ .Release.Name }}-{{ .Chart.Name }}-consume-cronjob, schedule "{{ .Values.smbConnection.cronJob }}", mounts
//{{ .Values.smbConnection.server }} and runs, once per firing:
find /mnt/smb -maxdepth 1 -name "*.pdf" → mv into the consume volume
Read that literally. Anything in a SUBDIRECTORY of the share is never
touched, and anything that is not *.pdf — an image, an .eml, a .PDF in
capitals — stays on the share forever with nothing reporting it. It is a
move, not a copy: once the job has run, the share no longer holds the file
and the only copy is on the consume volume.
One thing to know before you edit that schedule: it is rendered into the
manifest unquoted, so a schedule that STARTS with "*" ("*/15 * * * *")
aborts the render with a YAML parse error on this template — YAML reads the
leading * as an alias. Quoting it in your values file does not help, the
quotes are gone by then. Use an equivalent that starts with a digit
("5,20,35,50 * * * *"); a "*" anywhere but in first position is fine.
The job has NO probes (the documented exception to the chart conventions),
and it cannot fail usefully either: with nothing to move it exits 0, which
is indistinguishable from a successful run. Judge it by what arrives, not
by the Job's status:
kubectl -n {{ .Release.Namespace }} get jobs --sort-by=.metadata.creationTimestamp
kubectl -n {{ .Release.Namespace }} logs job/<name-of-the-last-one>
The share is reached through the smb.csi.k8s.io driver, which this chart
does not install. The PersistentVolume {{ .Release.Name }}-{{ .Chart.Name }}-smb-pv is CLUSTER-scoped
with reclaim policy Retain and its volumeHandle is derived from
smbConnection.server alone — two releases pointing at the same server
collide on that handle, and a Retained PV outlives helm uninstall and
blocks the next install of the same name until it is deleted by hand.
{{- else }}
smbConnection.enabled is false, so nothing fills that directory on its own —
the web UI is the only way in. To hand a file over directly:
kubectl -n {{ .Release.Namespace }} cp <file.pdf> {{ $pod }}:/usr/src/paperless/consume/
{{- end }}
WHAT A GREEN POD DOES NOT PROVE
One container runs the web server and the Celery worker and scheduler side
by side under s6-overlay, and all three probes only ask the web server for
"/". A worker that died, a consumer that is not watching and a broken Redis
connection all leave the pod Ready and the rollout green. The honest check is
a document going in and coming out the other side, plus:
kubectl -n {{ .Release.Namespace }} logs {{ $pod }} | grep -i -e error -e celery
A read-only root filesystem is part of that picture too: only /tmp and /run
are writable. Anything the app would install at runtime — an extra tesseract
language pack, for instance — cannot be written, no matter which variable
asks for it.
OCR AND BARCODES AS THIS RELEASE HAS THEM
language "{{ .Values.paperless.ocr.languages }}" · mode {{ .Values.paperless.ocr.mode }} · archive {{ .Values.paperless.ocr.archiveFileGeneration }} · output {{ .Values.paperless.ocr.output_type }} · rotate {{ .Values.paperless.ocr.rotate_pages }}
paperless.ocr.languages sets PAPERLESS_OCR_LANGUAGE — which language to use.
The chart does not set the plural PAPERLESS_OCR_LANGUAGES that makes the
image fetch further packages at start, and with the read-only rootfs above it
could not work anyway: a language the image does not already carry needs a
different image, not a different value.
In 3.x the OCR mode values "skip" and "skip_noarchive" no longer exist —
"auto" replaces them, and archive generation is a separate setting.
barcodes: {{ if $barcodes.enabled }}enabled, separator "{{ $barcodes.barcodeString }}", split pages {{ if $barcodes.retainBarcodePage }}retained{{ else }}discarded{{ end }}, ASN {{ if $barcodes.asn.enabled }}on{{ else }}off{{ end }}{{ else }}disabled{{ end }}
A childless "barcodes:" key in a values file is YAML null and means "chart
defaults apply" here (issue #61) — it does NOT switch barcodes off. Deleting
the sub-keys gets you the defaults back; only barcodes.enabled: false
disables it.
{{- if .Values.paperless.files.deleteDuplicates }}
paperless.files.deleteDuplicates is on: a document that matches one already
in the archive is DELETED on consume instead of being kept. That is the 2.x
behaviour, which 3.0 dropped as a default.
{{- end }}
{{- if .Values.paperless.files.tikaGotenberg.enabled }}
TIKA AND GOTENBERG — THE ENDPOINTS CARRY NO SCHEME
tika http://{{ .Values.paperless.files.tikaGotenberg.tikaEndpoint }}
gotenberg http://{{ .Values.paperless.files.tikaGotenberg.gotenbergEndpoint }}
The chart prefixes "http://" itself, so these two values are bare host:port.
A value written with a scheme renders as http://http://… and every Office
document fails to convert while everything else keeps working. Neither
service is part of this chart or checked at startup.
{{- end }}
{{- if .Values.oidc.enabled }}
OIDC IS ON, AND IT IS PKCE-ONLY
Register this redirect URI at the provider:
https://{{ .Values.ingress.domain }}/accounts/oidc/{{ .Values.oidc.provider.id }}/login/callback/
The chart enables PKCE and configures NO client secret — the client has to be
registered as one that can complete the flow without one. Nothing about OIDC
is exercised before someone actually signs in, so a wrong discovery URL,
client id or redirect URI surfaces as a failed login on a perfectly healthy
pod.
{{- if not .Values.oidc.provider.tokenAuthMethod }}
oidc.provider.tokenAuthMethod is unset. Since the allauth update in 3.0 some
providers need it spelled out (client_secret_basic); the symptom is a login
that dies at the callback with invalid_client.
{{- end }}
{{- if or .Values.oidc.autoLoginWithProvider .Values.oidc.disableRegularLogin }}
{{ if .Values.oidc.autoLoginWithProvider }}autoLoginWithProvider{{ end }}{{ if and .Values.oidc.autoLoginWithProvider .Values.oidc.disableRegularLogin }} and {{ end }}{{ if .Values.oidc.disableRegularLogin }}disableRegularLogin{{ end }} — the app's own login form is
bypassed or gone. Before you rely on that, make sure at least one local
superuser still has a usable password and check that Django's admin login at
/admin/ still lets that account in; it is the only way back when the provider
is unreachable.
{{- end }}
{{- end }}
{{- if or $pre $post }}
paperless.scripts IS SET AND DOES NOTHING
{{ len $pre }} pre- and {{ len $post }} post-consumption script(s) are configured. The
ConfigMap that would carry them is disabled in this chart ({{ "{{- if false }}" }} at the
top of the template), no volume mounts it, and neither
PAPERLESS_PRE_CONSUME_SCRIPT nor PAPERLESS_POST_CONSUME_SCRIPT is set on the
container. These values render no object and change no behaviour.
{{- end }}
{{- if gt (int $replicas) 1 }}
paperless.replicas IS {{ $replicas }} — EXPECT ONE POD TO WORK AND THE REST TO WAIT
The main volume is a plain ReadWriteOnce PVC shared by the whole
StatefulSet, not a volumeClaimTemplate, so the second pod stays Pending on
"Multi-Attach error for volume" unless the storage class is genuinely RWX —
and where it does start, two consumers watch the same directory and two
schedulers run the same periodic tasks.
{{- end }}
BACKUP IS TWO THINGS AT THE SAME TIME
Postgres holds the metadata, the tags and one row per document; the PVC
{{ .Release.Name }}-{{ .Chart.Name }}-volume-claim holds the files under data/, media/ and export/.
Restoring one without the other gives you an archive full of references to
documents that are not there. Snapshot them together.
Both PVCs are rendered by this chart, so helm uninstall deletes them and the
documents with them unless the storage class reclaim policy says otherwise.
The external database survives that — which makes an accidental uninstall
look recoverable while the files are already gone.
{{- if .Values.paperless.env }}
paperless.env adds {{ len .Values.paperless.env }} variable(s), rendered after the ones the chart
sets itself, so they win on a name the chart also sets.
{{- end }}