Skip to content

Commit e8d6556

Browse files
committed
Update guideline instructions
Signed-off-by: Toni Finger <toni.finger@cloudandheat.com>
1 parent b60e0ee commit e8d6556

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

contributor-docs/development/tests/conformance-tests-sonobuoy.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ status: Draft
55
track: Global
66
---
77

8-
SovereignCloudStack (SCS) makes use of [Sonobuoy][sonobuoy]] as a test framework to run its tests on Kubernetes clusters, which are to be audited for compliance.
8+
SovereignCloudStack (SCS) makes use of [Sonobuoy][sonobuoy] as a test framework to run its tests on Kubernetes clusters, which are to be audited for compliance.
99
The aim of using this framework is to make the execution of tests on a KaaS infrastructure as simple as possible.
1010
Hence this reduces the effort required to establish SCS conformity to a minimum.
1111

1212
In short this is achieved by storing all tests in a container image, which can then be called and launched on the clusters managed by sonoobuoy.
1313

14-
> A more detailed description of why the SCS has decided to use sonobuoys can be found on the corresponding [Decsision Record][sonbouy-decision-record]
14+
> A more detailed description of why the SCS has decided to use sonobuoys can be found on the corresponding [Decsision Record][sonbouy-decision-record].
1515
> In addition, sonobuoy is also used as the toolset for executing Kubernetes very own [conformance tests][k8s-conformance].
1616
1717

@@ -192,28 +192,27 @@ sonobuoy status
192192
Once all tests have been executed successfully, you can read the results and receive feedback.
193193
You can call up the results as follows:
194194

195-
```
196-
TODO:!!! be described in more detail
197-
```
195+
> TODO:!!! to be described in more detail
196+
198197

199198

200199

201200
## Clean up after:
202201

202+
To clean up the resourcec used for development, you can use the following commands:
203+
203204
```
204205
make dev-clean
205206
make dev-purge
206207
```
207208

208209

209-
210210
[sonobuoy]: https://sonobuoy.io/
211211
[sonbouy-decision-record]: https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-0200-v1-using-sonobuoy-for-kaas-conformance-tests.md
212212
[k8s-conformance]: https://github.com/cncf/k8s-conformance/blob/master/instructions.md
213213

214214
[kaas-sonobuoy-example] https://github.com/SovereignCloudStack/standards/tree/main/Tests/kaas/kaas-sonobuoy-go-example-e2e-framework#sonobuoy-usage-for-development-of-tests
215215

216-
217216
[docker-installation] https://docs.docker.com/engine/install/
218217
[sonobuoy-installation] https://sonobuoy.io/docs/v0.57.1/#installation
219218
[kind-installation]https://kind.sigs.k8s.io/docs/user/quick-start/#installation

0 commit comments

Comments
 (0)