Skip to content

Commit ddf82ea

Browse files
authored
Update README.md (#15)
1 parent efa4546 commit ddf82ea

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
Version: 0.0.9
44

5+
Fast [Kuttl](https://kuttl.dev/) tests expander for Stackable integration tests.
6+
7+
```sh
8+
beku -i tests/test-definition.yaml -t tests/templates/kuttl -k tests/kuttl-test.yaml.jinja2 -o tests/_work
9+
```
10+
11+
`beku` parses a test definition YAML file together with a directory of templated Kuttl test definitions.
12+
From this it generates Kuttl test suites which can then be run with plain Kuttl.
13+
This was built on top of Kuttl to support running tests with different version combinations of products, or slightly different features enabled,
14+
without having to duplicate tests.
15+
516
## Installation
617

718
We recommend to use [pipx](https://pypa.github.io/pipx/):
@@ -52,14 +63,6 @@ cd tests/_work && kubectl kuttl test
5263

5364
Also see the `examples` folder.
5465

55-
## Description
56-
57-
Fast Kuttl tests expander for Stackable integration tests.
58-
59-
```sh
60-
beku -i tests/test-definition.yaml -t tests/templates/kuttl -k tests/kuttl-test.yaml.jinja2 -o tests/_work
61-
```
62-
6366
## Release a new version
6467

6568
Update the version in:

0 commit comments

Comments
 (0)