Skip to content

Commit febc6a9

Browse files
committed
Explain purpose and compatibility guarantee of util/test/builder
1 parent 880be0a commit febc6a9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

util/test/builder/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# "Generic" custom resource builder
2+
3+
This package helps create custom resources definitions of "generic" Cluster API resources. For example, resources for a "generic" infra provider, such as InfraClusters, InfraMachines, InfraTemplates, etc. These resources are used for testing Cluster API controllers that reconcile resources created by different infrastructure, bootstrap, and control-plane providers.
4+
5+
## Compatibility notice
6+
7+
This package does not adhere to any compatibility guarantees. This package is meant to be used by tests only.

0 commit comments

Comments
 (0)