Skip to content

Commit f2f74d0

Browse files
committed
rename doc files; fix typo; clarify readme
1 parent ede50bf commit f2f74d0

5 files changed

+22
-13
lines changed

README.md

+21-12
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,18 @@ policies that suit your needs!
77

88
## Quickstart
99

10-
Users: check out our [Quickstart guide](./docs/quickstart.md)
10+
Users: check out the:
1111

12-
Developers: check out our [Developer guide](./docs/developer-guide.md)
12+
- [Quickstart guide](./docs/quickstart.md)
13+
- [understand test runs](./docs/test-runs.md)
1314

14-
Cyclonus functionality:
15+
Developers: check out the [Developer guide](./docs/developer-guide.md)
1516

16-
- [run a single network policy test on a cluster](./docs/probe.md)
17-
- [run network policy conformance tests on a cluster](./docs/generator.md)
18-
- [understand test runs](./docs/test-runs.md)
19-
- [analyze network policies](./docs/analyze.md)
17+
Cyclonus subcommands:
18+
19+
- `cyclonus probe`: [run a single network policy test on a cluster](./docs/command-probe.md)
20+
- `cyclonus generate`: [run network policy conformance test suites on a cluster](./docs/command-generate.md)
21+
- `cyclonus analyze`: [analyze network policies](./docs/command-analyze.md)
2022

2123

2224
## Integrations
@@ -36,11 +38,18 @@ Cyclonus is available as a [**krew/kubectl plugin**](https://github.com/mattfenw
3638

3739
## Motivation and History
3840

39-
Testing network policies for CNI providers on Kubernetes has historically been very difficult, requiring a lot of boiler plate.
40-
This was recently improved upstream via truth table based tests
41-
([see KEP](https://github.com/kubernetes/enhancements/tree/master/keps/sig-network/1611-network-policy-validation)).
42-
Cyclonus is the next evolution of the truth table tests which are part of upstream Kubernetes.
43-
Cyclonus generates hundreds of network policies, their connectivity tables, and outputs results in the same, easy to read format.
41+
Testing network policies for CNI providers on Kubernetes has historically been very difficult,
42+
requiring a lot of boilerplate.
43+
44+
This was recently improved upstream via truth table based tests:
45+
- [see KEP](https://github.com/kubernetes/enhancements/tree/master/keps/sig-network/1611-network-policy-validation)
46+
- [see Kubernetes PR](https://github.com/kubernetes/kubernetes/pull/91592)
47+
48+
Cyclonus is the next evolution: in addition to truth-table connectivity tests, it adds two new components:
49+
- a powerful network policy engine implementing the Kubernetes network policy specification
50+
- a test case generator, allowing for easy testing of hundreds of network policy scenarios
51+
52+
Cyclonus aims to make network policies and implementations easy to understand, easy to use correctly, and easy to verify.
4453

4554
## Thanks to contributors
4655

File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/test-runs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ Expected egress:
501501
+---------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+-------------+
502502
```
503503

504-
### Piece 5: expect combined connectivity
504+
### Piece 5: expected combined connectivity
505505

506506
The third additional piece of data is the expected **combined** connectivity -- taking into account both ingress and egress
507507
expected connectivity.

0 commit comments

Comments
 (0)