Compare commits
25
Commits
262776d18d
..
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
95f3e8c1a1
|
||
|
|
1894e7d465
|
||
|
|
530227405c
|
||
|
|
1ef23e9ce9
|
||
|
|
ec9e64187b
|
||
|
|
b617068b16
|
||
|
|
b31a18918c
|
||
|
|
e3f6256244
|
||
|
|
1fd6c56c2e
|
||
|
|
be3e2cdd47
|
||
|
|
8233617f57
|
||
|
|
73c2ec704f
|
||
|
|
28a0230ef0
|
||
|
|
96c23b7912
|
||
|
|
e1adcef71f
|
||
|
|
6bde72192f
|
||
|
|
ee9ae8a724
|
||
|
|
de995d0f53
|
||
|
|
813c923070
|
||
|
|
77b978d669
|
||
|
|
d3ef3729f8
|
||
|
|
31d37c9767
|
||
|
|
36bcfd3b11
|
||
|
|
1001de620a
|
||
|
|
c9edbb1750
|
No files matched your search
@@ -303,6 +303,62 @@ jobs:
|
||||
- name: "Check every rendered scalar that must be a string"
|
||||
run: ci/run-yaml-scalar-render-test.sh
|
||||
|
||||
networkpolicy:
|
||||
name: "NetworkPolicy"
|
||||
runs-on: ubuntu-latest
|
||||
# The sixth job that ignores the changed-chart matrix and the fifth that runs
|
||||
# over *every* chart (Gitea #5), for the same reason as the render tests
|
||||
# above: the mistake arrives by copy into a chart whose own diff nobody reads
|
||||
# for it - and since #5 this convention is in all 29 installable charts, so
|
||||
# there is a lot of copy.
|
||||
#
|
||||
# What it asserts, on every NetworkPolicy a chart renders, against the pod
|
||||
# specs, probes and Services of the SAME render: the podSelector really
|
||||
# matches a pod; every ingress port is a containerPort of those pods; no
|
||||
# ingress rule allows every source by accident; and every port a NETWORK
|
||||
# probe addresses is either left unrestricted or comes with
|
||||
# networkPolicy.probeSources and the consequence written into NOTES.txt.
|
||||
# Plus two guards of its own: a chart that renders NO policy fails, and a
|
||||
# rendered "#" comment fails.
|
||||
#
|
||||
# And one assertion that spans TWO charts (Gitea #136), the only one here
|
||||
# that does: where a chart dials the Service of another chart of this
|
||||
# repository, its EGRESS rule must contain that chart's POD ports. kube-proxy
|
||||
# does the ClusterIP's destination NAT before the policy is evaluated, so a
|
||||
# rule naming the SERVICE port matches nothing wherever port and targetPort
|
||||
# differ - paperless-ngx shipped exactly that and lost Tika and Gotenberg in
|
||||
# production on 2026-10-15. The pairs are an explicit table in the script,
|
||||
# because no render can discover which Service another chart dials, and the
|
||||
# row is checked with the feature gate on AND off.
|
||||
#
|
||||
# Every one of those failures is SILENT. The API server accepts a policy
|
||||
# whose selector matches nothing - it then sits in the namespace, is listed
|
||||
# by kubectl, reads as a boundary and filters exactly nothing - just as
|
||||
# readily as it accepts one naming a NodePort number, which matches no
|
||||
# traffic at all because the policy is evaluated at the pod's interface
|
||||
# after kube-proxy has already translated the port. Neither is a render
|
||||
# error and neither denies anything, so neither the build nor a rollout can
|
||||
# see it.
|
||||
#
|
||||
# It does NOT replace the install-test, which is the real net under this
|
||||
# convention: that one proves ENFORCEMENT on a live k3s with its policy
|
||||
# controller running, and it is what makes "all charts at once, default on"
|
||||
# defensible. This job is the cheap half, and it covers the two charts the
|
||||
# install-test cannot reach at all - satisfactory and template-chart, both
|
||||
# in ci/excluded-charts.txt.
|
||||
#
|
||||
# No cluster and no Trivy; a few seconds for the whole repository, depends
|
||||
# on no other job. The YAML is parsed by Helm through ci/yaml2json, because
|
||||
# the runners have neither pyyaml nor yq and a hand-written parser could read
|
||||
# nothing and report nothing - see the script's header.
|
||||
steps:
|
||||
- name: "Checkout Repository"
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
|
||||
- name: "Install Helm"
|
||||
uses: azure/setup-helm@9bc31f4ebc9c6b171d7bfbaa5d006ae7abdb4310 # v5
|
||||
- name: "Check every rendered NetworkPolicy against the render it belongs to"
|
||||
run: ci/run-networkpolicy-test.sh
|
||||
|
||||
trivy-config:
|
||||
name: "Trivy config ${{ matrix.chart }}"
|
||||
needs: detect-changed-charts
|
||||
|
||||
@@ -116,6 +116,7 @@ The binding style guide for all current and future charts lives in **README.md (
|
||||
- Every container offers an additive `env` block rendered through `tpl` with `value`, `secretKeyRef`, and `configMapKeyRef` forms.
|
||||
- Hardening: `automountServiceAccountToken: false`, non-root, `readOnlyRootFilesystem: true`, caps dropped, `allowPrivilegeEscalation: false`; contexts values-configurable (`securityContext.pod` / `securityContext.container`); writable paths as emptyDirs; image-forced deviations MUST be documented with a comment in the chart's `values.yaml`.
|
||||
- Probes: liveness/readiness/startup on every workload (exception: paperless consume CronJob), values-configurable with calibrated defaults.
|
||||
- **Every chart renders a `NetworkPolicy`, `networkPolicy.enabled` defaults to `true`** (#5); adding one to an existing chart is a **major**. Values: `enabled`, `allowedNamespaces`, `probeSources`, `ingressController`, `egress.extraPorts` — and only the ones that actually reach a rule, because a value that does nothing reads as a control. Each port falls in one of four classes and the class decides the rule: a port a **network** probe addresses stays open (`no from`) until `probeSources` is set, because the kubelet probes from the worker node's IP and no chart can know it; a NodePort-published port stays open (the source is already masqueraded); anything else is restricted to the namespace, `allowedNamespaces` and — for HTTP — `ingressController`; a replica-to-replica bus gets a bare `podSelector`. **`exec` probes are not network probes** (no packet, so the port can be restricted — `valkey`, `minecraft-server`). **`allowedNamespaces` is never shipped pre-filled** — a chart must not bake in an assumption about this cluster's namespace layout, so restrictive is the default and filling it is the deployment adaptation (which is why a sweep produces release-side one-liners: that is the procedure, not a defect list). **A policy applies to traffic that came through a Service** — a Service is only destination NAT and the policy acts at the pod interface; what changes is the *source address*, preserved for pod→ClusterIP→pod (this is why the `ingressController` rule works) and masqueraded to a node for NodePort traffic. **And the whole convention depends on one setting it cannot check: Traefik must not run with `hostNetwork`** — measured, its pods have real pod IPs in `10.42.0.0/16`; on host networking they stop being selectable as pods and every web chart goes dark at once while every pod stays `Ready`. **Pod ports, never NodePorts.** Never `from: []`. Reasoning in Go template comments, never `#` (those ship to the cluster), and such a comment must not spell out its own closing delimiter. Egress is by **port, never destination** — Canal has no FQDN rule and Calico-specific objects are out of scope — so most dependency ports are the *standard* ones and a dependency elsewhere is blocked; `policyTypes` names only what there is something to restrict (`valkey`, `homeassistant`, `satisfactory` are Ingress-only, each argued in its own file). `ci/run-networkpolicy-test.sh` is the gate. Full rules: README, "NetworkPolicies".
|
||||
- Resources: requests as values defaults; limits auto-computed by the `_helpers.tpl` helper (`limitFactor` default 3; no CPU limits unless set explicitly).
|
||||
- Replicas per workload (explicit `0` allowed) plus a chart-global `scaleDown` flag that overrides them.
|
||||
- `icon:` mandatory in every `Chart.yaml`; `helm lint --strict` without findings; CI fixtures under `ci/<chart>/` or a justified exclusion.
|
||||
|
||||
@@ -220,6 +220,35 @@ Three things to know before touching it:
|
||||
|
||||
Measured locally: **30 charts, 408 scalars verified, 0 failed**, no cluster. The fail path was exercised rather than assumed, in all three of its shapes, against a throwaway copy of the chart as it stands on `main`: the unquoted schedule aborted the render with `yaml: line 6: did not find expected alphabetic or numeric character` and the test reported it; with only the schedule quoted, the star-valued `env` entry aborted the render on the StatefulSet instead; and with only the bool-looking value left — a render that **succeeds** — the type assertion produced a `FAIL` naming the variable, the container and the exact API-server message. **Seven charts still render their `env` block bare** (`matrix-synapse`, `minecraft-router`, `minecraft-server`, `rallly`, `satisfactory`, `teamspeak-server`, and `paperless-ngx` until #11); the test is green for them only because their fixtures set no hostile `env` value, and the overlay is what makes the difference between covered and merely green.
|
||||
|
||||
### NetworkPolicy render test (all charts, every PR)
|
||||
|
||||
`ci/run-networkpolicy-test.sh [chart …]` (no argument = all charts) renders every chart with the same fixtures the install-test uses and holds **every `NetworkPolicy` it renders against the pod specs, probes and Services of the same render**. Introduced with Gitea #5, which put a policy into all 29 installable charts at once with `networkPolicy.enabled: true` as the default — 29 objects whose every failure mode is silent, because the API server accepts a policy that filters **nothing** exactly as readily as one that filters **everything**.
|
||||
|
||||
| Assertion | What goes wrong without it | Who notices today |
|
||||
|---|---|---|
|
||||
| the `podSelector` matches a pod spec of the same render | the object sits in the namespace, is listed by `kubectl`, reads as a boundary and filters nothing at all — usually because a label was renamed in the workload template, a different file and a different diff | nobody, ever: nothing is denied, so there is no symptom to trace |
|
||||
| every **ingress** port is a `containerPort` of the selected pods | a NodePort number where a pod port belongs. The policy is evaluated at the pod's interface, *after* kube-proxy translated the port, so `30025` matches nothing while looking strict — and being the only rule for that port, it blocks every inbound connection instead | nobody in CI (see below), and in production as a service that went mute |
|
||||
| no ingress rule allows every source by accident | `from: []` allows everything, identically to having no `from` at all, while reading in a diff and in `kubectl` output as a restriction — the one mistake in this class that makes a policy *weaker* while looking *stricter* | nobody |
|
||||
| every port a **network** probe addresses is either unrestricted, or the chart offers `networkPolicy.probeSources` **and** says in `NOTES.txt` what a wrong CIDR costs | the kubelet probes from the IP of the worker node running the pod, which no chart can know. A restricted probe port without that address drops every probe: the pod never becomes `Ready`, the rollout times out, and the symptom reads as a broken application | the install-test, in production's CNI — **but not in CI**, see below |
|
||||
| **cross-chart egress**: where a chart dials another chart *of this repository*, its egress rule must contain the **pod** ports behind that chart's Services (#136) | an egress rule naming the **Service** port. kube-proxy does the ClusterIP's destination NAT *before* the policy is evaluated at the pod's interface, so the policy sees `podIP:targetPort` and the rule matches nothing wherever `port` and `targetPort` differ | nobody: the symptom is a **timeout**, not `connection refused`, and no error mentions a NetworkPolicy — `paperless-ngx` 14.0.0 shipped it and cost an outage on 2026-10-15 |
|
||||
|
||||
Egress ports are otherwise **deliberately not** held against the pod's `containerPort`s: an egress port is a port on the *destination*, and that comparison would fail every chart that reaches a database.
|
||||
|
||||
**The one exception is the fifth row, and it is the only assertion here that needs two charts.** For a database, a cache or the web the destination is in no render this repository has — but it *is* in a render when one chart dials the Service of another, and `paperless-ngx` → `apache-tika`, `gotenberg` is the single place in the repository where that happens (checked for #136: the three other charts naming `port: 80` in a policy are aiming at the **internet**, where there is no DNAT and 80 is the real port). So the pairs live in an explicit table (`EGRESS_PEER_ROWS`) rather than being discovered — a chart cannot know which Service another chart dials, because the address is a value or a 1Password field — and a row naming a chart that no longer exists **fails** instead of being skipped. Each row is checked on **two** renders: with the feature gate **on** the containment must hold, and with it **off** the requirement must not apply *and* those ports must be gone, so a gated rule cannot quietly become one that permits what the release cannot use.
|
||||
|
||||
Two guards beyond the four, both earned rather than designed. **A chart that renders no policy at all fails** — that is how this issue decayed in the first place: `garage` (#81) and `keycloak` (#83) were both created *after* #5 was filed and both arrived without a policy, `keycloak` with its unauthenticated management surface on 9000. And **a `#` comment inside a rendered policy fails**, because a `#` comment is part of the *object*: it travels into the cluster, shows up in `helm get manifest` and `kubectl get -o yaml`, and lands in every release diff. Reasoning belongs in Go template comments, which render nothing. Both precedent charts failed that check when it was first run, which is what it is for.
|
||||
|
||||
Four things to know before touching it:
|
||||
|
||||
- **Assertion 3 is stricter than it first reads, deliberately.** A *missing* `from` is the documented open form and both precedent charts use it on purpose, so banning it outright was not an option. It is accepted only where the render itself justifies being open: every port of the rule is addressed by a network probe, or is published by a `NodePort` Service in the same render. Anything else is an allow-all nobody chose.
|
||||
- **`exec` probes are not network probes**, and that distinction carries real weight rather than being a technicality. An `exec` probe runs inside the container through the kubelet's runtime and puts no packet on the network, so a chart whose probes are all `exec` can restrict its port by source with **no `probeSources` at all** — which is why `valkey` and `minecraft-server` have the tightest policies in the repository and every web app has a looser one.
|
||||
- **Subchart documents are skipped by the comment assertion**, for a structural reason and not a lenient one: a dependency is fetched from the Helm registry rather than from the copy in this repo, so the policy `paperless-ngx` and `stalwart` bundle is whatever `valkey` version is *published*, and nothing in the parent chart can change its rendered comments. The subchart's own PR is where it is caught, because this test runs over `valkey` too.
|
||||
- **Anti-vacuum guard**, as in the tests above: `ci/networkpolicy/<chart>.yaml` is a render-only overlay applied **last**, whose job is to render the **source-restricted probe rule** — a branch no chart's own defaults ever reach, and the one containing the expensive mistake (a `namespaceSelector` and a `podSelector` written as two list entries instead of one would be an OR, opening the port to every pod in `kube-system`). A chart that *has* an overlay and still renders no restricted **probe** rule fails. That counter is specifically the probe rule and not "any restricted rule", because `keycloak` restricts two rules in its own defaults and would have satisfied a looser guard while the branch went unrendered.
|
||||
|
||||
Measured locally: **30 charts, 210 assertions held, 0 failed**, no cluster, ~15 seconds. All twelve fail paths were exercised rather than assumed — and one earned its keep immediately: the `probeSources` check was a substring test, so a chart whose key had been **deleted** while the long comment above it still discussed the value passed it. It now looks for the key. The cross-chart assertion added two of those 210, and its own six fail paths were executed the same way: a required port removed from the rule, a wrong number in its place, a peer chart renamed away, the policy's name no longer following the `<release>-<chart>-<kind>` convention, the peers rendering no Service at all (which would make the requirement empty, and is treated as a failure because an empty requirement reads exactly like a satisfied one), and the gated rule made unconditional — which is the failure path of the *gate-off* half, since with the gate off and the rule properly gated the assertion must stay silent.
|
||||
|
||||
**What this test does not and cannot cover, named so the gap is not mistaken for coverage:** that traffic still flows. No ingress controller runs in the install-test cluster, so the path from Traefik to a pod is proven nowhere in this pipeline — and, measured on the PR for #5, **k3s exempts the kubelet's probe traffic from policy**, so a blocked probe path does *not* turn the install-test red either (`cyberchef` became `Ready` in 69s with its probe port restricted to an address no probe can come from). What the install-test *does* prove is enforcement of everything the application itself needs: with `outline`'s DNS egress rule removed, its pod never became `Ready` and the job failed after 5m59s. So the net under this convention is real, but it is an **egress** net — which raises the stakes for assertion 2, since a wrong ingress port is caught mechanically here or not at all.
|
||||
|
||||
### Install-test (PR pipeline stage 2)
|
||||
|
||||
For every chart a PR changes, `ci/run-install-test.sh <chart>` runs against a throwaway k3d cluster: it applies the stub `OnePasswordItem` CRD plus the chart's fixtures, `helm install`s the chart with its CI values, and waits for all Deployments/StatefulSets to roll out (per-chart timeout). Since probes and security hardening are active on all workloads, "Ready" means the app actually answers. On failure the job dumps pod descriptions, events and container logs.
|
||||
@@ -638,3 +667,71 @@ One more trap, and it is the reason `stalwart` gates its subchart on `valkeySubc
|
||||
Two implementation notes that cost time otherwise: a values key containing a dash is unreachable as `.Values.oauth2-proxy` (that parses as a subtraction) and needs `index .Values "oauth2-proxy"`, while `condition:` in `Chart.yaml` splits on dots only and needs no escaping. And inside a subchart `.Chart.Name` is the **subchart's** name — a value templated into it (`config.configFile` in this case) must spell the parent chart out literally; only `.Release.Name` is shared.
|
||||
|
||||
Charts that need no dependency still have none, and `charts/` stays empty for all of them. `template-chart` remains dependency-free: the scaffold should not carry a `dependencies:` block a new chart has to remember to delete.
|
||||
|
||||
### 15. NetworkPolicies (#5)
|
||||
|
||||
**Every chart renders a `NetworkPolicy`, and `networkPolicy.enabled` defaults to `true`.** Reference implementation: `template-chart/templates/xxx.networkpolicy.yaml`. The default is the decision the whole convention rests on — a policy that ships switched off is reached only when somebody remembers to switch it on, and then the issue is closed while nothing is filtered. Adding one to an existing chart is therefore a **major** bump.
|
||||
|
||||
**What the object is: a ceiling on reachability, not an authentication layer.** Three limits are real and worth having, and for most charts here the first two are where all of the value sits:
|
||||
|
||||
1. **Only the declared ports are reachable at all.** Whatever else the process binds — a debug listener, a management interface the image opens by default, a port that appears in the next app version — is blocked without anyone having to notice it exists.
|
||||
2. **Egress is capped by port**, so a compromised pod cannot open arbitrary outbound connections.
|
||||
3. **Ingress is capped by source for every port no network probe touches.**
|
||||
|
||||
#### The four port classes, and why the class decides the rule
|
||||
|
||||
Every port of a workload falls into one of four, and this is the part to get right before writing anything:
|
||||
|
||||
| Class | Rule | Why |
|
||||
|---|---|---|
|
||||
| **probe path** — a port a *network* probe addresses | **no `from`** by default; restricted once `networkPolicy.probeSources` is set | the kubelet probes from the IP of the **worker node running the pod**, an address no chart can know. A guessed CIDR that misses it drops every probe: the pod never becomes `Ready`, the rollout times out, and the symptom reads as a broken application rather than as a policy |
|
||||
| **public** — published by a `NodePort` Service | **no `from`** | the senders are on the internet and, after NodePort masquerading, the source address is a cluster node anyway. A source selector could only ever be a list of node IPs — a restriction in appearance and a maintenance trap in fact |
|
||||
| **closed** — no probe, not published outside | own namespace + `allowedNamespaces` (+ the ingress controller where the chart routes HTTP there) | this is the only class that yields a *real* inbound restriction, and the charts that have one are the ones whose probes use a *different* port: `keycloak`'s 8080, `garage`'s s3 and web, `minecraft-server`'s RCON, `teamspeak-server`'s query interface |
|
||||
| **self** — a cluster bus between a release's own replicas | `podSelector` only, no `namespaceSelector` | the narrowest rule the object can express: "these labels, in this namespace". `keycloak`'s jgroups, `garage`'s rpc. Note that `policyTypes: Egress` means the **outbound** side needs its own rule, or the bus is open one way and the cluster never forms while every node looks healthy |
|
||||
|
||||
**`exec` probes are not in the probe class**, and the distinction is load-bearing rather than pedantic: an `exec` probe runs inside the container through the kubelet's runtime and puts no packet on the network, so there is no kubelet traffic to accommodate. That is the entire reason `valkey` and `minecraft-server` have the tightest policies in the repository — every port restricted by source, no `probeSources` value at all — and every HTTP-probed web app has a looser one.
|
||||
|
||||
#### Values
|
||||
|
||||
`networkPolicy.enabled`, `.allowedNamespaces`, `.probeSources`, `.ingressController`, `.egress.extraPorts` — and a chart ships **only the ones that reach a rule**. A chart may add a **named** egress switch where a port depends on something the values cannot see: `paperless-ngx`' `.egress.mailImport` opens IMAPS `993`, off by default, because its mail accounts are rows in its own database and no value says whether a release fetches mail. The bar for one of those: it names what it opens, and it is **not** a second switch for a port some *other* value already decides — that is why the Tika/Gotenberg rule stayed gated on `paperless.files.tikaGotenberg.enabled` and got no policy switch of its own. Two values that can drift apart re-arm the outage the rule was fixed for. A value that silently does nothing is worse than one that is absent, because it reads as a control: `samba` and `satisfactory` carry `enabled` alone (every inbound rule is open to any source), and `teamspeak-server` has `allowedNamespaces` but no `probeSources`.
|
||||
|
||||
**No chart ships `allowedNamespaces` pre-filled, ever.** A chart that named `mc-router`, or `paperless-jk`, or `stalwart` in its defaults would be baking in an assumption about *this* cluster's namespace layout — which is exactly the kind of claim a chart cannot keep true. So the default is the empty list and the chart is **restrictive**; filling it is the **deployment adaptation**, made where the namespace layout is actually visible. That is why a sweep like this produces a list of release-side one-liners: those are the expected procedure, not a defect list, and the breaking-change major on each chart is what announces them.
|
||||
|
||||
`ingressController` is the one exception to that, and only because it names a **cluster component** rather than a tenant: its default is measured below, and it is still overridable.
|
||||
|
||||
`ingressController` is a separate value with two keys rather than a line in `allowedNamespaces` for one reason: **its two selectors render as one `from` entry, which is an AND** — those pods in that namespace. Written as two list entries they would be an OR, and putting `kube-system` into `allowedNamespaces` instead would open the port to every pod in the cluster's own namespace. Its default is **measured, not assumed**: `ingress-nginx` is gone from this cluster, the only `IngressClass` is `traefik`, and the controller is the DaemonSet `rke2-traefik` in `kube-system` — which also serves the Gateway API here, so one source covers the Ingress and the HTTPRoute path alike. `ingress.className` says nothing about it: a class names an implementation, not the pods the traffic comes from.
|
||||
|
||||
#### What these policies do not do — and it belongs in every chart, not just here
|
||||
|
||||
- **Egress is coarse: by port, never by destination.** A `NetworkPolicy` matches `ipBlock` CIDRs and pod/namespace selectors and **never hostnames**, so "only to the database host" is not expressible at all. This cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN rule; Calico's `GlobalNetworkSet` could express one but would bind every chart to Calico — the same argument that kept implementation-specific objects out of the Gateway-API sweep (#114) — so it is **not used**. This is a limit of the object, and each chart names what it costs *that* chart.
|
||||
- **Most dependency ports are the standard ones, not the configured ones.** Databases, caches and OIDC issuers arrive as connection URLs or as fields inside 1Password items the charts never parse, so a chart cannot know where its dependency listens and cannot validate a guess. A dependency somewhere else is **blocked**, and `networkPolicy.egress.extraPorts` is the escape hatch. The exceptions are the two charts that hold their ports as values and therefore derive them: `keycloak` (`keycloak.db.port`) and `stalwart` (`dataStore.postgres.port`, `externalServices.*.port`); `minecraft-router` derives its backend ports from its own routing table the same way.
|
||||
- **The probed port stays open inside the cluster by default.** For a single-port web app that means the policy is a port and egress ceiling, not pod-level isolation — say so in the chart rather than letting the object imply otherwise.
|
||||
- **A subchart's pods are not covered.** The policy selects this chart's workload by label; a subchart renders its own pods with its own labels. `ytdlp-web-player`'s oauth2-proxy is the sharpest case — with the proxy on, the pod that actually faces the Ingress is unrestricted in both directions, and an upstream chart is consumed as it comes (section 14). `paperless-ngx`' `valkey` is the opposite: it brings its own, tighter policy. Name which case a chart is in.
|
||||
- **And a policy is only a boundary where the CNI enforces one.** Unenforced, the API server still accepts it and nothing is filtered, so everything reads as configured. Verify by connecting from an unrelated namespace, not by reading the value.
|
||||
|
||||
#### Where the convention says "Ingress only"
|
||||
|
||||
`policyTypes` names only what there is something to restrict. `valkey` established it for a workload that opens **no** outbound connection: an egress rule would constrain nothing while making the object look stricter than it is. Three charts now invoke the same rule in the other direction, for outbound traffic nobody can enumerate — and each argues it in its own file rather than inheriting a blanket excuse:
|
||||
|
||||
- **`homeassistant`**: outbound traffic is the union of every integration an operator enables (mDNS and SSDP discovery, MQTT, a Zigbee or Z-Wave bridge on whatever port its firmware chose, ESPHome, printers, speakers, inverters, cloud APIs, NTP). A cap would protect little — the devices sit on the node's own LAN — and would break integrations one at a time, months apart, each looking like a flaky device.
|
||||
- **`satisfactory`**: Steam's content delivery is not a pinnable port set, *and* this is the one chart with no install-test at all (`ci/excluded-charts.txt`), so an egress cap here would be the only one in the sweep with no empirical check behind it, on the chart whose correct port set is least knowable.
|
||||
- **`gotenberg`** goes the other way and is worth contrasting: it *keeps* a DNS-only cap deliberately, because it drives a headless Chromium and 3000 is its probe port — so an egress rule for 80/443 would turn a service the whole cluster can POST to into an SSRF pivot. The price is that HTML conversion silently loses remote assets, which is written into the chart because nothing will alert on it.
|
||||
|
||||
#### Mechanics
|
||||
|
||||
- **Pod ports, never NodePorts.** A `NetworkPolicy` is evaluated at the pod's network interface, *after* kube-proxy has translated a NodePort to the `targetPort`. `30025` where the pod listens on `25` matches nothing: accepted, strict-looking, and blocking every inbound connection instead. The render test asserts this mechanically against the selected pod spec's `containerPort`s.
|
||||
- **And pod ports, never Service ports — in `egress` too (#136).** The same destination NAT runs on the way *out*: kube-proxy rewrites a ClusterIP's address and port **before** the egress policy is evaluated, so the policy sees `podIP:targetPort` and never `clusterIP:port`. An egress rule therefore names the **pod** port of its destination, and a Service port only ever matches by coincidence — wherever `port` and `targetPort` are the same number, which is the case for `5432`, `6379`, `993` and `443` and is why this mistake stayed invisible until a chart dialled a Service that forwards `80` to `9998`. It was argued the other way in `paperless-ngx` (*"an egress rule names the port on the destination as the client dials it, and the client dials the Service"*), shipped, and cost an outage. **The tell is the symptom:** a dropped packet runs into a **timeout**, a missing listener answers `connection refused` — so a timeout where the service demonstrably exists is a policy question, and no Kubernetes error will say so. For a destination *outside* the cluster there is no NAT in the path and the port dialled is the port to name; the deciding question is the DNAT, not the direction.
|
||||
- **Protocol as well as number.** `teamspeak-server`'s voice port is UDP and `satisfactory`'s game port is both — a TCP-only rule on either is accepted, looks complete, and drops the traffic that actually arrives.
|
||||
- **`kubernetes.io/metadata.name`** is set by Kubernetes itself on every namespace (≥ 1.21), so namespace selectors need no labelling work on namespaces the chart does not own — and get no typo protection either.
|
||||
- **Never `from: []`.** It allows everything, identically to having no key, while reading as a restriction. Write no `from` where open is meant and say so in a template comment.
|
||||
- **Reasoning goes in Go template comments, not `#` comments.** A `#` comment is part of the rendered object: it travels into the cluster, appears in `helm get manifest` and `kubectl get -o yaml`, and lands in every release diff. The render test fails on a rendered `#`. One second-order trap, found while writing the reference implementation: prose inside a template comment must not spell out the comment's own closing delimiter, or the parser ends the comment early and the rest is emitted as manifest content — the render then fails with `did not find expected node content`, pointing at the template and not at the sentence.
|
||||
- **A conditional `containerPort` needs a conditional rule.** `minecraft-server`'s RCON port is rendered only when `server.rcon.enabled` is true; a rule without the same gate names a port the pod does not declare, and the render test rejects it.
|
||||
- **A policy applies to traffic that arrived through a Service, and that is why the `ingressController` rule works at all.** A `NetworkPolicy` is evaluated at the pod's network interface and a Service is only destination NAT, so going through a ClusterIP does not exempt anything. What the Service *does* change is the **source address**: pod → ClusterIP → pod **preserves** it, which is what lets a `podSelector` match the Traefik pod or a `namespaceSelector` match a consumer's namespace. **And what it also changes is the destination port, which is the half #136 was paid for:** "a Service is only destination NAT" is exactly why an *egress* rule has to name the pod port — the same sentence, finished in the other direction. It was written here before the wrong rule was written there; the information was present and the conclusion was missing, which is the sort of gap no check catches. Traffic from outside through a `NodePort` with the default `externalTrafficPolicy: Cluster` is **masqueraded to a node**, which is why those rules cannot be restricted by source at all and are left open instead (`stalwart`'s template carries that second half; the first half is the load-bearing one).
|
||||
|
||||
#### The one cluster setting this convention depends on and does not control
|
||||
|
||||
**Traefik must not run with `hostNetwork`.** Measured on 2026-10-14: the `rke2-traefik` DaemonSet has no `hostNetwork`, and its pods carry real pod IPs (`10.42.3.120`, `10.42.4.94`, `10.42.0.187` — the pod CIDR is `10.42.0.0/16`, nodes are on entirely different addresses). **Only because of that does a `podSelector` match it**, and the `ingressController` value is built on exactly that.
|
||||
|
||||
If Traefik were ever switched to host networking, its pods would share the node's network namespace, they would no longer be selectable as pods, the `ingressController` entry would match nothing — and **every web chart in this repository would go dark at once**, in the restricted configuration. The policies would still be accepted, still read as correct, and deny all web traffic.
|
||||
|
||||
This is a dependency on a cluster setting this repository does not own, in the same class as the `--enable-certificate-owner-ref` case from #126: nothing here can detect it, and nothing here can fail usefully on it. It is written down in both places someone would look — here, and in the header of `template-chart/templates/xxx.networkpolicy.yaml` — so that whoever changes the ingress controller's networking finds the consequence attached to the thing they are changing. The symptom to recognise: every chart's web traffic stops at once while every pod stays `Ready`, because the probe path does not go through the controller.
|
||||
@@ -5,5 +5,5 @@ icon: https://www.apache.org/logos/res/tika/default.png
|
||||
|
||||
type: application
|
||||
|
||||
version: 10.0.2+up3.3.1.0.full
|
||||
version: 11.0.0+up3.3.1.0.full
|
||||
appVersion: "3.3.1.0-full"
|
||||
@@ -58,3 +58,57 @@ THE JVM ONLY GETS A QUARTER OF THE MEMORY LIMIT
|
||||
cheap regardless; the heap is what matters for parsers that have to build a
|
||||
whole document in memory, and for OCR.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 9998 only. Outbound: DNS{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }} plus TCP {{ join ", " . }}{{ end }}{{ end }} — Tika is handed documents and
|
||||
fetches nothing.
|
||||
|
||||
THIS CHART HAS NO INGRESS AND ITS CONSUMERS ARE OTHER PODS. While
|
||||
networkPolicy.probeSources is empty the 9998 rule has no source selector, so
|
||||
any pod in the cluster — including a paperless-ngx release in another
|
||||
namespace — reaches it. Narrowing probeSources restricts that rule, and the
|
||||
consumers' namespaces must then be listed in networkPolicy.allowedNamespaces
|
||||
in the same change, or document extraction stops with a connection error on
|
||||
the paperless side and nothing at all on this one.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,149 @@
|
||||
{{- /*
|
||||
NetworkPolicy for apache-tika (Gitea #5).
|
||||
|
||||
Apache Tika here is a cluster-internal service: the chart creates no Ingress at
|
||||
all, and its only consumers are other pods - paperless-ngx points at
|
||||
http://<service>.<namespace>.svc.cluster.local for text extraction.
|
||||
|
||||
THAT MAKES THE SOURCE QUESTION THE INTERESTING ONE, AND IT HAS AN AWKWARD
|
||||
ANSWER. 9998 is the port all three probes address, so it cannot be restricted
|
||||
by source without the worker node's IP - and this chart's consumers live in
|
||||
OTHER namespaces (paperless-cmk, paperless-jk, paperless-tb in this cluster).
|
||||
So an operator who narrows probeSources has to list those namespaces in
|
||||
allowedNamespaces in the same breath, or every document extraction stops. That
|
||||
is written into values.yaml and NOTES.txt rather than left to be discovered.
|
||||
|
||||
Egress is DNS only. Tika extracts text from documents it is handed; it fetches
|
||||
nothing, and a text extractor that can reach the internet is a worse thing to
|
||||
hand an untrusted document to.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there is something real to restrict: Tika extracts
|
||||
text from documents it is handed and fetches nothing of its own, so DNS is the
|
||||
only rule. A text extractor that can reach the internet is a worse thing to
|
||||
hand an untrusted document to.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
9998 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the one all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 9998
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
NO ingress controller is added here, because this chart renders no Ingress: its
|
||||
consumers are other pods, and they have to be named in allowedNamespaces.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,43 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -70,3 +70,63 @@ tika:
|
||||
cpu: 0.1
|
||||
memory: 512Mi
|
||||
ephemeralStorage: 10Mi
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 9998 only - the single port this pod
|
||||
# declares - and outbound nothing but DNS. Tika is handed documents and
|
||||
# fetches nothing, which is a property worth keeping: a text extractor that
|
||||
# can reach the internet is a worse thing to hand an untrusted document to.
|
||||
#
|
||||
# WHAT IT DOES NOT DO, and read this before narrowing anything: 9998 is the
|
||||
# probe port, so it is NOT restricted by source in the default. This chart
|
||||
# has no Ingress and its consumers are other pods - paperless-ngx releases,
|
||||
# which in this cluster live in their own namespaces. The moment probeSources
|
||||
# is set, the 9998 rule is restricted and those namespaces must be in
|
||||
# allowedNamespaces, or every document extraction stops.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 9998, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Nothing is needed here for Tika itself. Add a port only if a parser is
|
||||
# configured that fetches remote resources - and consider whether that is
|
||||
# wanted at all.
|
||||
extraPorts: []
|
||||
+1
-1
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/alam00000/bentopdf/main/public/images/fa
|
||||
|
||||
type: application
|
||||
|
||||
version: 1.1.0+up2.8.8
|
||||
version: 2.0.0+up2.8.8
|
||||
appVersion: "2.8.8"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -153,3 +153,49 @@ bentopdf.env HAS NO EFFECT ON THE APP — AND THREE VALUES BREAK THE POD
|
||||
starts. Using them means also setting
|
||||
securityContext.container.readOnlyRootFilesystem: false.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 8080 only. Outbound: DNS{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }} plus TCP {{ join ", " . }}{{ end }}{{ end }} — the documents are
|
||||
processed in the browser, so the pod needs nothing more.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,157 @@
|
||||
{{- /*
|
||||
NetworkPolicy for bentopdf (Gitea #5).
|
||||
|
||||
BentoPDF is a browser-side PDF tool: nginx serves the bundle, the documents are
|
||||
processed in the visitor's browser, and the chart has no secrets and no
|
||||
volumes. So the pod holds nothing and calls nothing, and the policy is as tight
|
||||
as this object gets - inbound 8080, outbound DNS.
|
||||
|
||||
The ingress direction is not restricted by source in the default, because 8080
|
||||
is the port all three probes address. See the rule below.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because the restriction is close to total and therefore worth
|
||||
having: a static file server needs name resolution and nothing else, so DNS is
|
||||
the only rule.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
8080 - the image's EXPOSE and the port its nginx.conf listens on, the one the
|
||||
Service targets, and the one all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8080
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress and the
|
||||
HTTPRoute both go dark the moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -299,3 +299,79 @@ httpRoute:
|
||||
# chart has no OnePasswordItem, and why the checksum limitation for
|
||||
# operator-filled secrets does not apply here: the only thing mounted is the
|
||||
# ConfigMap, and that one is covered by checksum/config.
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 8080 only, outbound nothing but DNS.
|
||||
# BentoPDF processes documents in the visitor's browser and the chart has no
|
||||
# secrets and no volumes, so the pod has no reason to open an outbound
|
||||
# connection at all.
|
||||
#
|
||||
# WHAT IT DOES NOT DO: the 8080 rule is not restricted by source in the
|
||||
# default, because 8080 is the probe port - see probeSources. So this is a
|
||||
# port and egress ceiling, not pod-level isolation. And it is only a boundary
|
||||
# where the CNI enforces policies.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 8080, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Nothing is needed here for BentoPDF itself.
|
||||
extraPorts: []
|
||||
+1
-1
@@ -21,7 +21,7 @@ type: application
|
||||
# duplicated here. The short version: eight tag shapes, six of them things
|
||||
# nobody should pin, and plain `docker` versioning excludes all six - so that
|
||||
# block deliberately carries NO versioningTemplate.
|
||||
version: 1.1.0+up1.12.0
|
||||
version: 2.0.0+up1.12.0
|
||||
appVersion: "1.12.0"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -327,3 +327,56 @@ WHAT THIS CHART DOES NOT RENDER
|
||||
platform objects and live in cluster-config; this chart renders an
|
||||
HTTPRoute at most, which is the part that looks the same on every Gateway
|
||||
implementation.
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 3000 only. Outbound: DNS and TCP 443 — the JMAP server and the
|
||||
OIDC provider{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
CHECK THE JMAP PORT. 443 is where a published JMAP endpoint lives. A
|
||||
bulwark.jmapServerUrl pointing at Stalwart's in-cluster HTTP port (8080), or
|
||||
at anything else, is BLOCKED by this policy — and because Bulwark's probes
|
||||
only test its own port, the pod becomes Ready and then serves an empty,
|
||||
broken webmail with nothing in the events to explain it. Add the real port to
|
||||
networkPolicy.egress.extraPorts.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,175 @@
|
||||
{{- /*
|
||||
NetworkPolicy for bulwark (Gitea #5).
|
||||
|
||||
Bulwark is a JMAP webmail CLIENT: it holds no mail, has no database, no cache
|
||||
and no broker. Everything it shows lives on a Stalwart server reached over
|
||||
bulwark.jmapServerUrl, and that single outbound dependency is what shapes the
|
||||
egress rules.
|
||||
|
||||
AND IT IS THE ONE CHART WHERE THE EGRESS CAP CAN FAIL QUIETLY. Bulwark's probes
|
||||
address its own HTTP port and say nothing about whether the JMAP server is
|
||||
reachable - so a release whose JMAP URL sits on a port this policy does not
|
||||
allow comes up Ready and then shows an empty, broken webmail. 443 is allowed
|
||||
because that is where a published JMAP endpoint lives; a URL pointing straight
|
||||
at Stalwart's in-cluster HTTP port (8080) is blocked and needs
|
||||
networkPolicy.egress.extraPorts. That asymmetry is in values.yaml and NOTES.txt
|
||||
because nothing else will report it.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := .Values.ingress.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the StatefulSet's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there IS something to restrict: this workload
|
||||
needs DNS and the ports named below, and nothing else. A chart whose
|
||||
workload opens no outbound connection of its own must NOT list Egress -
|
||||
valkey is the example - because a rule that constrains nothing makes the
|
||||
object look stricter than it is.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
3000 - the only port this pod declares, targeted by both the regular and the
|
||||
headless Service, and the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 3000
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress goes dark the
|
||||
moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
Outbound HTTPS. This covers both of Bulwark's outbound dependencies: the JMAP
|
||||
server named by bulwark.jmapServerUrl, and the OAuth/OIDC provider. Ports only
|
||||
- the URLs are hostnames, which this object cannot match. A JMAP server reached
|
||||
on its in-cluster HTTP port instead (Stalwart's 8080) is NOT covered and needs
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"description": "true renders the StatefulSet with replicas: 0 and takes precedence over bulwark.replicas. The PVC, Secrets, Service and Ingress stay in place.",
|
||||
"type": "boolean"
|
||||
|
||||
@@ -816,3 +816,85 @@ httpRoute:
|
||||
# unregistered origin is rejected at the provider, which says nothing about
|
||||
# this chart.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 3000 only, and outbound DNS plus TCP 443 -
|
||||
# which covers Bulwark's two outbound dependencies, the JMAP server
|
||||
# (bulwark.jmapServerUrl) and the OIDC provider.
|
||||
#
|
||||
# WHAT IT DOES NOT DO, and this is the one to check before upgrading: 443 is
|
||||
# where a PUBLISHED JMAP endpoint lives. If jmapServerUrl points straight at
|
||||
# Stalwart's in-cluster HTTP port (8080) or anywhere else, that traffic is
|
||||
# BLOCKED - and Bulwark's probes only test its own port, so the pod comes up
|
||||
# Ready and serves a broken, empty webmail with nothing in the events to say
|
||||
# why. Put the real port in egress.extraPorts below.
|
||||
#
|
||||
# Inbound 3000 is not restricted by source in the default (probe port), and a
|
||||
# policy is only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 3000, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# 8080 is the entry this chart needs most often: a jmapServerUrl pointing at
|
||||
# Stalwart's in-cluster HTTP Service rather than at its published HTTPS
|
||||
# name.
|
||||
extraPorts: []
|
||||
@@ -5,7 +5,7 @@ name: calibre-web-automated
|
||||
description: A Helm chart to deploy calibere-web-automated
|
||||
icon: https://raw.githubusercontent.com/crocodilestick/Calibre-Web-Automated/main/README_images/cwa-logo-round-dark.png
|
||||
|
||||
version: 7.1.0+upv4.0.6
|
||||
version: 8.0.0+upv4.0.6
|
||||
appVersion: v4.0.6
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -217,3 +217,51 @@ TIME, AND THE ENVIRONMENT THE CHART ALREADY OCCUPIES
|
||||
variable to disable WAL: NETWORK_SHARE_MODE=true" — so a library claim backed
|
||||
by NFS or SMB, which is what cwa.storageClass decides, runs into exactly the
|
||||
locking problems that setting exists to avoid.
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 8083 only. Outbound: DNS and TCP 443 (metadata providers){{ with .Values.networkPolicy.egress }}{{ with .extraPorts }},
|
||||
plus TCP {{ join ", " . }}{{ end }}{{ end }}. A send-to-Kindle or e-mail setup needs its SMTP port
|
||||
(587 or 465) in networkPolicy.egress.extraPorts — without it the send fails
|
||||
silently from this side.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,168 @@
|
||||
{{- /*
|
||||
NetworkPolicy for calibre-web-automated (Gitea #5).
|
||||
|
||||
Calibre-Web-Automated keeps its library on a PVC and has no database and no
|
||||
cache of its own, so the only outbound traffic that matters is metadata
|
||||
lookups: cover art and book details fetched from public providers over HTTPS.
|
||||
|
||||
That is why 443 is allowed and nothing else is. The failure mode if it were
|
||||
not: metadata lookups return nothing, which looks like a provider being down
|
||||
rather than like a policy - so the rule is here rather than left to
|
||||
extraPorts.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := .Values.ingress.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the StatefulSet's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there IS something to restrict: this workload
|
||||
needs DNS and the ports named below, and nothing else. A chart whose
|
||||
workload opens no outbound connection of its own must NOT list Egress -
|
||||
valkey is the example - because a rule that constrains nothing makes the
|
||||
object look stricter than it is.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
8083 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8083
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress goes dark the
|
||||
moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
Outbound HTTPS for metadata providers (covers, book details). To any
|
||||
destination, because the providers are hostnames and this object matches CIDRs
|
||||
and selectors only.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -189,3 +189,78 @@ httpRoute:
|
||||
# CWA is told its address by nothing, so a second name needs no second value
|
||||
# changed with it.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 8083 only, and outbound DNS plus TCP 443
|
||||
# for metadata lookups (covers and book details from public providers).
|
||||
#
|
||||
# WHAT IT DOES NOT DO: 443 goes to any destination - the providers are
|
||||
# hostnames, which this object cannot match. Inbound 8083 is not restricted
|
||||
# by source in the default, because it is the probe port. And a policy is
|
||||
# only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 8083, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Add a port only for a metadata provider or an e-mail/send-to-Kindle setup
|
||||
# that does not use 443 - SMTP submission would be 587 or 465.
|
||||
extraPorts: []
|
||||
@@ -160,3 +160,15 @@ ingress:
|
||||
# also the annotation this chart's NOTES.txt tells operators to add, so the
|
||||
# fixture is the shape a real install has.
|
||||
nginx.ingress.kubernetes.io/proxy-body-size: "25m"
|
||||
|
||||
# The egress cap of this chart's NetworkPolicy (Gitea #5) allows the STANDARD
|
||||
# ports of its dependencies. The CI JMAP server does not: fixtures.yaml serves it over plain HTTP on 8080 rather than over HTTPS on 443 - which is exactly the asymmetry values.yaml warns about for an in-cluster jmapServerUrl.
|
||||
#
|
||||
# So this is not a workaround for the test: it is the chart's documented escape
|
||||
# hatch, used for exactly the case values.yaml names. The fixtures are the one
|
||||
# place in the repository where that case is exercised, and removing this entry
|
||||
# shows what the cap costs a dependency on a non-standard port.
|
||||
networkPolicy:
|
||||
egress:
|
||||
extraPorts:
|
||||
- 8080
|
||||
@@ -0,0 +1,32 @@
|
||||
# Overlay for the NetworkPolicy render test (Gitea #5), applied last.
|
||||
#
|
||||
# Two code paths this chart's own defaults never reach, and both are held
|
||||
# against the four assertions on every pull request rather than checked once by
|
||||
# hand:
|
||||
#
|
||||
# 1. networkPolicy.egress.remoteAssets: true - the named switch that lets
|
||||
# Chromium fetch over 80/443. Its default is OFF, so the rule it renders
|
||||
# existed in no render at all. It is an EGRESS rule, which is exactly why it
|
||||
# is worth asserting: assertions 2 and 3 look at INGRESS rules, so a mistake
|
||||
# on the egress side has no mechanical check except that the render still
|
||||
# parses and the policy still holds together.
|
||||
#
|
||||
# 2. The source-restricted probe rule, which only appears once probeSources is
|
||||
# non-empty - the same branch ci/networkpolicy/template-chart.yaml exists
|
||||
# for, and the one the overlay guard demands of any chart that offers the
|
||||
# value. It carries the expensive mistake: a namespaceSelector and a
|
||||
# podSelector written as two list entries instead of one would be an OR.
|
||||
#
|
||||
# Note what this overlay does NOT do: it changes no release. gotenberg's
|
||||
# install-test uses ci/gotenberg/test-values.yaml, which this file does not
|
||||
# touch - the policy installed there keeps the restrictive default, because
|
||||
# that is the default the convention ships.
|
||||
networkPolicy:
|
||||
egress:
|
||||
remoteAssets: true
|
||||
# Not the real node addresses of any cluster; documentation CIDRs
|
||||
# (RFC 5737 TEST-NET-1) so nobody can mistake these for something to copy.
|
||||
probeSources:
|
||||
- 192.0.2.11/32
|
||||
allowedNamespaces:
|
||||
- paperless-jk
|
||||
@@ -0,0 +1,31 @@
|
||||
# Overlay for the NetworkPolicy render test (Gitea #5), applied last.
|
||||
#
|
||||
# This chart's policy has two branches that its own CI fixture never renders,
|
||||
# and both carry a mistake worth catching mechanically.
|
||||
#
|
||||
# 1. THE NODEPORT BRANCH OF THE GAME-PORT RULE. The rule is OPEN when
|
||||
# server.service.type is NodePort - players arrive from the internet,
|
||||
# already masqueraded - and RESTRICTED to the namespace otherwise. The
|
||||
# install-test fixture uses ClusterIP (as all four releases in this cluster
|
||||
# do), so without this overlay the open branch was rendered NOWHERE: not by
|
||||
# the defaults, not by the fixture, not by lint. It is also the branch where
|
||||
# writing server.service.outwardPort instead of server.port would be the
|
||||
# classic NodePort mistake, and assertion 2 only sees a rule it has been
|
||||
# given.
|
||||
#
|
||||
# 2. THE RCON RULE, which is gated on server.rcon.enabled exactly as the
|
||||
# containerPort is. That pairing was wrong once while this chart was being
|
||||
# written - the rule had no gate, so it named a port the pod does not
|
||||
# declare - and assertion 2 caught it. Switching RCON on here keeps the
|
||||
# PAIR under test rather than just the gate.
|
||||
#
|
||||
# Note why this chart's overlay does NOT have to render a source-restricted
|
||||
# probe rule, which is what the test demands of an overlay elsewhere: all three
|
||||
# of this chart's probes are exec probes, so it has no probe rule at all and
|
||||
# offers no networkPolicy.probeSources. The guard is conditional on that value
|
||||
# for this reason.
|
||||
server:
|
||||
service:
|
||||
type: NodePort
|
||||
rcon:
|
||||
enabled: true
|
||||
@@ -0,0 +1,30 @@
|
||||
# Overlay for the NetworkPolicy render test (Gitea #5), applied last.
|
||||
#
|
||||
# Its only job is to render a code path the chart's own defaults never reach:
|
||||
# the SOURCE-RESTRICTED ingress rule. With probeSources empty - the default, and
|
||||
# deliberately so - the probe port's rule carries no "from" at all, so the whole
|
||||
# restricted branch of the template, the one containing the ingress-controller
|
||||
# AND, the namespace list and the ipBlock peers, is never rendered and never
|
||||
# checked. That branch is also the one with the expensive mistake in it: a
|
||||
# namespaceSelector and a podSelector written as two list entries instead of one
|
||||
# would be an OR, and would open the port to every pod in kube-system.
|
||||
#
|
||||
# ci/run-networkpolicy-test.sh FAILS a chart that has an overlay here and still
|
||||
# renders no restricted rule. That guard is the point: without it the overlay
|
||||
# could silently stop reaching the branch, and the test would stay green over a
|
||||
# code path nobody entered.
|
||||
#
|
||||
# template-chart carries it rather than a real chart because it is installed
|
||||
# nowhere (ci/excluded-charts.txt) - so the restricted form is exercised on
|
||||
# every pull request with no release depending on these values.
|
||||
networkPolicy:
|
||||
# Not the real node addresses of any cluster; a documentation CIDR
|
||||
# (RFC 5737 TEST-NET-1) so nobody can mistake these for something to copy.
|
||||
probeSources:
|
||||
- 192.0.2.11/32
|
||||
- 192.0.2.12/32
|
||||
allowedNamespaces:
|
||||
- monitoring
|
||||
egress:
|
||||
extraPorts:
|
||||
- 5432
|
||||
@@ -8,3 +8,20 @@ ingress:
|
||||
# clusterIssuer is strictly required (no default); the Ingress just has to
|
||||
# apply - there is no cert-manager in the CI cluster.
|
||||
clusterIssuer: ci
|
||||
|
||||
# The egress cap of the chart's NetworkPolicy (Gitea #5) allows 443 for the
|
||||
# OIDC provider, because that is where an OIDC provider normally listens. The
|
||||
# CI one does not: fixtures.yaml runs dex at
|
||||
# http://dex.default.svc.cluster.local:5556/dex, and Outline fetches the
|
||||
# issuer's discovery document at boot.
|
||||
#
|
||||
# So this entry is not a workaround for the test - it is the chart's documented
|
||||
# escape hatch, used for exactly the case values.yaml names, and the fixture is
|
||||
# the one place in the repository where that case is actually exercised. Remove
|
||||
# it and the install-test shows what the cap does to a dependency on a
|
||||
# non-standard port, which is the risk this convention carries into every
|
||||
# release.
|
||||
networkPolicy:
|
||||
egress:
|
||||
extraPorts:
|
||||
- 5556
|
||||
@@ -7,3 +7,15 @@ secrets:
|
||||
ingress:
|
||||
clusterIssuer: ci
|
||||
domain: patchmon.ci.local
|
||||
|
||||
# The egress cap of this chart's NetworkPolicy (Gitea #5) allows the STANDARD
|
||||
# ports of its dependencies. The CI OIDC provider does not: fixtures.yaml runs dex on 5556 rather than on 443.
|
||||
#
|
||||
# So this is not a workaround for the test: it is the chart's documented escape
|
||||
# hatch, used for exactly the case values.yaml names. The fixtures are the one
|
||||
# place in the repository where that case is exercised, and removing this entry
|
||||
# shows what the cap costs a dependency on a non-standard port.
|
||||
networkPolicy:
|
||||
egress:
|
||||
extraPorts:
|
||||
- 5556
|
||||
@@ -10,3 +10,15 @@ rallly:
|
||||
ingress:
|
||||
clusterIssuer: ci
|
||||
domain: rallly.ci.local
|
||||
|
||||
# The egress cap of this chart's NetworkPolicy (Gitea #5) allows the STANDARD
|
||||
# ports of its dependencies. The CI OIDC provider does not: fixtures.yaml runs dex on 5556 rather than on 443.
|
||||
#
|
||||
# So this is not a workaround for the test: it is the chart's documented escape
|
||||
# hatch, used for exactly the case values.yaml names. The fixtures are the one
|
||||
# place in the repository where that case is exercised, and removing this entry
|
||||
# shows what the cap costs a dependency on a non-standard port.
|
||||
networkPolicy:
|
||||
egress:
|
||||
extraPorts:
|
||||
- 5556
|
||||
Executable
+1265
File diff suppressed because it is too large.
Load diff
@@ -7,3 +7,15 @@ ingress:
|
||||
# clusterIssuer is strictly required (no default); the Ingress just has to
|
||||
# apply - there is no cert-manager in the CI cluster.
|
||||
clusterIssuer: ci
|
||||
|
||||
# The egress cap of this chart's NetworkPolicy (Gitea #5) allows the STANDARD
|
||||
# ports of its dependencies. The CI OIDC provider does not: fixtures.yaml runs dex on 5556 rather than on 443 - and this application has no login path besides OIDC.
|
||||
#
|
||||
# So this is not a workaround for the test: it is the chart's documented escape
|
||||
# hatch, used for exactly the case values.yaml names. The fixtures are the one
|
||||
# place in the repository where that case is exercised, and removing this entry
|
||||
# shows what the cap costs a dependency on a non-standard port.
|
||||
networkPolicy:
|
||||
egress:
|
||||
extraPorts:
|
||||
- 5556
|
||||
@@ -6,3 +6,15 @@ secrets:
|
||||
ingress:
|
||||
clusterIssuer: ci
|
||||
domain: vv.ci.local
|
||||
|
||||
# The egress cap of this chart's NetworkPolicy (Gitea #5) allows the STANDARD
|
||||
# ports of its dependencies. The CI OIDC provider does not: fixtures.yaml runs dex on 5556 rather than on 443.
|
||||
#
|
||||
# So this is not a workaround for the test: it is the chart's documented escape
|
||||
# hatch, used for exactly the case values.yaml names. The fixtures are the one
|
||||
# place in the repository where that case is exercised, and removing this entry
|
||||
# shows what the cap costs a dependency on a non-standard port.
|
||||
networkPolicy:
|
||||
egress:
|
||||
extraPorts:
|
||||
- 5556
|
||||
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/gchq/CyberChef/master/src/web/static/ima
|
||||
|
||||
type: application
|
||||
|
||||
version: 9.1.0+up11.4.0
|
||||
version: 10.0.0+up11.4.0
|
||||
appVersion: "11.4.0"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -108,3 +108,49 @@ cyberchef.env HAS NO EFFECT ON THE APP
|
||||
files, but the served CyberChef bundle is static and reads none of them —
|
||||
configuration has to happen in the browser.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 8080 only, the single port this pod declares. Outbound: DNS{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}
|
||||
plus TCP {{ join ", " . }}{{ end }}{{ end }} — a static file server needs nothing more.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,167 @@
|
||||
{{- /*
|
||||
NetworkPolicy for cyberchef (Gitea #5).
|
||||
|
||||
CyberChef is a static web app: nginx serves files, the recipes run in the
|
||||
visitor's browser, and the pod holds no state and talks to nothing. That makes
|
||||
this the simplest policy in the repository and a good one to read first.
|
||||
|
||||
What it is worth here is almost entirely the two CEILINGS rather than any
|
||||
source restriction: only 8080 is reachable, and outbound traffic is capped at
|
||||
DNS. The pod has no reason to open a single outbound connection - it serves
|
||||
static files - so the egress cap is as tight as the object allows. Were this
|
||||
image ever to gain a second listener, or were the container ever compromised,
|
||||
neither could be reached or could reach out.
|
||||
|
||||
The ingress direction is NOT restricted by source in the default, and that is
|
||||
not an oversight: 8080 is the port all three probes address. See the probe note
|
||||
on the rule below.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there IS something to restrict, and here the
|
||||
restriction is close to total: a static file server needs name resolution and
|
||||
nothing else, so DNS is the only rule. That is as tight as this object can be
|
||||
made without breaking the pod.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
8080 - the only port this pod declares, the one the Service targets, and the
|
||||
one all three probes address. It is therefore the probe path, and the shape
|
||||
below is the whole reason networkPolicy.probeSources exists.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8080
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress (and the
|
||||
HTTPRoute - the same Traefik serves both here) goes dark the moment this list
|
||||
is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -125,3 +125,81 @@ httpRoute:
|
||||
# is how a migration from the Ingress runs: the HTTPRoute takes a second
|
||||
# hostname while the Ingress keeps ingress.domain.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 8080 only - the single port this pod
|
||||
# declares - and outbound nothing but DNS. CyberChef is a static web app
|
||||
# whose recipes run in the browser, so the pod has no reason to open an
|
||||
# outbound connection at all, which makes the egress cap unusually tight.
|
||||
#
|
||||
# WHAT IT DOES NOT DO: the 8080 rule is NOT restricted by source in the
|
||||
# default, because 8080 is the port all three probes address - see
|
||||
# probeSources below. So this policy is a port and egress ceiling, not
|
||||
# pod-level isolation. And it is only a boundary where the CNI enforces
|
||||
# policies; unenforced, it is accepted and filters nothing.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 8080, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Nothing is needed here for CyberChef itself. Add 443 only if something
|
||||
# is put in front of the pod that has to call out.
|
||||
extraPorts: []
|
||||
@@ -8,7 +8,7 @@ description: A Helm chart to deploy a Wireguard-tunneled media automation stack
|
||||
|
||||
type: application
|
||||
|
||||
version: 4.0.0+up1.0.0
|
||||
version: 5.0.0+up1.0.0
|
||||
# The chart's own version marker, freely chosen and tied to no upstream. The
|
||||
# stack bundles ten independently versioned projects (nine of them on by
|
||||
# default), so there is no single "app version" to track here.
|
||||
|
||||
@@ -418,3 +418,72 @@ MORE THAN ONE REPLICA IS NOT MEANINGFUL
|
||||
config volumes, all of them fighting over the same media claims and the same
|
||||
VPN credentials.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: the nine probed ports — gluetun's health server (9999) and the eight
|
||||
web interfaces (8080, 9696, 8191, 7878, 8989, 5055, 6767, 5007) — plus
|
||||
mediathekarr's newznab port (5008), which is RESTRICTED by source because
|
||||
nothing probes it and its only consumer is Prowlarr in this same pod.
|
||||
Outbound: DNS, UDP 51820 (the WireGuard tunnel) and TCP 443 (gluetun's
|
||||
server-list API){{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THE TEN CONTAINERS TALK TO EACH OTHER OVER LOCALHOST, so none of that traffic
|
||||
is governed by this object at all — they share a network namespace. And
|
||||
because that namespace belongs to gluetun, everything the *arr containers
|
||||
send is encapsulated into the tunnel before it leaves the pod: indexer and
|
||||
tracker traffic needs no egress rule of its own.
|
||||
|
||||
IF THIS POD WILL NOT BECOME READY, SUSPECT THE TUNNEL RULE. gluetun's health
|
||||
server answers 200 only while the tunnel is up, and all three of its probes
|
||||
address it, so a blocked UDP 51820 shows up as a pod that never goes Ready
|
||||
rather than as a network error. 51820 is WireGuard's and Mullvad's standard
|
||||
port; Mullvad also offers 53, 123, 500 and 4500 for obfuscation, and a
|
||||
release on one of those has to widen the rule in the template —
|
||||
networkPolicy.egress.extraPorts is TCP only.
|
||||
|
||||
AND IF SEERR CANNOT REACH AN IN-CLUSTER SERVICE (Jellyfin, say), two things
|
||||
have to be true, not one: its port in networkPolicy.egress.extraPorts, and
|
||||
gluetun.vpn.firewallOutboundSubnets set — gluetun's own firewall blocks
|
||||
cluster-internal egress before this policy is ever consulted.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,253 @@
|
||||
{{- /*
|
||||
NetworkPolicy for freesailarr (Gitea #5).
|
||||
|
||||
TEN CONTAINERS IN ONE POD, BEHIND A VPN, AND THE POLICY IS SIMPLER THAN THAT
|
||||
SOUNDS - for one reason worth stating first: the containers talk to each other
|
||||
over LOCALHOST. They share a network namespace, so none of that traffic ever
|
||||
reaches a network interface and NO NetworkPolicy has anything to say about it.
|
||||
Prowlarr reaching Radarr, Recyclarr reaching Sonarr, every one of those hops is
|
||||
invisible here. What this policy governs is only what enters or leaves the pod.
|
||||
|
||||
INBOUND is the eight published web interfaces plus gluetun's health server, and
|
||||
almost all of them are probe ports - the kubelet opens an HTTP connection to
|
||||
each container's own interface - so they are one rule on the probe path. The
|
||||
newznab port of mediathekarr is the exception: nothing probes it, and its only
|
||||
consumer is Prowlarr in this same pod over localhost, so it is restricted by
|
||||
source and that costs nothing.
|
||||
|
||||
OUTBOUND IS WHERE THIS CHART IS UNLIKE EVERY OTHER ONE HERE, because the pod's
|
||||
network namespace belongs to gluetun. Every connection the *arr containers make
|
||||
goes into the WireGuard tunnel and leaves the pod as UDP to the VPN endpoint -
|
||||
so a NetworkPolicy sees the OUTER packets and almost nothing else. Three rules
|
||||
cover it: DNS, UDP 51820 for the tunnel itself, and 443 for gluetun's own
|
||||
server-list API. Indexer and tracker traffic needs no rule of its own; it is
|
||||
already inside the tunnel.
|
||||
|
||||
AND THE TUNNEL RULE IS THE ONE THAT CAN BREAK THIS CHART, which is also why it
|
||||
is well covered: gluetun's health server returns 200 only while the tunnel is
|
||||
up, and all three of its probes address it. A blocked UDP 51820 therefore means
|
||||
a pod that never becomes Ready - visibly, in the install-test, which brings up
|
||||
a real tunnel. 51820 is WireGuard's standard port and Mullvad's; Mullvad also
|
||||
offers 53, 123, 500 and 4500 for obfuscation, and a release using one of those
|
||||
needs networkPolicy.egress.extraPorts. Note that extraPorts is TCP only, so an
|
||||
alternative UDP port needs the rule here widened instead - said plainly,
|
||||
because it is a limit of the shared values shape and not an oversight.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the StatefulSet's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed, and for this chart it is unusually meaningful: because the
|
||||
pod's network namespace belongs to gluetun, the only things that leave it are
|
||||
the tunnel, DNS and gluetun's control-plane calls. Everything the applications
|
||||
do is encapsulated. So three narrow rules really do describe the pod's whole
|
||||
outbound surface - which is rare here.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
THE PROBE PATH, nine ports of it. gluetun's health server (9999) plus the eight
|
||||
web interfaces the kubelet probes directly: qBittorrent (8080), Prowlarr
|
||||
(9696), FlareSolverr (8191), Radarr (7878), Sonarr (8989), Seerr (5055), Bazarr
|
||||
(6767) and Mediathekarr (5007). Every one of them is addressed by at least one
|
||||
httpGet probe, so none of them can be restricted by source without the worker
|
||||
node's IP.
|
||||
|
||||
Recyclarr is absent from this list on purpose: it declares no port and its
|
||||
probes are exec probes, so there is nothing to allow.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 9999
|
||||
- protocol: TCP
|
||||
port: 8080
|
||||
- protocol: TCP
|
||||
port: 9696
|
||||
- protocol: TCP
|
||||
port: 8191
|
||||
- protocol: TCP
|
||||
port: 7878
|
||||
- protocol: TCP
|
||||
port: 8989
|
||||
- protocol: TCP
|
||||
port: 5055
|
||||
- protocol: TCP
|
||||
port: 6767
|
||||
- protocol: TCP
|
||||
port: 5007
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule - this chart renders TWO
|
||||
Ingresses, the main one and qBittorrent's, and both go dark the moment this
|
||||
list is filled without it.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
{{- /*
|
||||
MEDIATHEKARR'S NEWZNAB PORT, and the one inbound port here that can be
|
||||
restricted: no probe addresses it. Its only consumer is Prowlarr, which runs in
|
||||
THIS pod and reaches it over localhost - traffic no NetworkPolicy sees at all -
|
||||
so restricting this rule to the release's own namespace plus allowedNamespaces
|
||||
costs nothing and removes a port from the cluster's reach.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 5008
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
THE WIREGUARD TUNNEL, and the rule this chart cannot live without. Everything
|
||||
the *arr containers do leaves the pod inside this tunnel, so blocking it
|
||||
blocks all of them at once - and gluetun's health server, which all three of
|
||||
its probes address, returns 200 only while the tunnel is up. The pod would
|
||||
never become Ready.
|
||||
|
||||
51820 is WireGuard's standard port and Mullvad's. Mullvad also offers 53, 123,
|
||||
500 and 4500 for obfuscation; a release using one of those must widen THIS rule,
|
||||
because networkPolicy.egress.extraPorts is TCP only.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 51820
|
||||
{{- /*
|
||||
Outbound HTTPS, for gluetun's own control-plane traffic: it fetches and caches
|
||||
the provider's server list over the API before the tunnel exists, so this
|
||||
cannot go through the tunnel. Indexer and tracker traffic does NOT need a rule
|
||||
here - it is already inside the tunnel by the time it leaves the pod.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -1330,3 +1330,101 @@ mediathekarr:
|
||||
capabilities:
|
||||
drop:
|
||||
- ALL
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# TEN CONTAINERS IN ONE POD, AND THE FIRST THING TO KNOW: they talk to each
|
||||
# other over LOCALHOST. They share a network namespace, so that traffic never
|
||||
# touches an interface and no NetworkPolicy sees it. This object governs only
|
||||
# what enters or leaves the pod.
|
||||
#
|
||||
# WHAT IT ALLOWS, inbound: the nine probed ports as one rule (gluetun's
|
||||
# health server 9999, plus qBittorrent 8080, Prowlarr 9696, FlareSolverr
|
||||
# 8191, Radarr 7878, Sonarr 8989, Seerr 5055, Bazarr 6767, Mediathekarr
|
||||
# 5007), and mediathekarr's newznab port 5008 RESTRICTED by source - nothing
|
||||
# probes it, and its only consumer is Prowlarr over localhost, so restricting
|
||||
# it costs nothing.
|
||||
#
|
||||
# OUTBOUND, and this chart is unlike every other one here: the pod's network
|
||||
# namespace belongs to gluetun, so everything the *arr containers do is
|
||||
# encapsulated into the WireGuard tunnel before it leaves. Three rules
|
||||
# describe the whole outbound surface - DNS, UDP 51820 for the tunnel, and
|
||||
# 443 for gluetun's server-list API, which cannot go through the tunnel
|
||||
# because it runs before the tunnel exists. Indexer and tracker traffic needs
|
||||
# no rule: it is already inside.
|
||||
#
|
||||
# THE TUNNEL RULE IS THE ONE THAT CAN BREAK THIS CHART, and it is also the
|
||||
# best-covered: gluetun's health server returns 200 only while the tunnel is
|
||||
# up, and all three of its probes address it, so a blocked 51820 means a pod
|
||||
# that never becomes Ready - visibly, and in the install-test, which brings
|
||||
# up a real tunnel. 51820 is WireGuard's and Mullvad's standard port; Mullvad
|
||||
# also offers 53, 123, 500 and 4500 for obfuscation, and a release using one
|
||||
# of those must widen the rule in the TEMPLATE, because egress.extraPorts is
|
||||
# TCP only. That is a limit of the shared values shape, said plainly.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach the nine probed ports (gluetun's health server and the eight web interfaces), which is every inbound port except mediathekarr's newznab port.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# TCP ONLY - an alternative WireGuard UDP port cannot be added here. The
|
||||
# usual entry is an in-cluster service Seerr talks to outside the tunnel
|
||||
# (Jellyfin on 8096), which also needs gluetun.vpn.firewallOutboundSubnets
|
||||
# set, or gluetun's own firewall blocks it before this policy is reached.
|
||||
extraPorts: []
|
||||
+1
-1
@@ -19,7 +19,7 @@ type: application
|
||||
# offer those as "updates", which is why the garage block in renovate.json5
|
||||
# carries a versioningTemplate anchored to ^v<major>.<minor>.<patch>$ - same
|
||||
# shape as the stalwart block, for the same reason.
|
||||
version: 1.1.0+upv2.4.1
|
||||
version: 2.0.0+upv2.4.1
|
||||
appVersion: "v2.4.1"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -204,3 +204,63 @@ TRAPS WORTH KNOWING BEFORE YOU NEED THEM
|
||||
- THE RPC SECRET IS IN THE PROCESS ENVIRONMENT, not in a file. That is
|
||||
forced, not chosen: Garage rejects a secret file with any group bit set,
|
||||
and the kubelet sets one. values.yaml has the mechanism.
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound, and the four ports split three ways:
|
||||
- s3 ({{ $settings.ports.s3 | int64 }}) and web ({{ $settings.ports.web | int64 }}): RESTRICTED BY SOURCE — this namespace,
|
||||
networkPolicy.allowedNamespaces, and the ingress controller.
|
||||
- admin ({{ $settings.ports.admin | int64 }}): open inside the cluster, because all three probes address
|
||||
it. This is the ADMIN API, so read that as a smaller ceiling rather than
|
||||
a closed door; networkPolicy.probeSources closes the rest.
|
||||
- rpc ({{ $settings.ports.rpc | int64 }}): this release's own pods only. It has no Service.
|
||||
Outbound: DNS and TCP {{ $settings.ports.rpc | int64 }} (the cluster bus, outbound as well as in){{ with .Values.networkPolicy.egress }}{{ with .extraPorts }},
|
||||
plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
CHECK YOUR S3 CONSUMERS. Anything in another namespace that talks to this
|
||||
endpoint on its in-cluster Service address — a backup job, a Zipline storing
|
||||
uploads, a Stalwart blob store — is blocked until that namespace is in
|
||||
networkPolicy.allowedNamespaces. Consumers using the published Ingress name
|
||||
arrive through the controller and are already covered. The failure is an
|
||||
application-level error with nothing pointing at this object.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,232 @@
|
||||
{{- /*
|
||||
NetworkPolicy for garage (Gitea #5).
|
||||
|
||||
Garage declares four ports and they split three ways, which makes this the
|
||||
second-clearest illustration of the convention after keycloak:
|
||||
|
||||
s3 (3900) the S3 API. The Ingress points at it and no probe touches it,
|
||||
so it is RESTRICTED by source.
|
||||
web (3902) static website serving, same treatment as s3.
|
||||
admin (3903) the port all three probes address - tcpSocket twice and a
|
||||
httpGet /health - so it stays open inside the cluster. This is
|
||||
also the admin API, which is the uncomfortable part and is
|
||||
named in values.yaml: narrowing it means probeSources.
|
||||
rpc (3901) the node-to-node bus. It has NO Service at all, deliberately
|
||||
(see garage.service.yaml), and it gets the narrowest rule this
|
||||
object can express: the pods this policy itself selects.
|
||||
|
||||
All four numbers are derived from garage.settings, so moving a port in values
|
||||
moves the policy with it.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $settings := fromYaml (include "garage.settings" .) }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the StatefulSet's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed and it is narrow, which is the point: a storage node's only
|
||||
outbound traffic is DNS and its own cluster bus. Not permitted, and named in
|
||||
values.yaml because it is the plausible surprise: outbound HTTPS. Garage does
|
||||
not need it for S3 serving, but a deployment that configures remote replication
|
||||
or an external metrics sink does.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
THE S3 API AND THE STATIC WEB PORT, both genuinely restricted by source,
|
||||
because no probe addresses either of them: this release's own namespace,
|
||||
whatever allowedNamespaces adds, and the ingress controller.
|
||||
|
||||
THE SOURCE LIST IS THE THING TO GET RIGHT HERE. Every consumer of this S3
|
||||
endpoint that lives in another namespace - a backup job, a Zipline using it for
|
||||
uploads, a Stalwart blob store - is a pod in that namespace and is BLOCKED
|
||||
unless the namespace is in allowedNamespaces. Consumers reaching the published
|
||||
Ingress name instead arrive through the controller and are already covered. A
|
||||
blocked S3 consumer fails at the application level, with nothing naming this
|
||||
object.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.s3 | int64 }}
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.web | int64 }}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- /*
|
||||
THE ADMIN PORT, and it is the probe path: liveness and startup open a TCP
|
||||
socket against it and readiness fetches /health from it. So it stays open
|
||||
inside the cluster by default.
|
||||
|
||||
That is worth stating rather than glossing, because this is the ADMIN API: key
|
||||
management and cluster layout live here. The policy caps it at "reachable from
|
||||
inside the cluster", not at "closed", and probeSources is what closes the rest -
|
||||
at the usual price of needing the worker node IPs.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.admin | int64 }}
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
No ingress-controller entry on this rule: nothing should route to the admin API
|
||||
from outside.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
{{- /*
|
||||
THE NODE-TO-NODE RPC BUS, restricted to the pods this policy already selects -
|
||||
a podSelector with no namespaceSelector, which means "these labels, in this
|
||||
namespace".
|
||||
|
||||
This port deliberately has no Service (garage.service.yaml says why: a Service
|
||||
port would advertise a cluster interface that is not one), so this rule is the
|
||||
only description of it anywhere in the chart. The matching egress rule below is
|
||||
what lets a node dial OUT to its peers.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.rpc | int64 }}
|
||||
from:
|
||||
- podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
Outbound RPC to the other nodes of this cluster. Needed as well as the inbound
|
||||
rule: policyTypes lists Egress, so a node dialling its peer is subject to this
|
||||
policy too, and with only the inbound rule the bus would be permitted in one
|
||||
direction - a layout that never converges while every node looks healthy.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.rpc | int64 }}
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"description": "true renders the StatefulSet with replicas: 0 and takes precedence over garage.replicas.",
|
||||
"type": "boolean"
|
||||
|
||||
@@ -501,3 +501,92 @@ httpRoute:
|
||||
# garage.s3.rootDomain - the two still have to be set in step, as they do for
|
||||
# the Ingress.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS, and Garage's four ports split three ways:
|
||||
# - s3 (3900) and web (3902): RESTRICTED BY SOURCE to this namespace,
|
||||
# allowedNamespaces and the ingress controller. No probe touches them,
|
||||
# which is what makes the restriction possible.
|
||||
# - admin (3903): open inside the cluster, because all three probes address
|
||||
# it. This is the ADMIN API - key management and cluster layout - so the
|
||||
# cap is "reachable from inside the cluster", not "closed". probeSources
|
||||
# closes the rest.
|
||||
# - rpc (3901): this release's own pods only. It has no Service at all.
|
||||
# Outbound: DNS and the rpc bus, nothing else.
|
||||
#
|
||||
# THE SOURCE LIST FOR s3 IS THE THING TO GET RIGHT. Every S3 consumer in
|
||||
# ANOTHER namespace - a backup job, a Zipline storing uploads, a Stalwart
|
||||
# blob store - is blocked unless that namespace is in allowedNamespaces.
|
||||
# Consumers that use the published Ingress name arrive through the controller
|
||||
# and are already covered. A blocked consumer fails at the application level,
|
||||
# with nothing naming this object.
|
||||
#
|
||||
# NOT allowed, and the plausible surprise: outbound HTTPS. Garage does not
|
||||
# need it to serve S3, but remote replication or an external metrics sink
|
||||
# does - see egress.extraPorts.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach the admin port (garage.ports.admin, 3903 by default), which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# 443 is the entry to add for remote replication or an external metrics
|
||||
# sink. Nothing is needed for plain S3 serving.
|
||||
extraPorts: []
|
||||
@@ -5,7 +5,7 @@ icon: https://gotenberg.dev/img/logo.png
|
||||
|
||||
type: application
|
||||
|
||||
version: 8.0.3+up8.37.0
|
||||
version: 9.0.0+up8.37.0
|
||||
appVersion: "8.37.0"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -80,3 +80,90 @@ REQUESTS TIME OUT AFTER 30 SECONDS
|
||||
cannot be changed here. This is the ceiling large conversions actually meet:
|
||||
an 18 MB HTML needs about 22 seconds, and a 25 MB one does not finish inside
|
||||
the 30. Callers that need longer must split the document instead.
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 3000 only. Outbound: DNS{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }} plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
{{- /* Null-safe on purpose: networkPolicy.egress may be erased to null (the
|
||||
schema permits it), and a bare .egress.remoteAssets then fails the whole
|
||||
render with "nil pointer evaluating interface {}.remoteAssets" - an
|
||||
error naming this file while the operator's value appears nowhere in it.
|
||||
Same rule as issue #99: an erased block means "the default applies", not
|
||||
a broken render. */}}
|
||||
{{- if (.Values.networkPolicy.egress | default dict).remoteAssets }}
|
||||
REMOTE ASSETS ARE ALLOWED IN THIS RELEASE (networkPolicy.egress.remoteAssets:
|
||||
true), so Chromium may fetch over TCP 80 and 443 to any destination. Know
|
||||
what that opens: this service is reachable from the whole cluster by default
|
||||
(3000 is the probe port), so anything that can POST here can now have
|
||||
Chromium fetch an arbitrary URL — including one inside the cluster. Switch it
|
||||
back off if nothing in this release renders HTML that references remote
|
||||
images.
|
||||
{{- else }}
|
||||
EGRESS IS DNS ONLY HERE, AND IT COSTS SOMETHING SILENTLY. Gotenberg drives a
|
||||
headless Chromium, so an egress rule for 80/443 would turn a service the
|
||||
whole cluster can POST to into a way of fetching arbitrary URLs — which is
|
||||
why the default is off.
|
||||
|
||||
What it costs: in a rendered HTML document, EMBEDDED images are MIME parts
|
||||
inside the file and convert fine, but REMOTE images (<img src="https://...">)
|
||||
are fetched by Chromium at render time and are SILENTLY DROPPED. The PDF is
|
||||
produced and is simply missing them. Nothing fails, nothing is logged here,
|
||||
no probe notices.
|
||||
|
||||
If this release needs them — a paperless-ngx rendering mail bodies that
|
||||
reference remote pictures is the case — set
|
||||
|
||||
networkPolicy:
|
||||
egress:
|
||||
remoteAssets: true
|
||||
|
||||
and not extraPorts: [80, 443]. The named value says why the ports are open;
|
||||
a port list cannot.
|
||||
{{- end }}
|
||||
|
||||
THIS CHART HAS NO INGRESS AND ITS CONSUMERS ARE OTHER PODS. While
|
||||
probeSources is empty the 3000 rule has no source selector; narrowing it
|
||||
means listing the consumers' namespaces in allowedNamespaces in the same
|
||||
change, or every conversion stops.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,195 @@
|
||||
{{- /*
|
||||
NetworkPolicy for gotenberg (Gitea #5).
|
||||
|
||||
Gotenberg here is a cluster-internal service: no Ingress, and its consumers are
|
||||
other pods (paperless-ngx converts mail HTML to PDF through it).
|
||||
|
||||
EGRESS IS DNS ONLY BY DEFAULT, AND THAT IS A DELIBERATE, VISIBLE TRADE rather
|
||||
than an oversight. Gotenberg drives a headless Chromium, so an egress rule for
|
||||
80 and 443 would let anything that can POST to this service fetch arbitrary
|
||||
URLs through it - a textbook SSRF pivot, and the pod is reachable from the
|
||||
whole cluster by default because 3000 is the probe port. Blocking it costs the
|
||||
remote-asset half of HTML conversion: a converted page keeps its EMBEDDED
|
||||
content and loses the images it would have FETCHED, which degrades a PDF rather
|
||||
than failing a pod. The degradation is silent, which is why it is named here, in
|
||||
values.yaml and in NOTES.txt.
|
||||
|
||||
A deployment that needs those images sets networkPolicy.egress.remoteAssets:
|
||||
true - a named switch rather than a line in extraPorts, so the trade is a
|
||||
decision someone made and not a port number nobody can place. Its default is
|
||||
off, because restrictive-by-default is the convention and the deployment is
|
||||
where reality is accommodated. The long form of what it buys, and of the one
|
||||
thing about it that was NOT verified, is on the rule itself.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because this is the chart where the cap matters most: a
|
||||
headless Chromium that can reach the internet turns a service anyone in the
|
||||
cluster can POST to into an SSRF pivot. DNS is the only rule.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
3000 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the one all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 3000
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
NO ingress controller is added here, because this chart renders no Ingress: its
|
||||
consumers are other pods, and they have to be named in allowedNamespaces.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- with $np.egress }}
|
||||
{{- if .remoteAssets }}
|
||||
{{- /*
|
||||
REMOTE ASSETS: the web, on both ports, to any destination. Off by default,
|
||||
and the switch exists because the cost of leaving it off is invisible while
|
||||
the cost of removing it is not.
|
||||
|
||||
WHAT IT BUYS, measured on the live cluster rather than assumed. paperless-ngx
|
||||
splits a mail into two steps with two separate endpoints, both
|
||||
cluster-internal: the .eml goes to TIKA for parsing
|
||||
(PAPERLESS_TIKA_ENDPOINT) and the resulting HTML comes here for rendering
|
||||
(PAPERLESS_TIKA_GOTENBERG_ENDPOINT). Of the images in that HTML:
|
||||
|
||||
- EMBEDDED images are MIME parts INSIDE the file. Neither Tika nor
|
||||
Gotenberg needs the network for them, which is why apache-tika stays
|
||||
DNS-only and why this switch is not needed for a mail that carries its
|
||||
pictures with it.
|
||||
- REMOTE images (<img src="https://..."> in the mail body) are fetched by
|
||||
CHROMIUM, here, at render time. With this switch off they are silently
|
||||
dropped: the PDF is produced, it is just missing them. Nothing fails,
|
||||
nothing is logged by this chart, and no probe notices.
|
||||
|
||||
NOT CHECKED, and not claimed: whether paperless-ngx re-embeds the images
|
||||
Tika extracted before handing the HTML over. If it does not, embedded
|
||||
images would be lost as well - but that would be pre-existing paperless
|
||||
behaviour and not this policy, so do not read the switch as a fix for it.
|
||||
|
||||
WHY IT IS A SWITCH AND NOT THE DEFAULT. Gotenberg drives a headless
|
||||
Chromium and 3000 is its probe port, so the service is reachable from the
|
||||
whole cluster by default. Allowing 80/443 outbound therefore turns anything
|
||||
that can POST here into a way of fetching arbitrary URLs - an SSRF pivot
|
||||
with the cluster's whole internal address space behind it. That argument is
|
||||
unchanged by the switch; the switch only makes the trade a NAMED decision
|
||||
with a default of "no" instead of a line in extraPorts that reads like
|
||||
nothing in particular.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 80
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,47 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"remoteAssets": {
|
||||
"description": "Lets Chromium fetch over TCP 80 and 443 to any destination, for the REMOTE images in a rendered HTML document (<img src=\"https://...\">). Off by default: Gotenberg drives a headless Chromium and 3000 is its probe port, so the service is reachable from the whole cluster, and allowing outbound web access turns anything that can POST here into a way of fetching arbitrary URLs. EMBEDDED images are MIME parts inside the file and need no network at all, which is the case this switch is NOT for. With it off, remote images are silently dropped - the PDF is produced and is simply missing them.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -92,3 +92,100 @@ gotenberg:
|
||||
limits:
|
||||
memory: 3Gi
|
||||
ephemeralStorage: 256Mi
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 3000 only and outbound nothing but DNS.
|
||||
#
|
||||
# THE EGRESS CAP IS THE POINT OF THIS ONE. Gotenberg drives a headless
|
||||
# Chromium, so allowing 80/443 outbound would let anything that can POST to
|
||||
# this service fetch arbitrary URLs through it - and 3000 is the probe port,
|
||||
# so the whole cluster can POST to it by default. The cost is the
|
||||
# remote-asset half of HTML conversion: a converted page keeps its inline
|
||||
# content and silently loses the images it would have FETCHED. That is a
|
||||
# degraded PDF, not a dead pod, which is exactly why it is written down here.
|
||||
# A deployment that needs those images sets egress.remoteAssets: true below -
|
||||
# a named switch, knowingly, rather than a port pair in extraPorts.
|
||||
#
|
||||
# And like every chart here: 3000 is not restricted by source in the default
|
||||
# (probe port), and a policy is only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 3000, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
egress:
|
||||
# REMOTE ASSETS: lets Chromium fetch over TCP 80 and 443, to any
|
||||
# destination. OFF by default, and both halves of that are deliberate.
|
||||
#
|
||||
# WHAT IT BUYS, measured rather than assumed. paperless-ngx splits a mail
|
||||
# into two steps with two separate cluster-internal endpoints: the .eml goes
|
||||
# to TIKA for parsing (PAPERLESS_TIKA_ENDPOINT) and the resulting HTML comes
|
||||
# here for rendering (PAPERLESS_TIKA_GOTENBERG_ENDPOINT). Of the images in
|
||||
# that HTML:
|
||||
# - EMBEDDED images are MIME parts INSIDE the file. Neither Tika nor
|
||||
# Gotenberg needs the network for them - which is why apache-tika stays
|
||||
# DNS-only, and why a mail that carries its pictures with it needs
|
||||
# nothing from this switch.
|
||||
# - REMOTE images (<img src="https://..."> in the body) are fetched by
|
||||
# CHROMIUM, here, at render time. With this off they are SILENTLY
|
||||
# DROPPED: the PDF is produced and is simply missing them. Nothing
|
||||
# fails, nothing is logged by this chart, no probe notices.
|
||||
#
|
||||
# NOT CHECKED, and deliberately not claimed: whether paperless-ngx re-embeds
|
||||
# the images Tika extracted before handing the HTML over. If it does not,
|
||||
# embedded images would be lost as well - but that would be pre-existing
|
||||
# paperless behaviour and not this policy. Do not read this switch as a fix
|
||||
# for it.
|
||||
#
|
||||
# WHY IT IS OFF BY DEFAULT. Gotenberg drives a headless Chromium and 3000 is
|
||||
# its probe port, so the service is reachable from the whole cluster by
|
||||
# default. Allowing 80/443 outbound therefore turns anything that can POST
|
||||
# here into a way of fetching arbitrary URLs - an SSRF pivot with the
|
||||
# cluster's internal address space behind it. Switching this on is a trade,
|
||||
# and it should be one somebody made on purpose.
|
||||
remoteAssets: false
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# Use remoteAssets above rather than putting 80 and 443 here: the named
|
||||
# value says WHY the ports are open, and this list cannot.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Normally empty. Remote assets have their own switch above
|
||||
# (egress.remoteAssets) and do NOT belong here, because a bare 80/443 in
|
||||
# this list records no reason. Add a port here only for something neither
|
||||
# the switch nor the chart covers.
|
||||
extraPorts: []
|
||||
@@ -4,7 +4,7 @@ description: A Helm chart to deploy Home Assistant on Kubernetes
|
||||
icon: https://www.home-assistant.io/images/home-assistant-logo.svg
|
||||
type: application
|
||||
|
||||
version: 6.2.0+up2026.8.3
|
||||
version: 7.0.0+up2026.8.3
|
||||
|
||||
appVersion: "2026.8.3"
|
||||
|
||||
|
||||
@@ -372,3 +372,55 @@ env IS APPENDED, AND HOME ASSISTANT WILL NOT READ IT ON ITS OWN
|
||||
value: a value is stored in the pod spec and readable by anyone who can read
|
||||
pods in {{ .Release.Namespace }}.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 8123 only — anything else this image or an add-on binds is not
|
||||
reachable. THERE IS NO EGRESS RESTRICTION AT ALL, deliberately: outbound
|
||||
traffic here is the union of every integration you enable (mDNS and SSDP
|
||||
discovery, MQTT, a Zigbee or Z-Wave bridge, ESPHome, printers, speakers,
|
||||
inverters, cloud APIs, NTP), a chart cannot know that set, and a cap would
|
||||
break integrations one at a time — months apart, each looking like a flaky
|
||||
device rather than like a policy. An installation that wants one should write
|
||||
it at release level, against its own integration list.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app="{{ .Release.Name }}-{{ .Chart.Name }}"
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,124 @@
|
||||
{{- /*
|
||||
NetworkPolicy for homeassistant (Gitea #5).
|
||||
|
||||
INGRESS ONLY, AND THE MISSING EGRESS SECTION IS THE DECISION IN THIS FILE.
|
||||
|
||||
Home Assistant's outbound traffic is the union of every integration an operator
|
||||
enables, and that set is unknowable to a chart: mDNS and SSDP discovery on
|
||||
5353/UDP and 1900/UDP, MQTT on 1883 or 8883, a Zigbee or Z-Wave bridge on
|
||||
whatever port its firmware chose, ESPHome on 6053, printers, speakers, TVs,
|
||||
inverters, cloud APIs on 443, an NTP client on 123/UDP. A port cap here would
|
||||
not protect anything meaningful - the devices are on the same LAN as the node -
|
||||
and it would break integrations ONE AT A TIME, months apart, each failure
|
||||
looking like a flaky device rather than like this object. There is no version
|
||||
of this list that stays correct.
|
||||
|
||||
So the rule from valkey applies, in the other direction: policyTypes names only
|
||||
what there is something to restrict, because an egress rule that has to be
|
||||
widened until it permits everything makes the object look stricter than it is
|
||||
while costing real outages to get there. If a deployment wants an egress cap,
|
||||
it belongs in a release-level policy written against that installation's actual
|
||||
integrations - not in a chart that cannot see them.
|
||||
|
||||
What the Ingress half still buys is real and worth having on its own: only 8123
|
||||
is reachable, so anything else this image or an add-on binds is not.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects this chart's workload. Note the label: the bare release-and-chart name,
|
||||
QUOTED, with no -sfs suffix - unlike most charts here. Copying a selector from
|
||||
a neighbouring chart would match nothing and leave this policy filtering
|
||||
nothing, which is what ci/run-networkpolicy-test.sh holds it against.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: "{{ .Release.Name }}-{{ .Chart.Name }}"
|
||||
policyTypes:
|
||||
- Ingress
|
||||
ingress:
|
||||
{{- /*
|
||||
8123 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the port all three probes address. The probe path.
|
||||
|
||||
No ingress-controller entry: this chart keeps its flexible upstream ingress
|
||||
style and renders no Ingress of its own (a documented exception in README),
|
||||
so the sources to name are namespaces, through allowedNamespaces.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8123
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,30 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -235,3 +235,56 @@ core:
|
||||
# kubectl rollout restart statefulset <release>-homeassistant-sfs
|
||||
secrets:
|
||||
configSecretRef: null
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 8123 only. THERE IS NO EGRESS SECTION, and
|
||||
# that is the decision in this chart rather than an omission.
|
||||
#
|
||||
# Home Assistant's outbound traffic is the union of every integration enabled
|
||||
# in a release: mDNS/SSDP discovery (5353/UDP, 1900/UDP), MQTT (1883/8883), a
|
||||
# Zigbee or Z-Wave bridge on whatever port its firmware chose, ESPHome (6053),
|
||||
# printers, speakers, TVs, inverters, cloud APIs on 443, NTP on 123/UDP. A
|
||||
# chart cannot know that set, a cap would protect little - the devices sit on
|
||||
# the node's own LAN - and it would break integrations one at a time, months
|
||||
# apart, each looking like a flaky device rather than like a policy. So
|
||||
# policyTypes names Ingress only, for the same reason valkey names Ingress
|
||||
# only: a rule that has to be widened until it permits everything makes the
|
||||
# object look stricter than it is.
|
||||
#
|
||||
# An installation that wants an egress cap should write one against its own
|
||||
# integrations, at release level, where they are visible.
|
||||
#
|
||||
# Inbound 8123 is not restricted by source in the default (probe port), and a
|
||||
# policy is only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 8123, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
+1
-1
@@ -43,7 +43,7 @@ type: application
|
||||
# procedure lives in NOTES.txt and on the wiki page instead of in a
|
||||
# packageRules entry. Read the "MINOR UPGRADES" section of NOTES.txt before
|
||||
# merging an app-version PR that changes the minor.
|
||||
version: 1.3.0+up26.8.0
|
||||
version: 2.0.0+up26.8.0
|
||||
appVersion: "26.8.0"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -363,3 +363,80 @@ WHAT THIS CHART DOES NOT RENDER
|
||||
platform objects and live in cluster-config; this chart renders an
|
||||
HTTPRoute at most, which is the part that looks the same on every Gateway
|
||||
implementation.
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound, and all three ports differ:
|
||||
- http ({{ $settings.ports.http | int64 }}): RESTRICTED BY SOURCE — this namespace, anything in
|
||||
networkPolicy.allowedNamespaces, and the ingress controller. No probe uses
|
||||
this port, which is what makes the restriction possible.
|
||||
- management ({{ $settings.ports.management | int64 }}): open inside the cluster, because all three probes
|
||||
address it. Its health and metrics surface is UNAUTHENTICATED, and before
|
||||
this object the only thing protecting it was that no Ingress pointed at
|
||||
it. Narrow it with networkPolicy.probeSources.
|
||||
- jgroups ({{ $settings.ports.jgroups | int64 }}): this release's own pods only.
|
||||
Outbound: DNS, TCP {{ $settings.db.port | int64 }} (the CONFIGURED database port — this chart derives it
|
||||
rather than guessing), {{ $settings.ports.jgroups | int64 }} (the cluster bus, outbound as well as in) and 443{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }},
|
||||
plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
TWO THINGS TO CHECK AFTER THE FIRST UPGRADE, because nothing else will.
|
||||
|
||||
1. LOG IN. This release is the cluster's identity provider, and the http rule
|
||||
is the only source-restricted inbound rule in the repository. If the
|
||||
ingress-controller source is wrong for this cluster, every login
|
||||
everywhere stops — and no part of CI can see it, because no ingress
|
||||
controller runs there and the probes use the management port, so the pod
|
||||
becomes Ready either way. The default was measured against the live
|
||||
cluster (DaemonSet rke2-traefik in kube-system, which serves the Gateway
|
||||
API here too), but measured labels are not proven traffic.
|
||||
2. CHECK YOUR CONSUMERS' ISSUER URLS. An application that reaches Keycloak on
|
||||
its in-cluster Service address rather than its public URL is a pod in
|
||||
another namespace, and the http rule blocks it. Those namespaces go into
|
||||
networkPolicy.allowedNamespaces. Consumers using the public issuer URL
|
||||
arrive through Traefik and are already covered.
|
||||
|
||||
AND MAIL IS NOT ALLOWED. Keycloak's SMTP server is configured per realm,
|
||||
which this chart never sees, so verification and password-reset mail needs its
|
||||
port (587 or 465) in networkPolicy.egress.extraPorts. The symptom otherwise is
|
||||
mail that is never delivered, with a healthy pod behind it.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,281 @@
|
||||
{{- /*
|
||||
NetworkPolicy for keycloak (Gitea #5).
|
||||
|
||||
THE RICHEST POLICY OF THIS ROLLOUT, AND THE ONE WITH THE LARGEST BLAST RADIUS.
|
||||
Read both halves of that before changing anything here.
|
||||
|
||||
Keycloak is the only chart in the repository whose three ports fall into three
|
||||
DIFFERENT classes, so it is the one place the convention is visible in full:
|
||||
|
||||
http (8080) NOT addressed by any probe, so it CAN be restricted by
|
||||
source - and it is. Own namespace, allowedNamespaces, and
|
||||
the ingress controller. This is the only real inbound
|
||||
restriction in the sweep, and it is possible only because
|
||||
the probes use a different port.
|
||||
management (9000) the port all three probes address, so it stays open by
|
||||
default. That is unfortunate here specifically: 9000
|
||||
carries the health and metrics surface UNAUTHENTICATED,
|
||||
and "no Ingress" was its only protection before this
|
||||
object existed. The policy improves it from "anything that
|
||||
can route to the pod" to "anything inside the cluster",
|
||||
and networkPolicy.probeSources is what closes the rest -
|
||||
at the price of needing the worker node IPs.
|
||||
jgroups (7800) the cluster bus between this release's own replicas.
|
||||
Restricted to the pods this policy itself selects, which
|
||||
is the narrowest rule this object can express.
|
||||
|
||||
All three port numbers and the database port are DERIVED from the chart's own
|
||||
values through keycloak.settings, not written down twice: an operator who moves
|
||||
keycloak.ports.http moves the policy with it. The database port is
|
||||
keycloak.db.port, so unlike most charts in this sweep the egress rule here is
|
||||
the CONFIGURED port and not a guess.
|
||||
|
||||
THE BLAST RADIUS, stated plainly because it is the largest in this issue: this
|
||||
release is the cluster's identity provider. If the ingress-controller source
|
||||
below is wrong, every login everywhere breaks, and NOTHING IN CI CAN CATCH IT -
|
||||
no ingress controller runs in the install-test, and the probes use 9000, so the
|
||||
pod becomes Ready either way. The source was measured on the live cluster
|
||||
(DaemonSet rke2-traefik in kube-system, which also serves the Gateway API
|
||||
here), but measured labels are not proven traffic. After the first upgrade,
|
||||
verify with an actual login rather than with kubectl.
|
||||
|
||||
AND THE SECOND TRAP, which is the same shape: a consumer that reaches Keycloak
|
||||
on its IN-CLUSTER Service address rather than through its public URL is a pod
|
||||
in another namespace, and the http rule blocks it. Those namespaces belong in
|
||||
allowedNamespaces. Consumers that use the public issuer URL arrive through
|
||||
Traefik and are already covered.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $settings := fromYaml (include "keycloak.settings" .) }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods, and the same label the PodDisruptionBudget and
|
||||
the two Services use. ci/run-networkpolicy-test.sh fails if it matches no pod
|
||||
spec of the same render.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there is a great deal to restrict and almost all of it
|
||||
is known: the database on its configured port, the cluster bus, and HTTPS. What
|
||||
is NOT permitted and is the likely first surprise: SMTP. Keycloak sends mail
|
||||
(verification, password reset) through a server configured per realm, which
|
||||
this chart cannot see - so it needs networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
THE HTTP PORT, AND THE ONE GENUINELY RESTRICTED INBOUND RULE IN THIS SWEEP.
|
||||
|
||||
It can be restricted because no probe addresses it - the probes use the
|
||||
management port - so there is no kubelet traffic to accommodate and no need for
|
||||
probeSources here. Allowed: this release's own namespace, whatever
|
||||
allowedNamespaces adds, and the ingress controller.
|
||||
|
||||
Both selectors of the controller entry sit in ONE list item, which makes them
|
||||
an AND: those pods in that namespace. Split into two items they would be an OR
|
||||
and would open Keycloak's login endpoint to every pod in kube-system.
|
||||
|
||||
If this rule is wrong, every login in the cluster breaks and no part of CI will
|
||||
say so. See the header.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.http | int64 }}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- /*
|
||||
THE MANAGEMENT PORT - health, readiness and metrics, and all three probes
|
||||
address it. So it is the probe path and stays open by default.
|
||||
|
||||
That is worth naming rather than glossing: this surface is UNAUTHENTICATED, and
|
||||
before this object existed its only protection was that no Ingress pointed at
|
||||
it. What this policy adds is a smaller ceiling, not a closed door - the port is
|
||||
reachable from inside the cluster. Closing it means listing the worker node IPs
|
||||
in networkPolicy.probeSources, with the usual cost of getting them wrong.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.management | int64 }}
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
No ingress-controller entry on this rule: nothing routes to the management port
|
||||
from outside, and it should stay that way.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
{{- /*
|
||||
THE CLUSTER BUS between this release's own replicas, and the narrowest rule
|
||||
this object can express: a podSelector with no namespaceSelector, which means
|
||||
"pods with these labels IN THIS NAMESPACE" - i.e. exactly the pods this policy
|
||||
already selects.
|
||||
|
||||
Infinispan discovery here is jdbc-ping (see values.yaml), so no multicast and
|
||||
no extra port is involved; the peers find each other through the database and
|
||||
then connect on this port. The matching egress rule below is what lets them
|
||||
dial OUT - without it the cluster would form in one direction only.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.jgroups | int64 }}
|
||||
from:
|
||||
- podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
The external PostgreSQL, on THE CONFIGURED PORT - keycloak.db.port, derived
|
||||
through keycloak.settings. This chart is the exception in the sweep: its
|
||||
database port is a value rather than a field inside an opaque secret, so this
|
||||
rule follows the configuration instead of guessing at 5432.
|
||||
|
||||
It also carries Infinispan's jdbc-ping discovery, which is why a blocked
|
||||
database here costs the cluster as well as the data.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.db.port | int64 }}
|
||||
{{- /*
|
||||
Outbound cluster bus. Needed as well as the ingress rule above: policyTypes
|
||||
lists Egress, so a replica dialling its peer is subject to this policy too, and
|
||||
without this rule the bus would be permitted inbound and blocked outbound - a
|
||||
cluster that never forms, with two nodes that each look healthy.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ $settings.ports.jgroups | int64 }}
|
||||
{{- /*
|
||||
Outbound HTTPS. Keycloak needs it for identity brokering and for external
|
||||
identity-provider metadata, both configured inside REALMS this chart never
|
||||
sees - so the port has to be permitted here or a federated login fails with no
|
||||
hint pointing at this object. Also covers an outbound webhook or a remote JWKS.
|
||||
Ports only: these are hostnames.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"description": "true renders the Deployment with replicas: 0 and takes precedence over keycloak.replicas. Also the first half of the minor-upgrade procedure, because Keycloak supports a rolling update only inside a minor line.",
|
||||
"type": "boolean"
|
||||
|
||||
@@ -884,3 +884,101 @@ httpRoute:
|
||||
# Empty means [ingress.admin.domain]. Required (via that value) while
|
||||
# ingress.admin.enabled is true and httpRoute.enabled is true.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# THE RICHEST POLICY IN THIS REPOSITORY, AND THE ONE WITH THE LARGEST BLAST
|
||||
# RADIUS. Both halves matter.
|
||||
#
|
||||
# WHAT IT ALLOWS, inbound, and the three ports are three different cases:
|
||||
# - http (8080): RESTRICTED BY SOURCE to this namespace, allowedNamespaces
|
||||
# and the ingress controller. The only real inbound restriction in the
|
||||
# whole sweep, and possible only because no probe uses this port.
|
||||
# - management (9000): open inside the cluster, because all three probes
|
||||
# address it. This is the port whose health and metrics surface is
|
||||
# UNAUTHENTICATED; before this object its only protection was that no
|
||||
# Ingress pointed at it. probeSources closes the rest.
|
||||
# - jgroups (7800): this release's own pods only.
|
||||
# Outbound: DNS, the CONFIGURED database port (keycloak.db.port - this chart
|
||||
# does not have to guess), the cluster bus, and 443 for identity brokering.
|
||||
#
|
||||
# THE BLAST RADIUS: this release is the cluster's identity provider. If
|
||||
# ingressController below is wrong, EVERY LOGIN EVERYWHERE BREAKS, and no
|
||||
# part of CI can catch it - no ingress controller runs in the install-test,
|
||||
# and the probes use 9000 so the pod goes Ready either way. The source was
|
||||
# measured on the live cluster, but measured labels are not proven traffic:
|
||||
# after the first upgrade, verify with a real login.
|
||||
#
|
||||
# AND THE SECOND TRAP: a consumer that reaches Keycloak on its IN-CLUSTER
|
||||
# Service address instead of its public URL is a pod in another namespace,
|
||||
# and the http rule blocks it. Put those namespaces in allowedNamespaces.
|
||||
# Consumers using the public issuer URL come through Traefik and are covered.
|
||||
#
|
||||
# NOT allowed, and the likely first surprise: SMTP. Mail is configured per
|
||||
# REALM, which this chart never sees - see egress.extraPorts.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach the management port (keycloak.ports.management, 9000 by default), which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# SMTP is the entry this chart needs most: 587 or 465, for the mail server
|
||||
# configured inside a realm. Also an LDAP user federation (389 or 636), or
|
||||
# a database that is somehow not on keycloak.db.port.
|
||||
extraPorts: []
|
||||
@@ -3,7 +3,7 @@ name: matrix-synapse
|
||||
description: A Helm chart to deploy a Matrix Synapse server on Kubernetes
|
||||
icon: https://raw.githubusercontent.com/element-hq/synapse/develop/docs/favicon.png
|
||||
type: application
|
||||
version: 7.2.0+upv1.159.0
|
||||
version: 8.0.0+upv1.159.0
|
||||
appVersion: "v1.159.0"
|
||||
maintainers:
|
||||
- name: jklein
|
||||
@@ -396,3 +396,62 @@ matrix.env IS APPENDED, NOT MERGED
|
||||
{{ .Release.Namespace }}. Note that Synapse takes its real configuration from
|
||||
homeserver.yaml, not from the environment.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — TWO OBJECTS, ONE PER WORKLOAD
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects the Synapse pods and
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-delegation-networkpolicy the delegation nginx. They are
|
||||
separate because their needs are opposite: Synapse federates and must be able
|
||||
to reach any homeserver on the internet, while the delegation server returns
|
||||
two static JSON documents and calls nobody. One policy over both pods would
|
||||
have to permit the union — handing full federation reach and the database port
|
||||
to an nginx that serves a constant.
|
||||
|
||||
Synapse: inbound TCP 8008 only; outbound DNS, TCP 5432 (Postgres), 443 and
|
||||
8448 (federation, remote media, push gateways, identity servers){{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP
|
||||
{{ join ", " . }}{{ end }}{{ end }}.
|
||||
Delegation nginx: inbound TCP 8080 only; outbound DNS and nothing else —
|
||||
networkPolicy.egress.extraPorts deliberately does not widen it.
|
||||
|
||||
Three limits, none of them visible in the objects themselves:
|
||||
|
||||
- FEDERATION CANNOT BE NARROWED. 443 and 8448 go to ANY destination, because
|
||||
a federating homeserver may contact any other homeserver there is, and a
|
||||
NetworkPolicy matches CIDRs and selectors but never hostnames — with this
|
||||
cluster's CNI (Canal: Flannel plus Calico) there is no FQDN rule either.
|
||||
What the cap still buys is real: Synapse can open NO other outbound port,
|
||||
so a compromised instance reaches no other database, no SSH and no mail
|
||||
server in the cluster.
|
||||
- 5432 IS THE STANDARD PORT, NOT YOUR CONFIGURED ONE. Synapse's Postgres
|
||||
connection lives inside secrets.configSecretRef, which this chart never
|
||||
parses. A database elsewhere is blocked — put its port in
|
||||
networkPolicy.egress.extraPorts. The same applies to a TURN server for
|
||||
voice, or to SMTP if this release sends mail.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATHS ARE RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node a pod lands on, its probes are dropped and THE POD
|
||||
NEVER BECOMES READY — the rollout times out and the symptom looks like a
|
||||
broken application.
|
||||
|
||||
AND CHECK FEDERATION AFTER THIS CHANGE, not just the web UI. Inbound
|
||||
federation reaches Synapse through the Ingress, and every remote homeserver
|
||||
that wants to federate fetches /.well-known/matrix from the delegation
|
||||
server — so a wrong ingressController here stops federation and stops it
|
||||
being discoverable, and that failure appears on OTHER people's servers
|
||||
before it appears on yours.
|
||||
{{- else }}
|
||||
- BOTH PROBE PORTS ARE OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so neither rule carries a source selector and any pod the CNI routes
|
||||
to can reach them. Not from the internet — neither port has a NodePort —
|
||||
but this is NOT pod-level isolation. Narrowing it means listing the worker
|
||||
node IPs, because the kubelet probes from the node's own address and the
|
||||
chart cannot know it; a wrong guess leaves the pod permanently un-Ready.
|
||||
{{- end }}
|
||||
|
||||
Switch both off with networkPolicy.enabled: false. And remember that a policy
|
||||
is only a boundary where the CNI enforces one — unenforced, both objects are
|
||||
accepted and filter nothing, so everything reads as configured.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,269 @@
|
||||
{{- /*
|
||||
Two NetworkPolicies, one per workload (Gitea #5).
|
||||
|
||||
THIS CHART RENDERS TWO POD TEMPLATES AND THEY NEED DIFFERENT RULES, which is
|
||||
why this file is written out rather than generated from one shape like most of
|
||||
the sweep. A single policy selecting both would have to be the UNION of what
|
||||
each needs - Synapse's federation egress granted to the delegation server, and
|
||||
the delegation server's ports granted to Synapse - and a policy that is the
|
||||
union of two workloads' needs is strictly weaker than two policies, while
|
||||
looking like one decision.
|
||||
|
||||
<release>-<chart>-networkpolicy the Synapse StatefulSet
|
||||
<release>-<chart>-delegation-networkpolicy the delegation nginx Deployment
|
||||
|
||||
The split matters most on egress. Synapse federates: it opens connections to
|
||||
other people's homeservers, to push gateways and to identity servers, so its
|
||||
egress rule is necessarily wide. The delegation server serves two static JSON
|
||||
documents under /.well-known/matrix and calls NOTHING - so its egress is DNS
|
||||
and nothing else, which is as tight as this object gets. Merging them would
|
||||
have handed Synapse's reach to an nginx whose entire job is to return a
|
||||
constant.
|
||||
|
||||
BOTH WORKLOADS SIT BEHIND THE SAME INGRESS, on different paths (/ to Synapse,
|
||||
/.well-known/matrix to the delegation server), so both carry the ingress
|
||||
controller in their restricted branch - and both would go dark together if it
|
||||
were wrong.
|
||||
|
||||
AND BOTH PROBE PORTS STAY OPEN BY DEFAULT, because all three probes of each
|
||||
workload address its own HTTP port. The kubelet probes from the IP of the
|
||||
worker node running the pod, which no chart can know; narrowing is
|
||||
networkPolicy.probeSources, and it applies to both policies at once.
|
||||
|
||||
WHAT THESE POLICIES DO NOT DO:
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and never hostnames, so "only the homeservers we federate with"
|
||||
cannot be expressed - and with Canal (Flannel plus Calico) there is no FQDN
|
||||
rule to reach for. Federation therefore means 443 and 8448 to any address,
|
||||
which is the honest description: Synapse may contact any homeserver on the
|
||||
internet, because that is what federation is.
|
||||
- THE DATABASE PORT IS A GUESS. Synapse's Postgres connection lives inside
|
||||
secrets.configSecretRef, a 1Password item this chart never parses, so 5432
|
||||
is the standard port and not the configured one.
|
||||
- A POLICY IS ONLY A BOUNDARY WHERE THE CNI ENFORCES ONE.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Synapse StatefulSet's pods - NOT the delegation Deployment's,
|
||||
which has its own policy below. ci/run-networkpolicy-test.sh reports which pod
|
||||
templates each selector matches, so a label renamed in one of the two
|
||||
workloads shows up as a finding rather than as a policy that filters nothing.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
8008 - Synapse's client and federation API, the port the Service forwards 80
|
||||
to, and the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8008
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's
|
||||
probes come from the IP of the worker node running the pod, so that
|
||||
address has to be in the list or the pod never becomes Ready - and a pod
|
||||
that is never Ready reads as a broken application rather than as a policy.
|
||||
|
||||
MIND THE FEDERATION SIDE OF THIS RULE. Inbound federation traffic arrives
|
||||
through the Ingress, so the controller entry below is what keeps other
|
||||
homeservers able to reach this one. Restricting this rule without it does
|
||||
not merely hide a web UI: it stops federation inbound, which looks like
|
||||
other servers being unreachable rather than like a local policy.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this
|
||||
needs no labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these
|
||||
labels IN that namespace. Written as two list entries it would be an OR,
|
||||
and would open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to
|
||||
guess the worker node CIDRs, and a wrong guess blocks every kubelet probe:
|
||||
the pod stays un-Ready, the rollout times out, and the cause looks like
|
||||
the application. An empty "from: []" would be worse than either - it
|
||||
allows everything too, but while reading as a restriction.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in the
|
||||
pod is a trap and not a feature. Synapse needs it more than most - every
|
||||
federated server is resolved by name, including its SRV and .well-known
|
||||
delegation lookups.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
PostgreSQL on the STANDARD port. The connection lives inside
|
||||
secrets.configSecretRef, a 1Password item this chart never parses, so this
|
||||
is the conventional port and not the configured one - a Postgres elsewhere
|
||||
is blocked and belongs in networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 5432
|
||||
{{- /*
|
||||
FEDERATION, and this is the rule that cannot be narrowed. 443 and 8448 to
|
||||
ANY destination: 8448 is the Matrix federation port, 443 is where a
|
||||
delegating homeserver puts its federation API instead, and both are also
|
||||
what Synapse uses to fetch remote media, to reach a push gateway and to
|
||||
reach an identity server.
|
||||
|
||||
"Any destination" is not laziness here, it is the specification: a
|
||||
federating homeserver may contact any other homeserver on the internet, and
|
||||
this object cannot match a hostname in any case. What the cap still buys is
|
||||
real - Synapse cannot open a connection on any OTHER port, so a compromised
|
||||
instance reaches no database, no SSH and no mail server elsewhere in the
|
||||
cluster.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
- protocol: TCP
|
||||
port: 8448
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. The operator's escape hatch
|
||||
from the egress cap, and the only alternative to switching the whole policy
|
||||
off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
---
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-delegation-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-delegation-networkpolicy
|
||||
spec:
|
||||
{{- /* Selects the delegation nginx Deployment's pods only. */}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-delegation-nginx-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
8080 - the only port this pod declares, the port the delegation Service
|
||||
forwards 80 to, and the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8080
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources - the same value
|
||||
governs both policies in this chart. The kubelet probes from the node's
|
||||
own IP, so it has to be in the list or this pod never becomes Ready.
|
||||
|
||||
AND THE CONSUMERS OF THIS ONE ARE OTHER PEOPLE'S HOMESERVERS. The
|
||||
delegation documents under /.well-known/matrix are fetched by every remote
|
||||
server that wants to federate with this one, through the Ingress. Restrict
|
||||
this rule without the controller entry and federation stops being
|
||||
discoverable - a failure that shows up on OTHER servers, not here.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /* Open inside the cluster, as above - the probe path. */}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS AND NOTHING ELSE, and this is the tightest egress rule in the chart on
|
||||
purpose. This nginx serves two static JSON documents and calls nobody; it
|
||||
does not touch the database, it does not federate, it has no upstream. Even
|
||||
DNS is only here because the container resolves at start.
|
||||
|
||||
This is exactly what the two-policy split buys. Folded into Synapse's
|
||||
policy, this pod would have been permitted 443, 8448 and 5432 - full
|
||||
federation reach and the database - for a workload whose entire job is to
|
||||
return a constant. networkPolicy.egress.extraPorts deliberately does NOT
|
||||
apply here: an entry meant for Synapse's database has no business widening
|
||||
this.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -285,3 +285,99 @@ httpRoute:
|
||||
# A chart-global hostname list covering both would erase that distinction.
|
||||
# Set this only when the server name itself has to move.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. TWO objects, one per workload - see
|
||||
# the template for why they are not one. The reference implementation with the
|
||||
# full reasoning is template-chart; the convention is in README, "Chart style
|
||||
# guidelines".
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THESE POLICIES ALLOW. Synapse: inbound 8008 only, outbound DNS plus TCP
|
||||
# 5432 (Postgres), 443 and 8448 (federation, remote media, push gateways,
|
||||
# identity servers). The delegation nginx: inbound 8080 only, outbound DNS and
|
||||
# NOTHING else - it serves two static JSON documents and calls nobody.
|
||||
#
|
||||
# THAT ASYMMETRY IS THE REASON THERE ARE TWO. One policy selecting both pods
|
||||
# would have to permit the union of what each needs, which would hand
|
||||
# Synapse's full federation reach and its database port to an nginx whose
|
||||
# whole job is to return a constant - and it would look like one decision
|
||||
# rather than a widening.
|
||||
#
|
||||
# WHAT THEY DO NOT DO: federation cannot be narrowed. 443 and 8448 go to ANY
|
||||
# destination, because a federating homeserver may contact any other
|
||||
# homeserver on the internet and this object matches CIDRs and selectors but
|
||||
# never hostnames. And 5432 is the STANDARD Postgres port, not the configured
|
||||
# one - the connection lives inside secrets.configSecretRef, which this chart
|
||||
# never parses.
|
||||
#
|
||||
# Both probe ports stay open inside the cluster by default (see probeSources),
|
||||
# and a policy is only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach either workload, in addition to the
|
||||
# release's own namespace, which is always allowed. Empty means: own namespace
|
||||
# only. Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on
|
||||
# every namespace itself, so no labelling work is needed - and no typo
|
||||
# protection either: a name that does not exist matches nothing and is
|
||||
# silently ineffective. An entry opens the port to EVERY pod in that
|
||||
# namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach the two probe ports (Synapse's 8008 and the
|
||||
# delegation server's 8080). ONE VALUE GOVERNS BOTH POLICIES.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry both rules are rendered WITHOUT
|
||||
# a "from" selector, so the ports are reachable from anywhere the CNI routes
|
||||
# to - inside the cluster, since neither carries a NodePort.
|
||||
#
|
||||
# The kubelet's probes originate from the IP of the WORKER NODE running the
|
||||
# pod, an address this chart cannot know and must not guess: a CIDR that
|
||||
# excludes the real node blocks every probe, the pod never becomes Ready, the
|
||||
# rollout times out, and the symptom reads as a broken application rather
|
||||
# than as a policy.
|
||||
#
|
||||
# AND MIND WHAT ELSE THESE TWO PORTS CARRY. Inbound federation arrives at
|
||||
# 8008 through the Ingress, and every remote homeserver that wants to
|
||||
# federate fetches /.well-known/matrix from 8080. Narrowing this list without
|
||||
# ingressController below therefore does not merely hide a web UI: it stops
|
||||
# federation, inbound and discoverable, and the failure shows up on OTHER
|
||||
# people's servers before it shows up here.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach both ports once probeSources
|
||||
# restricts them. Rendered only while ingress.enabled or httpRoute.enabled is
|
||||
# true, and only in the restricted branch - with the default (open) rules the
|
||||
# controller reaches both ports anyway.
|
||||
#
|
||||
# The two keys become ONE "from" entry and are therefore an AND: pods carrying
|
||||
# podLabels IN namespace. That is the point of having them here - the
|
||||
# controller's namespace in allowedNamespaces would open both ports to every
|
||||
# pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports FOR SYNAPSE ONLY. These deliberately do NOT
|
||||
# widen the delegation server's policy: an entry meant for Synapse's
|
||||
# database has no business reaching a workload that serves a constant.
|
||||
#
|
||||
# DNS is always allowed and has no switch - a knob whose only other setting
|
||||
# breaks every name lookup is a trap, not a feature, and Synapse resolves a
|
||||
# name for every server it federates with.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS: a NetworkPolicy matches CIDRs and selectors and
|
||||
# never hostnames, so each entry permits its port to ANY destination.
|
||||
#
|
||||
# The usual entries here: a Postgres that is not on 5432, a TURN/coturn
|
||||
# server for voice (3478 and its relay range), or SMTP (587 or 465) if this
|
||||
# release sends mail - Synapse's mail configuration lives inside
|
||||
# secrets.configSecretRef, which this chart never reads.
|
||||
extraPorts: []
|
||||
@@ -5,7 +5,7 @@ icon: https://avatars.githubusercontent.com/u/988985
|
||||
|
||||
type: application
|
||||
|
||||
version: 4.1.4+up1.47.2
|
||||
version: 5.0.0+up1.47.2
|
||||
appVersion: "1.47.2"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -138,3 +138,57 @@ server.env IS APPENDED TO WHAT THE CHART SETS
|
||||
in clear text, readable by everyone who can read pods in {{ .Release.Namespace }}; anything
|
||||
sensitive belongs in valueFrom.secretKeyRef.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: the proxy port (TCP {{ .Values.server.port }}, open — it is published as NodePort
|
||||
{{ .Values.server.outwardPort }} and the senders are players on the internet) and the API port
|
||||
(TCP {{ .Values.server.apiPort }}, the probe path). Outbound: DNS plus the backend ports taken from
|
||||
the routing table itself — TCP {{ $ports := list (int .Values.server.backendPort) }}{{ range .Values.mappings }}{{ if .port }}{{ $ports = append $ports (int .port) }}{{ end }}{{ end }}{{ join ", " ($ports | uniq) }}{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THE BACKEND RULE IS BY PORT, NOT BY DESTINATION. mappings name hosts, and
|
||||
this object cannot match a hostname — so the rule permits those ports to any
|
||||
address, which is wider than your routing table. Adding a backend on a
|
||||
non-standard port needs no change here: the policy reads the same value the
|
||||
router does.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,184 @@
|
||||
{{- /*
|
||||
NetworkPolicy for minecraft-router (Gitea #5).
|
||||
|
||||
The router is the one chart here whose whole job is to forward traffic to OTHER
|
||||
releases, so its egress rule is the interesting one and it is DERIVED from the
|
||||
routing table rather than guessed: server.backendPort, plus the per-mapping
|
||||
"port" override for every entry of mappings that has one. Add a backend on a
|
||||
non-standard port and the policy follows it, because both come from the same
|
||||
value.
|
||||
|
||||
What it does NOT express is the destination. The mappings name hosts
|
||||
(internalUrl), and a NetworkPolicy matches CIDRs and selectors and never
|
||||
hostnames - so the rule permits those PORTS to any address, not those services.
|
||||
A backend in another namespace is reachable through this rule; so is anything
|
||||
else listening on 25565.
|
||||
|
||||
Inbound splits in two: the proxy port is a NodePort and faces the internet, the
|
||||
API port is the probe path.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $backendPorts := list (int .Values.server.backendPort) }}
|
||||
{{- range .Values.mappings }}
|
||||
{{- if .port }}{{- $backendPorts = append $backendPorts (int .port) }}{{- end }}
|
||||
{{- end }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because the router's outbound traffic is exactly known for
|
||||
once - DNS, and the backend ports from its own routing table. That makes this
|
||||
one of the few egress caps in the sweep that is derived rather than guessed.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
THE PROXY PORT, and deliberately open with no "from" at all: it is published
|
||||
as a NodePort (server.outwardPort) and the senders are Minecraft clients on the
|
||||
internet. After NodePort masquerading the source address is a cluster node
|
||||
anyway, so a source selector here could only ever be a list of node IPs - which
|
||||
would be a restriction in appearance and a maintenance trap in fact.
|
||||
|
||||
NOTE THE NUMBER: this is the POD port (server.port), not server.outwardPort.
|
||||
The NodePort is translated by kube-proxy before the packet reaches the pod, so
|
||||
writing 30565 here would match nothing while looking strict - and being the
|
||||
only rule for this port, it would block every player instead.
|
||||
ci/run-networkpolicy-test.sh asserts exactly this.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ .Values.server.port | int64 }}
|
||||
{{- /*
|
||||
THE API PORT - the router's own HTTP interface, and the port all three probes
|
||||
address. So it is the probe path and stays open inside the cluster by default.
|
||||
|
||||
No ingress-controller entry: this chart renders no Ingress, and nothing should
|
||||
route to the router's API from outside.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ .Values.server.apiPort | int64 }}
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
THE BACKENDS, by port, derived from the routing table: server.backendPort plus
|
||||
the "port" override of every mapping that sets one. So a backend on a
|
||||
non-standard port is covered automatically, and there is no second list to keep
|
||||
in step with mappings.
|
||||
|
||||
Ports and not destinations: the mappings name hosts (internalUrl) and this
|
||||
object cannot match a hostname, so this rule permits those ports to ANY
|
||||
address. That is wider than the routing table and is the honest description of
|
||||
what the object can do.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range $backendPorts | uniq }}
|
||||
- protocol: TCP
|
||||
port: {{ . }}
|
||||
{{- end }}
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,43 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -150,3 +150,70 @@ server:
|
||||
# name: "some-configmap"
|
||||
# key: "someKey"
|
||||
env: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound the proxy port (server.port, OPEN - it is
|
||||
# a NodePort and the senders are players on the internet) and the API port
|
||||
# (the probe path, open inside the cluster). Outbound: DNS plus the backend
|
||||
# ports DERIVED from the routing table - server.backendPort and the "port"
|
||||
# override of every mapping that sets one.
|
||||
#
|
||||
# So this is one of the few egress caps here that follows the configuration
|
||||
# instead of guessing at it: add a backend on a non-standard port and the
|
||||
# policy moves with it.
|
||||
#
|
||||
# WHAT IT DOES NOT DO: the rule permits those PORTS to any destination, not
|
||||
# those SERVICES. mappings name hosts (internalUrl), and a NetworkPolicy
|
||||
# matches CIDRs and selectors but never hostnames - so anything else
|
||||
# listening on a backend port is reachable through this rule too.
|
||||
#
|
||||
# And the proxy port carries the POD port, not server.outwardPort: a
|
||||
# NetworkPolicy is evaluated after kube-proxy has translated the NodePort, so
|
||||
# the NodePort number would match nothing while looking strict.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach the API port (server.apiPort), which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Normally empty: the backend ports already come from mappings. Add a port
|
||||
# only for something outside the routing table - a status API, for
|
||||
# instance.
|
||||
extraPorts: []
|
||||
@@ -23,7 +23,7 @@ type: application
|
||||
# continuously, so a pod restart could pull a different image than the last one
|
||||
# without anything being recorded anywhere. The dated tags are immutable, so the
|
||||
# image is now pinned by the chart version like every other chart in this repo.
|
||||
version: 6.0.1+up2026.8.2.java25
|
||||
version: 7.0.0+up2026.8.2.java25
|
||||
appVersion: "2026.8.2-java25"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -364,3 +364,65 @@ server env IS APPENDED, NOT MERGED
|
||||
everyone who can read pods in {{ .Release.Namespace }}; anything sensitive belongs in
|
||||
valueFrom.secretKeyRef.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: the game port (TCP {{ .Values.server.port }}){{ if eq .Values.server.service.type "NodePort" }} — OPEN, because the Service is a
|
||||
NodePort and the senders are players on the internet{{ else }} — RESTRICTED to this namespace
|
||||
and networkPolicy.allowedNamespaces, because the Service is {{ .Values.server.service.type }} and the only
|
||||
path to it is in-cluster{{ end }}; RCON (TCP {{ .Values.server.rcon.port }}) and metrics (TCP 19565), both always
|
||||
restricted by source. Outbound: DNS and TCP 443{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THIS POLICY IS UNUSUALLY TIGHT, and the reason is that all three probes are
|
||||
exec probes: they run inside the container and put no packet on the network,
|
||||
so no port has to stay open for the kubelet and networkPolicy.probeSources is
|
||||
not needed at all.
|
||||
{{- if not (eq .Values.server.service.type "NodePort") }}
|
||||
|
||||
SO CHECK ONE THING: players reach this server through minecraft-router, which
|
||||
runs in ITS OWN namespace. That namespace must be in
|
||||
networkPolicy.allowedNamespaces, or the server is unreachable and the symptom
|
||||
is a connection timeout in a game client with a perfectly healthy pod behind
|
||||
it. The same goes for a Prometheus scraping port 19565 from elsewhere.
|
||||
{{- end }}
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,210 @@
|
||||
{{- /*
|
||||
NetworkPolicy for minecraft-server (Gitea #5).
|
||||
|
||||
THIS IS THE CHART WHERE THE POLICY GETS GENUINELY TIGHT, and the reason is its
|
||||
probes: all three are exec probes. An exec probe runs inside the container
|
||||
through the kubelet's runtime and puts NO packet on the network, so there is no
|
||||
kubelet traffic to accommodate on any port - which means every port here can be
|
||||
restricted by source, with no probeSources needed at all. valkey is tight for
|
||||
the same reason.
|
||||
|
||||
The one rule that cannot be fixed is the game port, and it depends on a value:
|
||||
|
||||
server.service.type == NodePort players arrive from the internet, already
|
||||
masqueraded, so the rule must be OPEN.
|
||||
anything else (the default) the only reachable path is in-cluster, i.e.
|
||||
minecraft-router, so the rule is RESTRICTED
|
||||
to this namespace plus allowedNamespaces -
|
||||
and the router's namespace has to be in that
|
||||
list.
|
||||
|
||||
Both branches are rendered from the same value the Service reads, so they cannot
|
||||
disagree. The RCON and metrics ports are restricted in either case.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the StatefulSet's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there is something real to restrict: a Minecraft
|
||||
server needs DNS and HTTPS and nothing else in the normal case. Mod packs that
|
||||
call out on other ports are the exception, and extraPorts is for them.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- if eq .Values.server.service.type "NodePort" }}
|
||||
{{- /*
|
||||
THE GAME PORT, NODEPORT BRANCH (server.service.type is NodePort). Open with no
|
||||
"from": the senders are Minecraft clients on the internet and, after NodePort
|
||||
masquerading, the source address is a cluster node anyway.
|
||||
|
||||
THE NUMBER IS THE POD PORT (server.port), not server.service.outwardPort. A
|
||||
NetworkPolicy is evaluated after kube-proxy has translated the NodePort, so the
|
||||
NodePort number would match nothing here while looking strict - and being the
|
||||
only rule for the port, it would block every player instead.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ .Values.server.port | int64 }}
|
||||
{{- end }}
|
||||
{{- if not (eq .Values.server.service.type "NodePort") }}
|
||||
{{- /*
|
||||
THE GAME PORT, CLUSTER-INTERNAL BRANCH (the default): the Service is not a
|
||||
NodePort, so nothing outside the cluster can reach this port through this
|
||||
chart, and the rule is restricted to this namespace plus allowedNamespaces.
|
||||
|
||||
PUT THE ROUTER'S NAMESPACE IN allowedNamespaces. In this cluster players reach
|
||||
the server through minecraft-router, which runs in its own namespace - so
|
||||
without that entry the server is unreachable and the symptom is a connection
|
||||
timeout in a game client, with a healthy pod behind it.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ .Values.server.port | int64 }}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- if .Values.server.rcon.enabled }}
|
||||
{{- /*
|
||||
RCON - remote console, i.e. full administrative control of the server. No
|
||||
Service and no probe, so it is restricted to this namespace plus
|
||||
allowedNamespaces: the rule with the most security value in this chart, and it
|
||||
costs nothing.
|
||||
|
||||
GATED ON server.rcon.enabled, AND THAT GATE IS NOT COSMETIC. The containerPort
|
||||
itself is rendered only when RCON is on (see the StatefulSet), so without the
|
||||
same condition here the policy would name a port the pod does not declare -
|
||||
which is not merely untidy: ci/run-networkpolicy-test.sh rejects it, and it
|
||||
rejected exactly this while the chart was being written. A rule for a port
|
||||
nothing listens on is a rule nobody can verify.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: {{ .Values.server.rcon.port | int64 }}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- /*
|
||||
The metrics port. No Service, no probe, so restricted like RCON. A Prometheus
|
||||
that scrapes this release from another namespace needs that namespace in
|
||||
allowedNamespaces - and the failure is a target that silently stops reporting,
|
||||
which is worth knowing before it happens.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 19565
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
Outbound HTTPS. Needed for Mojang's session server when online-mode is on - a
|
||||
server that cannot reach it rejects every login - and for resource-pack and mod
|
||||
downloads. To any destination, because those are hostnames.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,36 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -313,3 +313,56 @@ curseforgeServerpack:
|
||||
# Longhorn.
|
||||
downloadUrl: null
|
||||
workingDirectory: '/data/serverpack'
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# THIS IS ONE OF THE TIGHTEST POLICIES IN THE REPOSITORY, and the reason is
|
||||
# the probes: all three are EXEC probes, which run inside the container and
|
||||
# put no packet on the network. So there is no kubelet traffic to
|
||||
# accommodate, every port can be restricted by source, and no probeSources
|
||||
# value is needed at all.
|
||||
#
|
||||
# WHAT IT ALLOWS, inbound:
|
||||
# - the game port (server.port): OPEN when server.service.type is NodePort
|
||||
# (players arrive from the internet, already masqueraded), and
|
||||
# RESTRICTED to this namespace plus allowedNamespaces otherwise - which
|
||||
# is the default. Both branches read the same value the Service does.
|
||||
# - RCON (server.rcon.port) and metrics (19565): always restricted. RCON is
|
||||
# full administrative control of the server, so this is the rule with the
|
||||
# most security value here, and it costs nothing.
|
||||
# Outbound: DNS and TCP 443 (Mojang's session server for online-mode, plus
|
||||
# resource packs and mods).
|
||||
#
|
||||
# PUT THE ROUTER'S NAMESPACE IN allowedNamespaces when the Service is not a
|
||||
# NodePort. In this cluster players reach the server through
|
||||
# minecraft-router, in its own namespace; without that entry the server is
|
||||
# unreachable and the symptom is a timeout in a game client with a healthy
|
||||
# pod behind it. The same applies to a Prometheus scraping 19565.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Add a port for a mod pack that calls out somewhere other than 443 - an
|
||||
# authentication proxy, a map renderer upload, a Discord bridge.
|
||||
extraPorts: []
|
||||
+2
-2
@@ -5,8 +5,8 @@ icon: https://raw.githubusercontent.com/outline/outline/main/public/images/icon-
|
||||
|
||||
type: application
|
||||
|
||||
version: 7.2.0+up1.10.1
|
||||
appVersion: 1.10.1
|
||||
version: 8.1.0+up1.11.0
|
||||
appVersion: 1.11.0
|
||||
|
||||
maintainers:
|
||||
- name: jklein
|
||||
@@ -235,3 +235,57 @@ FORCE_HTTPS IS ON
|
||||
header. Turned on, Outline redirects to https itself — which loops
|
||||
endlessly if that header does not reach the pod.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 3000 only. Outbound: DNS, TCP 5432 (Postgres), 6379 (Redis),
|
||||
443 (OIDC discovery){{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THOSE EGRESS PORTS ARE THE STANDARD ONES, NOT YOUR CONFIGURED ONES. The
|
||||
database, Redis and OIDC URLs all live inside 1Password items that this chart
|
||||
never parses, so it cannot know where your dependencies listen. A dependency
|
||||
on another port is blocked — and since all three probes hit /_health, which
|
||||
checks Postgres and Redis, the symptom is a pod that never becomes Ready
|
||||
rather than a connection error anyone sees. Add the real port to
|
||||
networkPolicy.egress.extraPorts.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,192 @@
|
||||
{{- /*
|
||||
NetworkPolicy for outline (Gitea #5).
|
||||
|
||||
Outline is the first chart of this rollout whose policy has real work to do in
|
||||
BOTH directions, and it is also the one that proves the egress cap bites: all
|
||||
three of its probes hit /_health, which checks Postgres AND Redis, so a pod
|
||||
that cannot reach its data stores never becomes Ready.
|
||||
|
||||
THE EGRESS PORTS ARE THE CHART'S ONLY KNOWLEDGE OF ITS DEPENDENCIES, AND THEY
|
||||
ARE A GUESS AT THE STANDARD ONES. Outline's database, Redis and OIDC provider
|
||||
are configured through connection URLs inside 1Password items - the chart never
|
||||
sees a host or a port, cannot derive one, and cannot validate one. So the rules
|
||||
below name the standard ports (5432, 6379, 443) and nothing else. A deployment
|
||||
whose Postgres listens anywhere else is BLOCKED, and it finds out through an
|
||||
application-level connection error, not through this object. That is the
|
||||
upgrade risk of this chart's policy, stated plainly; the escape hatch is
|
||||
networkPolicy.egress.extraPorts.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the StatefulSet's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there IS something to restrict: this workload
|
||||
needs DNS and the ports named below, and nothing else. A chart whose
|
||||
workload opens no outbound connection of its own must NOT list Egress -
|
||||
valkey is the example - because a rule that constrains nothing makes the
|
||||
object look stricter than it is.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
3000 - the only port this pod declares, the one the Service targets, and the
|
||||
one all three probes address (/_health). It is therefore the probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 3000
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress goes dark the
|
||||
moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
Postgres. The port, not the host - outline.secrets.dbSecretRef carries a
|
||||
connection URL the chart never parses, so this is the STANDARD port and not
|
||||
the configured one. A Postgres on any other port is blocked and must be added
|
||||
to networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 5432
|
||||
{{- /*
|
||||
Redis/Valkey, same reasoning as Postgres above: the standard port, because
|
||||
outline.secrets.redisSecretRef holds a URL this chart does not read.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 6379
|
||||
{{- /*
|
||||
Outbound HTTPS. Needed for the OIDC provider: Outline fetches the issuer's
|
||||
discovery document at boot, and the discovery URL also lives inside a secret.
|
||||
443 to any destination is as narrow as this object gets for that - a hostname
|
||||
cannot appear in a NetworkPolicy. An OIDC provider on a non-standard port (a
|
||||
CI dex on 5556, for instance) needs extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -171,3 +171,90 @@ httpRoute:
|
||||
# link, every share URL and the OIDC redirect URI still name the old host
|
||||
# until ingress.domain is changed too.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 3000 only - the single port this pod
|
||||
# declares - and outbound DNS plus TCP 5432 (Postgres), 6379 (Redis) and 443
|
||||
# (the OIDC provider's discovery document, fetched at boot).
|
||||
#
|
||||
# WHAT IT DOES NOT DO, and this is the one to read before upgrading: THOSE
|
||||
# THREE EGRESS PORTS ARE THE STANDARD ONES, NOT THE CONFIGURED ONES. Outline's
|
||||
# database, Redis and OIDC provider all arrive as connection URLs inside
|
||||
# 1Password items, which this chart never parses - so it cannot know your
|
||||
# ports and cannot validate them. A dependency on a non-standard port is
|
||||
# BLOCKED, and because all three probes hit /_health (which checks Postgres
|
||||
# and Redis), that shows up as a pod which never becomes Ready. Put the real
|
||||
# port in egress.extraPorts below.
|
||||
#
|
||||
# The 3000 rule is NOT restricted by source in the default - 3000 is the
|
||||
# probe port, see probeSources. And a policy is only a boundary where the CNI
|
||||
# enforces one; unenforced, it is accepted and filters nothing.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 3000, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Outline needs one entry here more often than most charts: a Postgres or
|
||||
# Redis on a non-standard port, an OIDC provider that is not on 443 (a CI
|
||||
# dex on 5556), an S3 endpoint on a custom port, or SMTP - the chart sets
|
||||
# no SMTP_* variable itself, but a deployment that adds them through
|
||||
# outline.env needs 587 or 465 here too.
|
||||
extraPorts: []
|
||||
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/dev/src-ui/s
|
||||
|
||||
type: application
|
||||
|
||||
version: 13.1.0+up3.3.1
|
||||
version: 14.1.0+up3.3.1
|
||||
|
||||
appVersion: 3.3.1
|
||||
|
||||
|
||||
@@ -531,3 +531,84 @@ BACKUP IS TWO THINGS AT THE SAME TIME
|
||||
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 }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 8000 only. Outbound: DNS, TCP 5432 (Postgres), 6379
|
||||
(Redis/Valkey), 443{{ if .Values.paperless.files.tikaGotenberg.enabled }}, 9998 and 3000 (the Tika and Gotenberg POD ports) plus 80{{ end }}{{ with .Values.networkPolicy.egress }}{{ if .mailImport }}, 993 (IMAPS, mail import){{ end }}{{ with .extraPorts }}, plus TCP
|
||||
{{ join ", " . }}{{ end }}{{ end }}.
|
||||
{{- if .Values.paperless.files.tikaGotenberg.enabled }}
|
||||
|
||||
THE TIKA/GOTENBERG RULE NAMES POD PORTS, AND THAT IS THE FIX FROM GITEA #136.
|
||||
It named the Services' 80 alone until chart 14.1.0, which cut Paperless off
|
||||
from both services: kube-proxy does a ClusterIP Service's destination NAT
|
||||
BEFORE the egress policy is evaluated at the pod's interface, so the policy
|
||||
sees podIP:targetPort. The symptom was a TIMEOUT and not "connection refused",
|
||||
and no error mentioned a NetworkPolicy. If this release reaches a Tika or
|
||||
Gotenberg that listens on some other port, that port goes into
|
||||
networkPolicy.egress.extraPorts.
|
||||
{{- end }}
|
||||
{{- if (.Values.networkPolicy.egress).mailImport }}
|
||||
|
||||
MAIL IMPORT IS PERMITTED on 993 (IMAPS), because
|
||||
networkPolicy.egress.mailImport is on. Plain IMAP (143) and POP3 are NOT
|
||||
covered — add them to networkPolicy.egress.extraPorts if an account uses them.
|
||||
{{- else }}
|
||||
|
||||
MAIL FETCHING IS NOT PERMITTED. Paperless' mail accounts are rows in its
|
||||
database, configured in the web UI, so this chart cannot see them. A release
|
||||
that fetches mail needs networkPolicy.egress.mailImport: true for IMAPS (993),
|
||||
or 143/POP3 in networkPolicy.egress.extraPorts — otherwise a mail rule
|
||||
silently stops importing, with a healthy pod behind it.
|
||||
{{- end }}
|
||||
|
||||
AND TWO PODS OF THIS RELEASE ARE NOT COVERED BY THIS OBJECT:
|
||||
- the valkey subchart's pod, which carries its own labels. It needs no
|
||||
cover from here: the valkey chart ships its own NetworkPolicy, and a
|
||||
tighter one.
|
||||
- the consume CronJob's pods, whose pod template carries NO labels at all,
|
||||
so no podSelector can match them. They move files between mounted
|
||||
volumes and reach the SMB share through a CSI volume the NODE mounts, so
|
||||
the pod opens no connection of its own — but the gap is real and is named
|
||||
here rather than left to be discovered.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,293 @@
|
||||
{{- /*
|
||||
NetworkPolicy for paperless-ngx (Gitea #5).
|
||||
|
||||
Paperless reaches a Postgres and a Redis, and - when
|
||||
paperless.files.tikaGotenberg.enabled is true - the Tika and Gotenberg services,
|
||||
which in this repository are two other charts whose Services listen on port 80.
|
||||
That last rule is derived from the switch rather than always rendered, so a
|
||||
release without Tika does not carry a rule that permits nothing.
|
||||
|
||||
THREE THINGS THIS POLICY DOES NOT COVER, and all three are real rather than
|
||||
theoretical (values.yaml lists the same three; this said "TWO" while listing
|
||||
three, which is corrected here because the third one is the mail rule below):
|
||||
|
||||
1. THE VALKEY SUBCHART'S POD. This chart declares valkey as an optional
|
||||
dependency, and the subchart renders its own StatefulSet with its own
|
||||
labels. It is not covered by THIS policy - but it does not need to be: the
|
||||
valkey chart ships a NetworkPolicy of its own, and it is the tighter one
|
||||
(Ingress-only, 6379 restricted by source, because its probes are exec probes
|
||||
and no kubelet traffic has to be let through). This is the one subchart in
|
||||
the repository that brings its own policy.
|
||||
|
||||
2. THE CONSUME CRONJOB'S PODS. paperless-consume.cronjob.yaml renders a pod
|
||||
template with NO LABELS AT ALL, so no podSelector can match it and no policy
|
||||
in this chart can restrict it. That is a gap in the convention, named here
|
||||
rather than glossed. What makes it tolerable: the CronJob's whole job is to
|
||||
move files between two mounted volumes, and the SMB share reaches it as a
|
||||
CSI volume - mounted by the NODE, not opened by the pod - so the pod itself
|
||||
opens no connection that a policy would have anything to say about. If that
|
||||
ever changes, the CronJob needs labels before it can need a policy.
|
||||
|
||||
3. MAIL FETCHING IS NOT PERMITTED UNLESS THE OPERATOR SAYS SO. Paperless' mail
|
||||
accounts live in its DATABASE, configured through the web UI, so this chart
|
||||
cannot see them and cannot derive the rule. networkPolicy.egress.mailImport
|
||||
opens IMAPS (993) and is off by default; plain IMAP (143) and POP3 belong in
|
||||
networkPolicy.egress.extraPorts. Left off on a release that does fetch mail,
|
||||
the symptom is a mail rule that silently stops importing.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS AND NEVER SERVICE PORTS.
|
||||
A NetworkPolicy is evaluated at the pod's network interface, after kube-proxy
|
||||
has already done its destination NAT - of a NodePort on the way in, and of a
|
||||
ClusterIP on the way OUT. So a NodePort number in an ingress rule matches
|
||||
nothing while looking strict (and, being the only rule for that port, blocks
|
||||
every inbound connection instead), and a SERVICE port in an egress rule matches
|
||||
nothing wherever the Service's port and its targetPort differ. The second half
|
||||
is not hypothetical: it is Gitea #136, it cost an outage on 2026-10-15, and the
|
||||
sentence that caused it is quoted as refuted at the Tika/Gotenberg rule below.
|
||||
|
||||
ci/run-networkpolicy-test.sh asserts every INGRESS port here against the
|
||||
containerPorts of the pod spec this policy selects. Egress cannot be checked
|
||||
that way - an egress port belongs to the DESTINATION, which for Postgres, Redis
|
||||
and the web is not even in the render. The one exception is Tika and Gotenberg,
|
||||
which are two charts of THIS repository: the same test renders them and asserts
|
||||
that the egress rule below contains their containerPorts.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := or .Values.ingress.enabled .Values.httpRoute.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the paperless server's StatefulSet pods. Note that this render may
|
||||
contain the valkey subchart's pods as well - this selector must not match them,
|
||||
and ci/run-networkpolicy-test.sh reports which pod templates it does match so
|
||||
that is visible rather than assumed.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-sfs
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there is a lot to restrict and most of it is known.
|
||||
What is NOT permitted by default and is the plausible surprise: mail. Paperless'
|
||||
mail accounts are rows in its database, configured in the web UI, so the chart
|
||||
cannot see them - networkPolicy.egress.mailImport opens IMAPS 993, and anything
|
||||
else (143, POP3) goes into networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
8000 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 8000
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress goes dark the
|
||||
moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
PostgreSQL on the STANDARD port. The connection details live in a 1Password
|
||||
item this chart never parses, so this is the conventional port and not the
|
||||
configured one; a Postgres elsewhere is blocked and belongs in
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 5432
|
||||
{{- /*
|
||||
Redis/Valkey on the STANDARD port, same reasoning. This covers the bundled
|
||||
valkey subchart as well as an external one - the subchart's Service uses 6379
|
||||
too.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 6379
|
||||
{{- if .Values.paperless.files.tikaGotenberg.enabled }}
|
||||
{{- /*
|
||||
TIKA AND GOTENBERG, ON THEIR POD PORTS 9998 AND 3000 - and 80 as well, for a
|
||||
third case named at the end. Gitea #136: this rule used to name 80 ALONE, and
|
||||
the release that shipped it cut Paperless off from both services on
|
||||
2026-10-15. Mail import, EML, HTML and Office documents stopped; plain PDFs
|
||||
and images kept working, which is why it did not look like a network fault.
|
||||
|
||||
THE SENTENCE THAT STOOD HERE IS WRONG. It is quoted rather than deleted,
|
||||
because it reads perfectly and that is precisely how it survived review:
|
||||
|
||||
"an EGRESS rule names the port on the DESTINATION as the client dials
|
||||
it, and the client dials the Service."
|
||||
|
||||
kube-proxy translates the destination of a ClusterIP Service (DNAT) BEFORE
|
||||
the egress policy is evaluated at the pod's network interface. The policy
|
||||
therefore sees podIP:targetPort and never clusterIP:port, so an egress rule
|
||||
names the POD port. A Service port only ever matches by coincidence, where
|
||||
port and targetPort are the same number - which is the case for 5432, 6379
|
||||
and 443 above and below, and is the reason nothing else here broke.
|
||||
|
||||
THE SYMPTOM IS A TIMEOUT, NOT "connection refused", and that is the half to
|
||||
remember: a missing service REFUSES, a dropped packet RUNS INTO THE TIMEOUT.
|
||||
What this produced was httpx.ConnectTimeout out of paperless' parser, naming
|
||||
the Tika URL and no NetworkPolicy at all - nothing in the error points here.
|
||||
|
||||
WHY 80 STAYS: it costs nothing and covers an installation whose Tika really
|
||||
does listen on 80 - a foreign one behind a proxy, where 80 IS the pod port.
|
||||
|
||||
WHY THERE IS NO SWITCH OF ITS OWN for this rule, and that is deliberate: it
|
||||
is gated on the FEATURE value, because a second value that can drift from the
|
||||
feature re-arms exactly this outage. Whoever enables Tika and forgets the
|
||||
policy switch lands back here, with the same message that does not point at
|
||||
the policy. Rendered only while paperless.files.tikaGotenberg.enabled is
|
||||
true, so a release without them still carries no rule that permits nothing.
|
||||
|
||||
9998 and 3000 are the containerPorts the apache-tika and gotenberg charts of
|
||||
this repository declare, so they are fixed rather than guessed - and
|
||||
ci/run-networkpolicy-test.sh renders both of those charts and asserts that
|
||||
this rule contains them. That is the one assertion a single-chart render
|
||||
cannot make, and it is why this mistake was not caught the first time.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 9998
|
||||
- protocol: TCP
|
||||
port: 3000
|
||||
- protocol: TCP
|
||||
port: 80
|
||||
{{- end }}
|
||||
{{- /*
|
||||
Outbound HTTPS, for the trained classifier's model downloads and for any
|
||||
remote resource a consumed document pulls. To any destination, because those
|
||||
are hostnames.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- if .mailImport }}
|
||||
{{- /*
|
||||
IMAPS for mail import, OFF BY DEFAULT - because this chart cannot know
|
||||
whether a release fetches mail. Paperless' mail accounts are rows in its
|
||||
DATABASE, entered in the web UI, and nothing in the values hints that they
|
||||
exist. So this value is an operator's statement ("this release imports
|
||||
mail") and not a derivation, which is also why it cannot be folded into
|
||||
another switch.
|
||||
|
||||
993 ONLY. Plain IMAP (143) and POP3 (110, 995) are deliberately NOT included:
|
||||
a value named mailImport that quietly opened four ports would be wider than
|
||||
its name, and the plaintext variants are not what a new account uses. They go
|
||||
into networkPolicy.egress.extraPorts.
|
||||
|
||||
AND THIS PORT IS THE REAL DESTINATION PORT, unlike the Tika rule above. A
|
||||
mail server outside the cluster is reached with no Service and therefore no
|
||||
DNAT in the path, so 993 is both what paperless dials and what the policy
|
||||
sees. What decides which number an egress rule needs is the DNAT, not the
|
||||
direction and not the protocol - that is the whole lesson of #136.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 993
|
||||
{{- end }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -51,6 +51,61 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"mailImport": {
|
||||
"description": "Open outbound IMAPS (993) for paperless' mail import. Off by default, and a value rather than a derivation because paperless' mail accounts are rows in its DATABASE, entered in the web UI - nothing in these values says whether a release fetches mail. 993 only: plain IMAP (143) and POP3 (110, 995) are deliberately not covered and belong in extraPorts. Unlike the Tika/Gotenberg rule this is the real destination port, because a mail server outside the cluster is reached with no Service and therefore no destination NAT in the path (Gitea #136).",
|
||||
"type": ["boolean", "null"]
|
||||
},
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk. For a destination INSIDE the cluster these are POD ports: kube-proxy translates a ClusterIP Service's port away before the egress policy is evaluated at the pod's interface, so a Service port matches nothing wherever port and targetPort differ (Gitea #136).",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -540,3 +540,134 @@ valkey:
|
||||
# And one rule that is about this repository rather than about an installation:
|
||||
# changes to valkey/ must not share a pull request with changes to this chart.
|
||||
# Chart.yaml says why; README and the wiki's valkey page carry the long form.
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 8000 only, and outbound DNS plus TCP 5432
|
||||
# (Postgres), 6379 (Redis/Valkey), 443, and - only while
|
||||
# paperless.files.tikaGotenberg.enabled is true - 9998, 3000 and 80 for Tika
|
||||
# and Gotenberg.
|
||||
#
|
||||
# WHY THAT RULE NAMES 9998/3000 AND NOT JUST THE SERVICES' 80 (Gitea #136, an
|
||||
# outage on 2026-10-15). The note that used to stand here said:
|
||||
#
|
||||
# "an egress rule names the port on the DESTINATION as the client dials it,
|
||||
# and paperless dials those charts' SERVICES, which listen on 80 and
|
||||
# forward to the containers' own ports."
|
||||
#
|
||||
# That is wrong, and it is kept as a quotation because it sounds right - which
|
||||
# is why it was never checked. kube-proxy does the ClusterIP Service's
|
||||
# destination NAT BEFORE the egress policy is evaluated at the pod's network
|
||||
# interface, so the policy sees podIP:targetPort, never clusterIP:port. An
|
||||
# egress rule therefore names the POD port: 9998 for apache-tika, 3000 for
|
||||
# gotenberg, both read from those charts' containerPorts. The 80 stays because
|
||||
# it costs nothing and covers a foreign Tika that really does listen on 80.
|
||||
#
|
||||
# AND THE FAILURE MODE IS A TIMEOUT, NOT "connection refused": a missing
|
||||
# service refuses, a dropped packet runs into the timeout. 5432, 6379 and 443
|
||||
# were unaffected only because their Service port and pod port are the same
|
||||
# number.
|
||||
#
|
||||
# THREE THINGS IT DOES NOT COVER:
|
||||
# - The VALKEY SUBCHART'S POD. It carries its own labels, so this policy
|
||||
# does not select it - and it does not need to: the valkey chart ships a
|
||||
# NetworkPolicy of its own, and a tighter one.
|
||||
# - The CONSUME CRONJOB'S PODS. Their pod template carries NO LABELS, so no
|
||||
# podSelector can match them and nothing here restricts them. Tolerable
|
||||
# only because the job moves files between mounted volumes and the SMB
|
||||
# share arrives as a CSI volume mounted by the NODE - the pod opens no
|
||||
# connection of its own. If that changes, the CronJob needs labels first.
|
||||
# - MAIL FETCHING, unless egress.mailImport is switched on. Paperless' mail
|
||||
# accounts are rows in its database, configured in the web UI, so this
|
||||
# chart cannot see them and cannot derive the rule. Left off on a release
|
||||
# that does fetch mail, a mail rule silently stops importing.
|
||||
#
|
||||
# And the usual two: 5432 and 6379 are the STANDARD ports rather than the
|
||||
# configured ones, and a policy is only a boundary where the CNI enforces
|
||||
# one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 8000, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled or httpRoute.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Outbound IMAPS (993) for paperless' mail import. OFF, and it has to be a
|
||||
# value rather than something the chart derives: the mail accounts are ROWS
|
||||
# IN THE DATABASE, entered in the web UI, so nothing in these values says
|
||||
# whether a release fetches mail. Switching this on is the operator saying
|
||||
# that it does.
|
||||
#
|
||||
# 993 ONLY, deliberately. Plain IMAP (143) and POP3 (110, 995) are not
|
||||
# covered - a value named mailImport that opened four ports would be wider
|
||||
# than its name - and belong in extraPorts below.
|
||||
#
|
||||
# NOTE THE DIFFERENCE FROM THE TIKA RULE: 993 is the real destination port,
|
||||
# because a mail server outside the cluster is reached with no Service and
|
||||
# so no destination NAT in the path. What decides whether an egress rule
|
||||
# needs the Service port or the pod port is that NAT, and nothing else.
|
||||
mailImport: false
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# PLAIN IMAP (143) and POP3 (110, 995) go here - IMAPS 993 has its own
|
||||
# switch above. Also a Postgres or Redis on a non-standard port, and a Tika
|
||||
# or Gotenberg that listens on neither its chart's container port nor 80.
|
||||
#
|
||||
# These are POD ports for anything inside the cluster, for the reason given
|
||||
# at the top of this block: a ClusterIP Service's port is translated away
|
||||
# before the policy sees the packet. For a destination outside the cluster
|
||||
# there is no translation and the port is simply the one being dialled.
|
||||
extraPorts: []
|
||||
+1
-1
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/PatchMon/PatchMon/main/frontend/public/a
|
||||
|
||||
type: application
|
||||
|
||||
version: 7.1.0+up2.1.3
|
||||
version: 8.0.0+up2.1.3
|
||||
appVersion: "2.1.3"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -147,3 +147,54 @@ SCALED TO ZERO
|
||||
retrying, so nothing is lost; they simply report nothing until you set it
|
||||
back and upgrade again.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 3000 only. Outbound: DNS, TCP 5432 (Postgres), 6379 (Redis) and
|
||||
443 (OIDC){{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THOSE ARE THE STANDARD PORTS, NOT YOUR CONFIGURED ONES — all three
|
||||
dependencies arrive as connection details inside 1Password items this chart
|
||||
never parses. A dependency elsewhere is blocked; add its port to
|
||||
networkPolicy.egress.extraPorts.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,188 @@
|
||||
{{- /*
|
||||
NetworkPolicy for patchmon (Gitea #5).
|
||||
|
||||
PatchMon has three outbound dependencies and all three arrive as connection
|
||||
details inside 1Password items the chart never parses: Postgres, Redis and an
|
||||
OIDC provider. So the egress rules name the STANDARD ports (5432, 6379, 443)
|
||||
and nothing else, and a deployment whose dependency sits elsewhere is blocked
|
||||
until networkPolicy.egress.extraPorts says so.
|
||||
|
||||
Note the pod label this policy selects: the bare release-and-chart name,
|
||||
without the -deployment suffix most charts here use.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := .Values.ingress.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects this chart's workload. Note the label: it is the bare
|
||||
release-and-chart name with NO -deployment suffix, unlike most charts
|
||||
here - copying a selector from a neighbouring chart would match nothing
|
||||
and leave this policy filtering nothing at all, which is why
|
||||
ci/run-networkpolicy-test.sh holds it against the render.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there IS something to restrict: this workload
|
||||
needs DNS and the ports named below, and nothing else. A chart whose
|
||||
workload opens no outbound connection of its own must NOT list Egress -
|
||||
valkey is the example - because a rule that constrains nothing makes the
|
||||
object look stricter than it is.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
3000 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 3000
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress goes dark the
|
||||
moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
PostgreSQL on the STANDARD port. The connection details live in a 1Password
|
||||
item the chart never parses, so this is the conventional port and not the
|
||||
configured one; a Postgres anywhere else is blocked and belongs in
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 5432
|
||||
{{- /*
|
||||
Redis/Valkey on the STANDARD port, same reasoning as Postgres above: the URL
|
||||
sits in a secret this chart does not read.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 6379
|
||||
{{- /*
|
||||
Outbound HTTPS, for the OIDC provider: the chart fetches the issuer's
|
||||
configuration and exchanges tokens over it, and the issuer URL lives inside a
|
||||
1Password item the chart never parses. 443 to any destination is as narrow as
|
||||
this object gets for that - a hostname cannot appear in a NetworkPolicy. An
|
||||
issuer on another port (a CI dex on 5556) needs
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -224,3 +224,81 @@ secrets:
|
||||
postgresSecretRef: null
|
||||
oidcSecretRef: null
|
||||
patchmonSecretRef: null
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 3000 only, and outbound DNS plus TCP 5432
|
||||
# (Postgres), 6379 (Redis) and 443 (the OIDC provider).
|
||||
#
|
||||
# WHAT IT DOES NOT DO: those three are the STANDARD ports, not the configured
|
||||
# ones. All three dependencies arrive as connection details inside 1Password
|
||||
# items this chart never parses, so it cannot know where they listen. A
|
||||
# dependency on another port is BLOCKED and belongs in egress.extraPorts.
|
||||
#
|
||||
# Inbound 3000 is not restricted by source in the default (probe port), and a
|
||||
# policy is only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 3000, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# Add the real port whenever Postgres, Redis or the OIDC issuer is not on
|
||||
# 5432 / 6379 / 443 - a self-hosted issuer on 8443, for instance.
|
||||
extraPorts: []
|
||||
+1
-1
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/lukevella/rallly/main/apps/landing/publi
|
||||
|
||||
type: application
|
||||
|
||||
version: 8.2.0+up4.15.4
|
||||
version: 9.0.0+up4.15.4
|
||||
appVersion: "4.15.4"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -244,3 +244,56 @@ SCALED TO ZERO
|
||||
until you set it back and upgrade again. Secrets and Service{{ if .Values.ingress.enabled }}, and the Ingress
|
||||
with its certificate,{{ else if $httpRoute.enabled }}, and the HTTPRoute,{{ end }} stay in place.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 3000 only. Outbound: DNS, TCP 5432 (Postgres) and 443 (OIDC){{ if .Values.rallly.smtp.enabled }},
|
||||
plus 587 and 465 for mail submission (rallly.smtp.enabled is true){{ else }}.
|
||||
No SMTP rule is rendered, because rallly.smtp.enabled is false{{ end }}{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }}, plus
|
||||
TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THOSE ARE THE STANDARD PORTS, NOT YOUR CONFIGURED ONES. A mail server on 25
|
||||
or 2525, or an OIDC issuer that is not on 443, is blocked until its port is in
|
||||
networkPolicy.egress.extraPorts — and a blocked mail server shows up as
|
||||
invitations that are never delivered, with a Ready pod behind it.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
@@ -0,0 +1,197 @@
|
||||
{{- /*
|
||||
NetworkPolicy for rallly (Gitea #5).
|
||||
|
||||
Rallly reaches a Postgres, an OIDC provider and - when rallly.smtp.enabled is
|
||||
true - a mail server. The SMTP rule is the one thing in this sweep that is
|
||||
DERIVED from an existing value rather than always rendered: with SMTP switched
|
||||
off there is no mail traffic to permit, and a rule that permits nothing makes
|
||||
the object look stricter than it is.
|
||||
|
||||
The ports are the standard ones, because every one of these dependencies
|
||||
arrives as connection details inside a 1Password item the chart never parses.
|
||||
|
||||
WHAT THIS OBJECT IS: a ceiling on reachability, not an authentication layer.
|
||||
Only the ports declared below are reachable at all - whatever else the process
|
||||
binds, now or after the next app update, is blocked without anyone having to
|
||||
notice it exists.
|
||||
|
||||
WHAT IT IS NOT:
|
||||
- EGRESS IS COARSE. A NetworkPolicy matches CIDRs and selectors and NEVER
|
||||
hostnames, so "only to the database host" cannot be expressed at all. This
|
||||
cluster's CNI is Canal (Flannel plus Calico for policy) and has no FQDN
|
||||
rule; Calico's GlobalNetworkSet could express one but would bind this chart
|
||||
to Calico, the same argument that kept implementation-specific objects out
|
||||
of the Gateway-API sweep (#114). Each egress rule therefore permits its
|
||||
PORT to any destination.
|
||||
- NOT A BOUNDARY WHERE THE CNI DOES NOT ENFORCE ONE. An unenforced policy is
|
||||
accepted by the API server and filters nothing, so everything reads as
|
||||
configured while nothing is filtered.
|
||||
- THE REASONING IS IN TEMPLATE COMMENTS, not in "#" comments: those are part
|
||||
of the rendered object, travel into the cluster and appear in every release
|
||||
diff. ci/run-networkpolicy-test.sh fails on a rendered "#".
|
||||
|
||||
THE PORT NUMBERS BELOW ARE POD PORTS, NEVER NODEPORTS. A NetworkPolicy is
|
||||
evaluated at the pod's network interface, after kube-proxy has already
|
||||
translated a NodePort to the targetPort, so a NodePort number here would match
|
||||
nothing while looking strict - and, being the only rule for that port, would
|
||||
block every inbound connection instead. ci/run-networkpolicy-test.sh asserts
|
||||
every port here against the containerPorts of the pod spec this policy
|
||||
selects.
|
||||
*/ -}}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
{{- $np := .Values.networkPolicy }}
|
||||
{{- $ns := .Release.Namespace }}
|
||||
{{- $probeSources := $np.probeSources | default list }}
|
||||
{{- $allowedNs := $np.allowedNamespaces | default list }}
|
||||
{{- $ic := $np.ingressController | default dict }}
|
||||
{{- $routed := .Values.ingress.enabled }}
|
||||
apiVersion: networking.k8s.io/v1
|
||||
kind: NetworkPolicy
|
||||
metadata:
|
||||
name: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
labels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy
|
||||
spec:
|
||||
{{- /*
|
||||
Selects the Deployment's pods. ci/run-networkpolicy-test.sh fails if
|
||||
this matches no pod spec of the same render - which is the mistake that
|
||||
would otherwise leave a policy in the namespace filtering nothing, and
|
||||
its usual cause is a label renamed in the workload template.
|
||||
*/}}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
app: {{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
policyTypes:
|
||||
- Ingress
|
||||
{{- /*
|
||||
Egress is listed because there IS something to restrict: this workload
|
||||
needs DNS and the ports named below, and nothing else. A chart whose
|
||||
workload opens no outbound connection of its own must NOT list Egress -
|
||||
valkey is the example - because a rule that constrains nothing makes the
|
||||
object look stricter than it is.
|
||||
*/}}
|
||||
- Egress
|
||||
ingress:
|
||||
{{- /*
|
||||
3000 - the only port this pod declares, the one the Service forwards 80 to, and
|
||||
the port all three probes address. The probe path.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 3000
|
||||
{{- if $probeSources }}
|
||||
{{- /*
|
||||
RESTRICTED, because the operator supplied probeSources. The kubelet's probes
|
||||
come from the IP of the WORKER NODE running the pod, so that address has to be
|
||||
in the list or the pod never becomes Ready - and a pod that is never Ready
|
||||
reads as a broken application rather than as a policy.
|
||||
|
||||
The ingress controller is added to the same rule, or the Ingress goes dark the
|
||||
moment this list is filled.
|
||||
*/}}
|
||||
from:
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
{{- /*
|
||||
Set by Kubernetes itself on every namespace (>= 1.21), so this needs no
|
||||
labelling work on a namespace this chart does not own.
|
||||
*/}}
|
||||
kubernetes.io/metadata.name: {{ $ns }}
|
||||
{{- if and $routed $ic.namespace }}
|
||||
{{- /*
|
||||
ONE from-entry with TWO selectors, which is an AND: pods carrying these labels
|
||||
IN that namespace. Written as two list entries it would be an OR, and would
|
||||
open the port to every pod in kube-system.
|
||||
*/}}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ $ic.namespace | quote }}
|
||||
{{- with $ic.podLabels }}
|
||||
podSelector:
|
||||
matchLabels:
|
||||
{{- toYaml . | nindent 14 }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- range $allowedNs }}
|
||||
- namespaceSelector:
|
||||
matchLabels:
|
||||
kubernetes.io/metadata.name: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- range $probeSources }}
|
||||
- ipBlock:
|
||||
cidr: {{ . | quote }}
|
||||
{{- end }}
|
||||
{{- else }}
|
||||
{{- /*
|
||||
NO "from" SELECTOR, WHICH MEANS OPEN - deliberately, and only inside the
|
||||
cluster, because this port carries no NodePort. The alternative was to guess
|
||||
the worker node CIDRs, and a wrong guess blocks every kubelet probe: the pod
|
||||
stays un-Ready, the rollout times out, and the cause looks like the
|
||||
application. An empty "from: []" would be worse than either - it allows
|
||||
everything too, but while reading as a restriction. Narrow it with
|
||||
networkPolicy.probeSources.
|
||||
*/}}
|
||||
{{- end }}
|
||||
egress:
|
||||
{{- /*
|
||||
DNS, unconditionally. There is no value to switch this off, and that is
|
||||
deliberate: a knob whose only other setting breaks every name lookup in
|
||||
the pod is a trap and not a feature.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: UDP
|
||||
port: 53
|
||||
- protocol: TCP
|
||||
port: 53
|
||||
{{- /*
|
||||
PostgreSQL on the STANDARD port. The connection details live in a 1Password
|
||||
item the chart never parses, so this is the conventional port and not the
|
||||
configured one; a Postgres anywhere else is blocked and belongs in
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 5432
|
||||
{{- /*
|
||||
Outbound HTTPS, for the OIDC provider: the chart fetches the issuer's
|
||||
configuration and exchanges tokens over it, and the issuer URL lives inside a
|
||||
1Password item the chart never parses. 443 to any destination is as narrow as
|
||||
this object gets for that - a hostname cannot appear in a NetworkPolicy. An
|
||||
issuer on another port (a CI dex on 5556) needs
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 443
|
||||
{{- if .Values.rallly.smtp.enabled }}
|
||||
{{- /*
|
||||
SMTP submission, both conventional ports - 587 (STARTTLS) and 465 (implicit
|
||||
TLS) - because the chart cannot tell which one the configured server uses: the
|
||||
host and port live in secrets.smtpSecretRef, which this chart never parses.
|
||||
|
||||
RENDERED ONLY WHILE rallly.smtp.enabled IS TRUE. With mail switched off there
|
||||
is nothing to permit, and a rule that permits nothing makes the object look
|
||||
stricter than it is. A mail server on 25 or 2525 needs
|
||||
networkPolicy.egress.extraPorts.
|
||||
*/}}
|
||||
- ports:
|
||||
- protocol: TCP
|
||||
port: 587
|
||||
- protocol: TCP
|
||||
port: 465
|
||||
{{- end }}
|
||||
{{- with $np.egress }}
|
||||
{{- with .extraPorts }}
|
||||
{{- /*
|
||||
Ports only, to any destination - see the header. This is the operator's
|
||||
escape hatch from the egress cap, and the only alternative to switching
|
||||
the whole policy off.
|
||||
*/}}
|
||||
- ports:
|
||||
{{- range . }}
|
||||
- protocol: TCP
|
||||
port: {{ int . }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
{{- end }}
|
||||
@@ -9,6 +9,57 @@
|
||||
"description": "Helm's conventional cross-chart values. Unused by this chart, kept open so an umbrella install cannot break on it.",
|
||||
"type": "object"
|
||||
},
|
||||
"networkPolicy": {
|
||||
"description": "The chart's NetworkPolicy (Gitea #5), on by default. A ceiling on reachability and not an authentication layer: only the declared container ports are reachable at all, egress is capped by PORT (a NetworkPolicy matches CIDRs and selectors, never hostnames, so a destination host cannot be expressed), and ingress is capped by source for every port no network probe touches. Only a boundary where the cluster's CNI enforces policies - an unenforced policy is accepted by the API server and filters nothing. The template's header carries the full list of what it does not do.",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"allowedNamespaces": {
|
||||
"description": "Namespaces whose pods may reach this workload, in addition to the release's own namespace, which is always allowed. Matched on the kubernetes.io/metadata.name label Kubernetes sets on every namespace itself, so no labelling work is needed - and no typo protection either: a name that does not exist matches nothing and is silently ineffective. An entry opens the port to EVERY pod in that namespace; for the ingress controller use ingressController instead.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"probeSources": {
|
||||
"description": "Source CIDRs allowed to reach the port the network probes address. EMPTY MEANS OPEN, not blocked: with no entry that rule is rendered without a \"from\" selector. The kubelet's probes come from the IP of the worker node running the pod, an address the chart cannot know and must not guess - a guessed CIDR that excludes the real node blocks every probe and the pod never becomes Ready, which reads as a broken application rather than as a policy. Setting this restricts the rule, which is why the chart adds the own namespace, ingressController and allowedNamespaces to the same rule.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"ingressController": {
|
||||
"description": "The ingress controller allowed to reach the routed port once probeSources restricts it; rendered only while ingress.enabled or httpRoute.enabled is true. The two keys become ONE \"from\" entry and are therefore an AND - pods carrying podLabels IN namespace - which is the whole point: the controller's namespace in allowedNamespaces would open the port to every pod in kube-system. The default is measured on this cluster (DaemonSet rke2-traefik in kube-system, which also serves the Gateway API here), not assumed; a policy written against the wrong controller is accepted, looks strict and silently blocks all web traffic.",
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"namespace": {
|
||||
"type": ["string", "null"]
|
||||
},
|
||||
"podLabels": {
|
||||
"description": "Label set the controller's pods carry, rendered verbatim as a podSelector's matchLabels. Kept open because the chart does not interpret the keys.",
|
||||
"type": ["object", "null"]
|
||||
}
|
||||
}
|
||||
},
|
||||
"egress": {
|
||||
"type": ["object", "null"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"extraPorts": {
|
||||
"description": "Additional outbound TCP ports, to ANY destination - ports and not destinations, because a NetworkPolicy cannot express a hostname. DNS is always allowed and has no switch. Without an entry here an outbound port the chart does not already derive is blocked, which is the cap's whole purpose and also its upgrade risk.",
|
||||
"type": ["array", "null"],
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scaleDown": {
|
||||
"type": "boolean"
|
||||
},
|
||||
|
||||
@@ -186,3 +186,83 @@ httpRoute:
|
||||
# the provider is built from ingress.domain - a new name needs both sides
|
||||
# updated or logins fail on a redirect-uri mismatch while the pod stays green.
|
||||
hostnames: []
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# NetworkPolicy (Gitea #5). On by default. The reference implementation with
|
||||
# the full reasoning is template-chart; the convention is in README, "Chart
|
||||
# style guidelines", and the operator's view on this chart's wiki page.
|
||||
# ---------------------------------------------------------------------------
|
||||
networkPolicy:
|
||||
# WHAT THIS POLICY ALLOWS: inbound 3000 only, and outbound DNS plus TCP 5432
|
||||
# (Postgres), 443 (the OIDC provider) and - only while rallly.smtp.enabled is
|
||||
# true - 587 and 465 for mail submission.
|
||||
#
|
||||
# WHAT IT DOES NOT DO: all of those are STANDARD ports, not configured ones.
|
||||
# The database, the issuer and the mail server all arrive as connection
|
||||
# details inside 1Password items this chart never parses, so a dependency
|
||||
# anywhere else is BLOCKED - a mail server on 25 or 2525 above all. Put it in
|
||||
# egress.extraPorts.
|
||||
#
|
||||
# Inbound 3000 is not restricted by source in the default (probe port), and a
|
||||
# policy is only a boundary where the CNI enforces one.
|
||||
enabled: true
|
||||
# Namespaces whose pods may reach this workload, in addition to the release's
|
||||
# own namespace, which is always allowed. Empty means: own namespace only.
|
||||
#
|
||||
# Matched on the "kubernetes.io/metadata.name" label Kubernetes sets on every
|
||||
# namespace itself, so no labelling work is needed on a namespace this chart
|
||||
# does not own - and no typo protection either: a name that does not exist
|
||||
# matches nothing and is silently ineffective. Note the granularity: an entry
|
||||
# opens the port to EVERY pod in that namespace.
|
||||
allowedNamespaces: []
|
||||
# Source CIDRs allowed to reach port 3000, which is the port all three probes address.
|
||||
#
|
||||
# EMPTY MEANS OPEN, NOT BLOCKED. With no entry that rule is rendered WITHOUT a
|
||||
# "from" selector, so the port is reachable from anywhere the CNI routes to -
|
||||
# inside the cluster, since it carries no NodePort.
|
||||
#
|
||||
# That is the deliberate choice between two bad defaults. The kubelet's probes
|
||||
# originate from the IP of the WORKER NODE running the pod, an address this
|
||||
# chart cannot know and must not guess: a CIDR that excludes the real node
|
||||
# blocks every probe, the pod never becomes Ready, the rollout times out, and
|
||||
# the symptom reads as a broken application rather than as a policy.
|
||||
#
|
||||
# Narrow it by listing the worker node IPs (e.g. ["10.0.1.11/32"]) - and mind
|
||||
# the companion trap: once this list is non-empty the rule IS restricted, so
|
||||
# everything else that needs the port has to be in it. The chart adds the own
|
||||
# namespace, the ingressController below and allowedNamespaces to the same rule for exactly that reason.
|
||||
probeSources: []
|
||||
# The ingress controller allowed to reach the routed port once probeSources
|
||||
# restricts it. Rendered only while ingress.enabled is true, and only in
|
||||
# the restricted branch - with the default (open) rule the controller reaches
|
||||
# the port anyway. The two keys become ONE "from" entry and are therefore an
|
||||
# AND: pods carrying podLabels IN namespace. That is the point of having them
|
||||
# at all - the controller's namespace in allowedNamespaces would open the port
|
||||
# to every pod in kube-system.
|
||||
#
|
||||
# MEASURED ON THIS CLUSTER, NOT ASSUMED (2026-10-14): ingress-nginx is gone,
|
||||
# the only IngressClass is "traefik" and it is the default, and the controller
|
||||
# is the DaemonSet rke2-traefik in kube-system. The same Traefik serves the
|
||||
# Gateway API here, so this one source covers the Ingress and the HTTPRoute
|
||||
# path alike. A policy written against the wrong controller is accepted, looks
|
||||
# strict, and silently blocks all web traffic - and ingress.className says
|
||||
# nothing about it, because a class names an implementation, not the pods the
|
||||
# traffic comes from.
|
||||
ingressController:
|
||||
namespace: kube-system
|
||||
podLabels:
|
||||
app.kubernetes.io/name: rke2-traefik
|
||||
egress:
|
||||
# Additional outbound TCP ports. DNS (UDP and TCP 53) is always allowed and
|
||||
# has no switch - a knob whose only other setting breaks every name lookup
|
||||
# in the pod is a trap, not a feature.
|
||||
#
|
||||
# PORTS, NOT DESTINATIONS, and that is a limit of the object rather than
|
||||
# laziness: a NetworkPolicy matches CIDRs and selectors and never hostnames,
|
||||
# so "only to the database host" cannot be written at all. Each entry
|
||||
# permits its port to ANY destination. What the cap still buys is real: a
|
||||
# compromised pod cannot open arbitrary outbound connections.
|
||||
#
|
||||
# The usual entries here are a mail server on 25 or 2525, or an OIDC issuer
|
||||
# that is not on 443.
|
||||
extraPorts: []
|
||||
@@ -5,7 +5,7 @@ icon: https://raw.githubusercontent.com/RSS-Bridge/rss-bridge/master/static/logo
|
||||
|
||||
type: application
|
||||
|
||||
version: 2.1.1+up2026.09.30
|
||||
version: 3.0.0+up2026.09.30
|
||||
appVersion: "2026-09-30"
|
||||
|
||||
maintainers:
|
||||
|
||||
@@ -114,3 +114,55 @@ Useful to know:
|
||||
WARNING: scaleDown is true, so this release is running with 0 replicas.
|
||||
Set scaleDown=false to bring it back up.
|
||||
{{- end }}
|
||||
{{- if .Values.networkPolicy.enabled }}
|
||||
|
||||
NETWORKPOLICY IS ACTIVE — WHAT IT CAPS, AND WHAT IT DOES NOT
|
||||
{{ .Release.Name }}-{{ .Chart.Name }}-networkpolicy selects this workload's pods.
|
||||
Inbound: TCP 80 only. Outbound: DNS plus TCP 80 and 443 to ANY destination{{ with .Values.networkPolicy.egress }}{{ with .extraPorts }},
|
||||
plus TCP {{ join ", " . }}{{ end }}{{ end }}.
|
||||
|
||||
THE EGRESS RULE IS THE OPEN INTERNET ON TWO PORTS, and it has to be: fetching
|
||||
other people's websites is what RSS-Bridge does, and a NetworkPolicy matches
|
||||
CIDRs and selectors but never hostnames, so "only the configured bridges"
|
||||
cannot be written. What the cap buys is that this pod can open NO other
|
||||
outbound port — not a database, not SMTP, not SSH.
|
||||
|
||||
Three limits belong in the same breath, because none of them is visible in
|
||||
the object itself:
|
||||
|
||||
- EGRESS IS BY PORT, NEVER BY DESTINATION. A NetworkPolicy matches CIDRs and
|
||||
selectors and cannot express a hostname, so every egress rule permits its
|
||||
port to ANY address. That is a limit of the object, not a shortcut — this
|
||||
cluster's CNI (Canal: Flannel plus Calico) has no FQDN rule either. An
|
||||
outbound port the chart does not know about is BLOCKED: add it to
|
||||
networkPolicy.egress.extraPorts, and expect to find out through an
|
||||
application-level connection error rather than through this object.
|
||||
{{- if .Values.networkPolicy.probeSources }}
|
||||
- THE PROBE PATH IS RESTRICTED in this release, because
|
||||
networkPolicy.probeSources is set to
|
||||
{{ join ", " .Values.networkPolicy.probeSources }}
|
||||
Probes come from the IP of the WORKER NODE running the pod. If none of those
|
||||
CIDRs covers the node this pod lands on, the kubelet's probes are dropped
|
||||
and THE POD NEVER BECOMES READY — the rollout then times out and the symptom
|
||||
looks like a broken application. Compare
|
||||
|
||||
kubectl -n {{ .Release.Namespace }} describe pod -l app={{ .Release.Name }}-{{ .Chart.Name }}-deployment
|
||||
|
||||
against `kubectl get node -o wide`.
|
||||
{{- else }}
|
||||
- THE PROBED PORT IS OPEN INSIDE THE CLUSTER. networkPolicy.probeSources is
|
||||
empty, so that rule carries no source selector at all and any pod the CNI
|
||||
routes to can reach it. Not from the internet — but this is NOT pod-level
|
||||
isolation. Narrowing it means listing the worker node IPs in
|
||||
networkPolicy.probeSources, because the kubelet probes from the node's own
|
||||
address and the chart cannot know it; a wrong guess there leaves the pod
|
||||
permanently un-Ready.
|
||||
{{- end }}
|
||||
- IT IS ONLY A BOUNDARY WHERE THE CNI ENFORCES POLICIES. Where it does not,
|
||||
this object is accepted and filters nothing, so everything reads as
|
||||
configured while nothing is filtered. `kubectl -n {{ .Release.Namespace }} get networkpolicy`
|
||||
shows the object exists; only a connection attempt from an unrelated
|
||||
namespace shows that it bites.
|
||||
|
||||
Switch it off with networkPolicy.enabled: false.
|
||||
{{- end }}
|
||||
Loaded 100 of 158 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user