Parse, explain, and probe network policies to understand their implications and help design policies that suit your needs!
Users: check out the:
Developers: check out the Developer guide
cyclonus analyze: leverage network policy engine to precisely understand your policiescyclonus generate: run network policy conformance test suites on a clustercyclonus probe: run a single network policy test on a cluster
If you're looking for the official kubernetes network policy tool, check out: https://github.com/kubernetes-sigs/network-policy-api . Active development of network policy verification is continuing there.
https://github.com/mattfenwick/cyclonus will remain open and be used for research, experimentation, and hacking!
Cyclonus is available as a krew/kubectl plugin:
- Set up krew
- install:
kubectl krew install cyclonus - use:
kubectl cyclonus -h
Antrea testing: Cyclonus runs network policy tests for Antrea on a daily basis.
Cilium testing: Cyclonus runs network policy tests for Cilium on a daily basis.
Sonobuoy plugin: run Cyclonus tests through Sonobuoy.
Testing network policies for CNI providers on Kubernetes has historically been very difficult, requiring a lot of boilerplate.
This was recently improved upstream via truth table based tests:
- KEP: "Architecting NetworkPolicy tests with a DSL for better upstream test coverage of all CNIs"
- kubernetes PR: "new NetworkPolicy Validation suite"
Cyclonus is the next evolution: in addition to truth-table connectivity tests, it adds two new components:
- a powerful network policy engine implementing the Kubernetes network policy specification
- a test case generator, allowing for easy testing of hundreds of network policy scenarios
Cyclonus aims to make network policies and implementations easy to understand, easy to use correctly, and easy to verify.
- @dougsland
- @jayunit100
- @johnSchnake
- @enhaocui
- @matmerr
- @huntergregory
- @jaydeokar