Skip to content

docs: clarify network policy options in README - #2503

Merged
manuelbuil merged 1 commit into
flannel-io:masterfrom
locker95:docs/readme-network-policy
Jul 30, 2026
Merged

manuelbuil merged 1 commit into
flannel-io:masterfrom
locker95:docs/readme-network-policy

Conversation

@locker95

Copy link
Copy Markdown
Contributor

Summary

The README currently says network policy needs other projects such as Calico. That is incomplete now that the Helm chart can deploy the Kubernetes SIGs network policy controller (netpol.enabled), and it can read as if Flannel cannot be used with NetworkPolicy at all.

This updates the README to:

  • note that flanneld does not enforce policy itself
  • document the integrated Helm netpol option
  • point at Calico-for-flannel / Cilium chaining as third-party options
  • link to Documentation/netpol.md

Suggested wording was discussed in #2390.

Test plan

  • Checked links resolve
  • README still matches the intent in Documentation/netpol.md

Fixes #2390

@locker95
locker95 force-pushed the docs/readme-network-policy branch from e4b4c6d to 8387e17 Compare July 27, 2026 18:23
@locker95
locker95 force-pushed the docs/readme-network-policy branch 2 times, most recently from f62a0e1 to 10a6766 Compare July 28, 2026 18:18
flanneld itself does not enforce NetworkPolicy. Call out the Helm
netpol controller option and common third-party setups so the README
matches Documentation/netpol.md.

Fixes flannel-io#2390

Signed-off-by: Dean Chen <862469039@qq.com>
@locker95
locker95 force-pushed the docs/readme-network-policy branch from 10a6766 to 9d8d086 Compare July 29, 2026 09:26
@manuelbuil

Copy link
Copy Markdown
Collaborator

@locker95 are you a user of the network policy in flannel?

@locker95

Copy link
Copy Markdown
Contributor Author

@manuelbuil yeah — hit the README while wiring NetworkPolicy on a flannel cluster (helm netpol controller path). flanneld itself wasn't doing the enforcement so the old wording was a bit confusing; fixed it from that angle rather than being deep in netpol day-to-day.

@manuelbuil
manuelbuil merged commit d43022a into flannel-io:master Jul 30, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Flannel supports network policies but the README doesn't say it

2 participants