kuttl

module

v0.25.0 Latest Latest Go to latest Published: Feb 16, 2026 License: Apache-2.0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kudobuilder/kuttl

Links

Open Source Insights

README ¶

KUTTL

KUbernetes Test TooL (KUTTL) provides a declarative approach to test Kubernetes Operators.

KUTTL is designed for testing operators, however it can declaratively test any kubernetes objects.

Getting Started

Please refer to the getting started guide documentation.

Resources

Initially Built under the KUDO project, we continue to use that channel for KUTTL.

Slack Channel: #kudo
Google Group: kudobuilder@googlegroups.com

Contributions

Please read the contributing guide for details around:

Code of Conduct
Code Culture
Details on how to contribute

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
kubectl-kuttl command Package main provides the kubectl-kuttl command-line interface.	Package main provides the kubectl-kuttl command-line interface.
internal
assert Package assert provides assertion functionality for KUTTL test harness.	Package assert provides assertion functionality for KUTTL test harness.
env Package env provides environment variable expansion functionality.	Package env provides environment variable expansion functionality.
expressions Package expressions provides Common Expression Language (CEL) evaluation functionality.	Package expressions provides Common Expression Language (CEL) evaluation functionality.
file Package file provides file manipulation and processing utilities.	Package file provides file manipulation and processing utilities.
harness Package harness provides the main test harness functionality for KUTTL.	Package harness provides the main test harness functionality for KUTTL.
http Package http provides HTTP client functionality for downloading files and making requests.	Package http provides HTTP client functionality for downloading files and making requests.
kind
kubernetes Package kubernetes provides utilities for working with Kubernetes clients and resources.	Package kubernetes provides utilities for working with Kubernetes clients and resources.
kubernetes/fake
kuttlctl/cmd Package cmd provides command-line interface commands for KUTTL.	Package cmd provides command-line interface commands for KUTTL.
report Package report provides test result reporting functionality in various formats.	Package report provides test result reporting functionality in various formats.
step
template Package template provides template processing functionality.	Package template provides template processing functionality.
testcase Package testcase provides test case execution functionality for KUTTL.	Package testcase provides test case execution functionality for KUTTL.
utils Package utils provides utility functions for commands, logging, and common operations.	Package utils provides utility functions for commands, logging, and common operations.
utils/events
utils/files Package files provides file utility functions for KUTTL.	Package files provides file utility functions for KUTTL.
version Package version provides version information for the application.	Package version provides version information for the application.
pkg
apis Package apis contains Kubernetes API groups.	Package apis contains Kubernetes API groups.
apis/testharness/v1beta1 Package v1beta1 contains API Schema definitions for the testharness API group.	Package v1beta1 contains API Schema definitions for the testharness API group.
test Package test provides a public API for KUTTL test harness functionality.	Package test provides a public API for KUTTL test harness functionality.