From 9ac54d1872432857c61e6bf4e5254fdf1130a531 Mon Sep 17 00:00:00 2001 From: Toni Finger Date: Tue, 1 Oct 2024 10:02:46 +0200 Subject: [PATCH] Update conformance-tests-sonobuoy.md Signed-off-by: Toni Finger --- .../development/tests/conformance-tests-sonobuoy.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/contributor-docs/development/tests/conformance-tests-sonobuoy.md b/contributor-docs/development/tests/conformance-tests-sonobuoy.md index 9fd1a74dd2..de558a59e0 100644 --- a/contributor-docs/development/tests/conformance-tests-sonobuoy.md +++ b/contributor-docs/development/tests/conformance-tests-sonobuoy.md @@ -6,7 +6,7 @@ Hence this reduces the effort required to establish SCS conformity to a minimum. 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. -> [!NOTE] +> [!NOTE] > A more detailed description of why the SCS has decided to use sonobuoys can be found on the corresponding [Decsision Record][sonbouy-decision-record]. > In addition, sonobuoy is also used as the toolset for executing Kubernetes very own [conformance tests][k8s-conformance]. @@ -15,7 +15,7 @@ This requires a user to write the conformance tests in Golang, as this is the la ## Step-by-step instructions for the development of sonobuoy tests using `docker` and `kind` -> [!NOTE] +> [!NOTE] > This guide refers to the brief instructions provided in the [standards repository][scs-sonobuoy-example-guide] ### Prerequisite @@ -70,7 +70,7 @@ In general, SCS tests for KaaS are derived from standards that define certain ex As an example for this step-by-step guide, let's assume a scenario in which there is a fictional standard called "scs-0299-v1-example-standard.md". Pretend that the fictitious standard here stipulates that at least one pod MUST run in the namespace "namespace-test-a". -> [!NOTE] +> [!NOTE] > The functions and behaviors to be tested MUST be precisely defined in a standard. > If you as a developer want to test something that you think is best tested but is not yet part of any standard, you MUST update the standard accordingly. @@ -183,7 +183,7 @@ cat results/plugins/scsconformance/sonobuoy_results.yaml | yq Once all tests have been executed successfully, you can read the results and receive feedback. You can call up the results as follows: -> [!NOTE] +> [!NOTE] > TODO:!!! to be described in more detail ### Clean up after