From ed3e9114d643134f76eebaa5ba098065dcaecb9a Mon Sep 17 00:00:00 2001 From: simontesar Date: Tue, 27 Oct 2026 07:05:29 +0200 Subject: [PATCH 1/2] doc: README: reword introduction --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c72b0c..01aa93b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # metal-operator test framework -This repository aims to provide a set of capabilities a BMC-implementation needs to support to be usable with the [metal-operator](https://github.com/ironcore-dev/metal-operator), and a set of tests to verify these capabilities. Its goal is to enable BMC vendors or users to run these tests against a BMC with minimal effort and more easily determine what capabilities their BMC may be missing or implementing incorrectly. +The [metal-operator](https://github.com/ironcore-dev/metal-operator) test framework provides a set of tests that can be used to verify that a given BMC and server are compatible with the metal-oprator. Its goal is to enable BMC vendors or users to run these tests against a BMC with minimal effort and more easily determine what capabilities their BMC may be missing or implementing incorrectly. ## Capabilities Refer to [capability matrix](capability-matrix.md) for a list of capabilities and their descriptions. Refer to the [coverage document](coverage.md) for what tests cover which capabilities. Determine what your BMC might not implement by referring to a failed test. From cb55ffe53f4ee0102bf6463e6c0d1850f72ea8b1 Mon Sep 17 00:00:00 2001 From: simontesar Date: Tue, 27 Oct 2026 07:12:14 +0200 Subject: [PATCH 2/2] doc: reword "matrix" to "table" or omit term --- README.md | 2 +- capability-matrix.md => capabilities.md | 2 +- coverage.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename capability-matrix.md => capabilities.md (99%) diff --git a/README.md b/README.md index 01aa93b..93ce9d4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ The [metal-operator](https://github.com/ironcore-dev/metal-operator) test framework provides a set of tests that can be used to verify that a given BMC and server are compatible with the metal-oprator. Its goal is to enable BMC vendors or users to run these tests against a BMC with minimal effort and more easily determine what capabilities their BMC may be missing or implementing incorrectly. ## Capabilities -Refer to [capability matrix](capability-matrix.md) for a list of capabilities and their descriptions. Refer to the [coverage document](coverage.md) for what tests cover which capabilities. Determine what your BMC might not implement by referring to a failed test. +Refer to the [capability table](capabilities.md) for a list of capabilities and their descriptions. Refer to the [coverage document](coverage.md) for what tests cover which capabilities. Determine what your BMC might not implement by referring to a failed test. ## Test suite The `tests` directory contains a suite of tests based on [chainsaw](https://kyverno.github.io/chainsaw/latest/). Every test case creates k8s resources in steps and asserts their status before proceeding. Tests are independent of from the infrastructure they run on and respect `KUBECONFIG`. diff --git a/capability-matrix.md b/capabilities.md similarity index 99% rename from capability-matrix.md rename to capabilities.md index 9578e07..31f3a9c 100644 --- a/capability-matrix.md +++ b/capabilities.md @@ -1,4 +1,4 @@ -# Capability Matrix +# Capabilities This document specifies sets of capabilities a BMC needs to support to function with the metal-operator. Right now there is essentially one capability per method of the [`bmc.BMC`](https://github.com/ironcore-dev/metal-operator/blob/4d2a4eb1a372c9a01602a5bda26f6c9489393918/bmc/bmc.go#L191)-interface of the metal-operator. diff --git a/coverage.md b/coverage.md index 0631d8e..5bd8564 100644 --- a/coverage.md +++ b/coverage.md @@ -1,6 +1,6 @@ # Test Coverage -This document summarises what tests cover which capabilities in the [capability-matrix](capability-matrix.md). +This document summarises what tests cover which capabilities in the [capability table](capabilities.md). * A capability is **covered** when running the test makes the operator invoke the method. * A capability is **verified** when the test asserts that it has produced expected values.