CRDs Reference

CRDs (Custom Resource Definitions) reference. Read more Testkube's CRDs in Testkube Custom Resources section.

Packages

• executor.testkube.io/v1
• tests.testkube.io/v1
• tests.testkube.io/v2
• tests.testkube.io/v3

executor.testkube.io/v1

Package v1 contains API Schema definitions for the executor v1 API group.

Resource Types

• Executor
• ExecutorList
• Webhook
• WebhookList

EventType

Underlying type: string

Appears in:

• WebhookSpec

Executor

Executor is the Schema for the executors API.

Appears in:

• ExecutorList

Field	Description
apiVersion string	executor.testkube.io/v1
kind string	Executor
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ExecutorSpec

ExecutorList

ExecutorList contains a list of Executors.

Field	Description
apiVersion string	executor.testkube.io/v1
kind string	ExecutorList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Executor array

ExecutorMeta

Executor meta data.

Appears in:

• ExecutorSpec

Field	Description
iconURI string	URI for executor icon
docsURI string	URI for executor docs
tooltips object (keys:string, values:string)	executor tooltips

ExecutorSpec

ExecutorSpec defines the desired state of the Executor.

Appears in:

• Executor

Field	Description
types string array	Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command", etc.
executor_type ExecutorType	ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube or "container" for container executors.
uri string	URI for rest-based executors.
image string	Image for kube-job.
args string array	Executor binary arguments.
command string array	Executor default binary command.
imagePullSecrets LocalObjectReference array	Container executor default image pull secrets.
features Feature array	Features list of Possible features which the executor handles.
content_types ScriptContentType array	ContentTypes lists the handled content types.
job_template string	Job template to launch executor.
meta ExecutorMeta	Meta data about the executor.

ExecutorType

Underlying type: string

Appears in:

• ExecutorSpec

Feature

Underlying type: string

Appears in:

• ExecutorSpec

ScriptContentType

Underlying type: string

Appears in:

• ExecutorSpec

Webhook

Webhook is the Schema for the webhooks API.

Appears in:

• WebhookList

Field	Description
apiVersion string	executor.testkube.io/v1
kind string	Webhook
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec WebhookSpec

WebhookList

WebhookList contains a list of Webhooks.

Field	Description
apiVersion string	executor.testkube.io/v1
kind string	WebhookList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Webhook array

WebhookSpec

WebhookSpec defines the desired state of a Webhook.

Appears in:

• Webhook

Field	Description
uri string	The URI is the address where the webhook should be made.
events EventType array	Events declares a list of events on which webhook should be called.
selector string	Labels to filter for tests and test suites.
payloadObjectField string	Will load the generated payload for notification inside the object.
payloadTemplate string	Golang based template for notification payload.
headers object (keys:string, values:string)	Webhook headers.

tests.testkube.io/v1

Package v1 contains API Schema definitions for the testkube v1 API group.

Resource Types

• Script
• ScriptList
• Test
• TestList
• TestSource
• TestSourceList
• TestSuite
• TestSuiteList
• TestTrigger
• TestTriggerList

GitAuthType

Underlying type: string

GitAuthType defines git auth type.

Appears in:

• Repository

Repository

Repository represents VCS repo, currently we're handling Git only.

Appears in:

• TestSourceSpec

Field	Description
type string	VCS repository type.
uri string	URI of content file or Git directory.
branch string	Branch/tag name for checkout.
commit string	Commit id (sha) for checkout.
path string	If needed, we can checkout a particular path (dir or file) in case of BIG/mono repositories.
usernameSecret SecretRef
tokenSecret SecretRef
certificateSecret string	Git auth certificate, secret for private repositories.
workingDir string	If provided, we checkout the whole repository and run the test from this directory.
authType GitAuthType	Auth type for Git requests.

Script

Script is the Schema for the scripts API.

Appears in:

• ScriptList

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	Script
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ScriptSpec

ScriptList

ScriptList contains a list of scripts.

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	ScriptList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Script array

ScriptSpec

ScriptSpec defines the desired state of a script.

Appears in:

• Script

Field	Description
type string	Script type.
name string	Script execution custom name.
params object (keys:string, values:string)	Execution params passed to executor.
content string	Script content as string (content depends on the executor).
input-type string	Script content type can be: (1) direct content - created from file, (2) Git repo directory checkout, in case the test is some kind of project or has more than one file.
repository Repository	Repository details, if they exist.
tags string array

SecretRef

Testkube internal reference for secret storage in Kubernetes secrets.

Appears in:

• Repository

Field	Description
namespace string	object kubernetes namespace
name string	object name
key string	object key

Test

Test is the Schema for the tests API.

Appears in:

• TestList

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	Test
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSpec

TestList

TestList contains a list of Tests.

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Test array

TestSource

TestSource is the the Schema for the testsources API.

Appears in:

• TestSourceList

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestSource
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSourceSpec

TestSourceList

TestSourceList contains a list of TestSources.

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestSourceList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestSource array

TestSourceSpec

TestSourceSpec defines the desired state of TestSource.

Appears in:

• TestSource

Field	Description
type TestSourceType
repository Repository	repository of test content
data string	test content body
uri string	uri of test content

TestSourceType

Underlying type: string

Appears in:

• TestSourceSpec

TestSpec

TestSpec defines the desired state of the Test.

Appears in:

• Test

Field	Description
before TestStepSpec array	Before steps is a list of scripts which will be sequentially orchestrated.
steps TestStepSpec array	Steps is a list of scripts which will be sequentially orchestrated.
after TestStepSpec array	After steps is a list of scripts which will be sequentially orchestrated.
repeats integer
description string
tags string array

TestStepDelay

Appears in:

• TestStepSpec

Field	Description
duration integer	Duration in ms

TestStepExecute

Appears in:

• TestStepSpec

Field	Description
namespace string
name string
stopOnFailure boolean

TestStepSpec

TestStepSpec of particular type will have config for possible step types.

Appears in:

• TestSpec

Field	Description
type string
execute TestStepExecute
delay TestStepDelay

TestSuite

TestSuite is the Schema for the testsuites API.

Appears in:

• TestSuiteList

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestSuite
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSuiteSpec

TestSuiteList

TestSuiteList contains a list of TestSuites.

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestSuiteList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestSuite array

TestSuiteSpec

TestSuiteSpec defines the desired state of a TestSuite.

Appears in:

• TestSuite

Field	Description
before TestSuiteStepSpec array	Before steps is a list of tests which will be sequentially orchestrated.
steps TestSuiteStepSpec array	Steps is a list of tests which will be sequentially orchestrated.
after TestSuiteStepSpec array	After steps is a list of tests which will be sequentially orchestrated.
repeats integer
description string
schedule string	Schedule in cron job format for scheduled test execution.
params object (keys:string, values:string)	DEPRECATED execution params passed to the executor.
variables object (keys:string, values:Variable)	Variables are new params with secrets attached.

TestSuiteStepDelay

TestSuiteStepDelay contains step delay parameters.

Appears in:

• TestSuiteStepSpec

Field	Description
duration integer	Duration in ms

TestSuiteStepExecute

TestSuiteStepExecute defines the step to be executed.

Appears in:

• TestSuiteStepSpec

Field	Description
namespace string
name string
stopOnFailure boolean

TestSuiteStepSpec

TestSuiteStepSpec of a particular type will have config for possible step types.

Appears in:

• TestSuiteSpec

Field	Description
type string
execute TestSuiteStepExecute
delay TestSuiteStepDelay

TestTrigger

TestTrigger is the Schema for the testtriggers API.

Appears in:

• TestTriggerList

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestTrigger
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestTriggerSpec

TestTriggerAction

Underlying type: string

TestTriggerAction defines action for test triggers.

Appears in:

• TestTriggerSpec

TestTriggerCondition

TestTriggerCondition is used for definition of the condition for test triggers.

Appears in:

• TestTriggerConditionSpec

Field	Description
type string	Test trigger condition.
reason string	Test trigger condition reason.
ttl integer	Duration in seconds in the past from current time when the condition is still valid.

TestTriggerConditionSpec

TestTriggerConditionSpec defines the condition specification for the TestTrigger.

Appears in:

• TestTriggerSpec

Field	Description
conditions TestTriggerCondition array	List of test trigger conditions.
timeout integer	Duration in seconds the test trigger waits for conditions, until it is stopped.

TestTriggerEvent

Underlying type: string

TestTriggerEvent defines an event for test triggers.

Appears in:

• TestTriggerSpec

TestTriggerExecution

Underlying type: string

TestTriggerExecution defines execution for test triggers.

Appears in:

• TestTriggerSpec

TestTriggerList

TestTriggerList contains a list of TestTriggers.

Field	Description
apiVersion string	tests.testkube.io/v1
kind string	TestTriggerList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestTrigger array

TestTriggerResource

Underlying type: string

TestTriggerResource defines the resource for test triggers.

Appears in:

• TestTriggerSpec

TestTriggerSelector

TestTriggerSelector is used for selecting Kubernetes Objects.

Appears in:

• TestTriggerSpec

Field	Description
name string	Name selector is used to identify a Kubernetes Object based on the metadata name.
namespace string	Namespace of the Kubernetes object.
labelSelector LabelSelector	LabelSelector is used to identify a group of Kubernetes Objects based on their metadata labels.

TestTriggerSpec

TestTriggerSpec defines the desired state of a TestTrigger.

Appears in:

• TestTrigger

Field	Description
resource TestTriggerResource	Defines the Resource monitor Event which triggers an Action on certain conditions.
resourceSelector TestTriggerSelector	ResourceSelector identifies which Kubernetes Objects should be watched.
event TestTriggerEvent	Defines the Event on which a Resource an Action should be triggered.
conditionSpec TestTriggerConditionSpec	Which resource conditions should be matched.
action TestTriggerAction	Action represents what needs to be executed for a selected Execution.
execution TestTriggerExecution	Execution identifies which test execution an Action should be executed for.
testSelector TestTriggerSelector	TestSelector identifies on which Testkube Kubernetes Objects an Action should be taken.
delay Duration	Delay is a duration string which specifies how long the test should be delayed after a trigger is matched.

Variable

Appears in:

• ExecutionRequest
• TestSpec
• TestSuiteExecutionRequest
• TestSuiteSpec

Field	Description
type string	variable type
name string	variable name
value string	variable string value
valueFrom EnvVarSource	Load variable from var source.

tests.testkube.io/v2

Package v2 contains API Schema definitions for the Testkube v2 API group.

Resource Types

• Script
• ScriptList
• Test
• TestList
• TestSuite
• TestSuiteList

Repository

Repository represents the VCS repo, currently we're handling Git only.

Appears in:

• TestContent

Field	Description
type string	VCS repository type.
uri string	URI of content file or Git directory.
branch string	Branch/tag name for checkout.
commit string	Commit ID (sha) for checkout.
path string	If needed, we can checkout a particular path (dir or file) in case of BIG/mono repositories.
username string	Git auth username for private repositories.
token string	Git auth token for private repositories.

RunningContext

Running context for test or test suite execution.

Appears in:

• TestSuiteExecutionRequest

Field	Description
type RunningContextType	One of possible context types.
context string	Context value depending from its type.

RunningContextType

Underlying type: string

Appears in:

• RunningContext

Script

Script is the Schema for the scripts API.

Appears in:

• ScriptList

Field	Description
apiVersion string	tests.testkube.io/v2
kind string	Script
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ScriptSpec

ScriptContent

Appears in:

• ScriptSpec

Field	Description
type string	script type
repository Repository	repository of script content
data string	script content body
uri string	URI of script content

ScriptList

ScriptList contains a list of Scripts.

Field	Description
apiVersion string	tests.testkube.io/v2
kind string	ScriptList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Script array

ScriptSpec

ScriptSpec defines the desired state of a Script.

Appears in:

• Script

Field	Description
type string	script type
name string	script execution custom name
params object (keys:string, values:string)	execution params passed to executor
content ScriptContent	script content object
tags string array	script tags

Test

Test is the Schema for the tests API.

Appears in:

• TestList

Field	Description
apiVersion string	tests.testkube.io/v2
kind string	Test
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSpec

TestContent

TestContent defines the test content.

Appears in:

• TestSpec

Field	Description
type string	test type
repository Repository	repository of test content
data string	test content body
uri string	uri of test content

TestList

TestList contains a list of Tests.

Field	Description
apiVersion string	tests.testkube.io/v2
kind string	TestList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Test array

TestSpec

TestSpec defines the desired state of a Test.

Appears in:

• Test

Field	Description
type string	test type
name string	test execution custom name
params object (keys:string, values:string)	DEPRECATED execution params passed to executor.
variables object (keys:string, values:Variable)	Variables are new params with secrets attached.
content TestContent	test content object
schedule string	Schedule in cron job format for scheduled test execution.
executorArgs string array	Additional executor binary arguments.

TestSuite

TestSuite is the Schema for the testsuites API.

Appears in:

• TestSuiteList

Field	Description
apiVersion string	tests.testkube.io/v2
kind string	TestSuite
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSuiteSpec

TestSuiteExecutionCore

The test suite execution core.

Appears in:

• TestSuiteStatus

Field	Description
id string	execution ID
startTime Time	test suite execution start time
endTime Time	test suite execution end time

TestSuiteExecutionRequest

The test suite execution request body.

Appears in:

• TestSuiteSpec

Field	Description
name string	The test execution custom name.
namespace string	The test Kubernetes namespace (\"testkube\" when not set).
variables object (keys:string, values:Variable)
secretUUID string	secret UUID
labels object (keys:string, values:string)	test suite labels
executionLabels object (keys:string, values:string)	execution labels
sync boolean	Whether to start execution sync or async.
httpProxy string	HTTP proxy for executor containers
httpsProxy string	HTTPS proxy for executor containers
timeout integer	Timeout for test suite execution.
runningContext RunningContext
cronJobTemplate string	Cron job template extensions.

TestSuiteList

TestSuiteList contains a list of TestSuites.

Field	Description
apiVersion string	tests.testkube.io/v2
kind string	TestSuiteList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestSuite array

TestSuiteSpec

TestSuiteSpec defines the desired state of a TestSuite.

Appears in:

• TestSuite

Field	Description
before TestSuiteStepSpec array	Before steps is a list of tests which will be sequentially orchestrated.
steps TestSuiteStepSpec array	Steps is a list of tests which will be sequentially orchestrated.
after TestSuiteStepSpec array	After steps is a list of tests which will be sequentially orchestrated.
repeats integer
description string
schedule string	Schedule in cron job format for scheduled test execution.
executionRequest TestSuiteExecutionRequest

TestSuiteStepDelay

TestSuiteStepDelay contains step delay parameters.

Appears in:

• TestSuiteStepSpec

Field	Description
duration integer	Duration in ms

TestSuiteStepExecute

TestSuiteStepExecute defines the step to be executed.

Appears in:

• TestSuiteStepSpec

Field	Description
namespace string
name string
stopOnFailure boolean

TestSuiteStepSpec

TestSuiteStepSpec for a particular type will have the config for possible step types.

Appears in:

• TestSuiteSpec

Field	Description
type TestSuiteStepType
execute TestSuiteStepExecute
delay TestSuiteStepDelay

TestSuiteStepType

Underlying type: string

TestSuiteStepType defines different types of test suite steps.

Appears in:

• TestSuiteStepSpec

Variable

Appears in:

• ExecutionRequest
• TestSpec
• TestSuiteExecutionRequest
• TestSuiteSpec

Field	Description
type string	variable type
name string	variable name
value string	variable string value
valueFrom EnvVarSource	or load it from var source

tests.testkube.io/v3

Package v3 contains API Schema definitions for the tests v3 API group.

Resource Types

• Test
• TestList

ArgsModeType

Underlying type: string

ArgsModeType defines the args mode type.

Appears in:

• ExecutionRequest

ArtifactRequest

Artifact request body with test artifacts.

Appears in:

• ExecutionRequest

Field	Description
storageClassName string	The artifact storage class name for the container executor.
volumeMountPath string	The artifact volume mount path for the container executor.
dirs string array	The artifact directories for scraping.

EnvReference

Reference to env resource.

Appears in:

• ExecutionRequest

Field	Description
reference LocalObjectReference
mount boolean	Whether we should mount a resource.
mountPath string	Where we should mount resource.
mapToVariables boolean	Whether we should map to variables from a resource.

ExecutionCore

The test execution core.

Appears in:

• TestStatus

Field	Description
id string	execution id
number integer	execution number
startTime Time	test start time
endTime Time	test end time

ExecutionRequest

The test execution request body.

Appears in:

• TestSpec

Field	Description
name string	The test execution custom name.
testSuiteName string	The unique test suite name (CRD Test suite name), if it's run as a part of a test suite.
number integer	The test execution number.
executionLabels object (keys:string, values:string)	The test execution labels.
namespace string	The test Kubernetes namespace (\"testkube\" when not set).
variablesFile string	Variables file content - needs to be in the format for a particular executor (e.g. postman envs file).
isVariablesFileUploaded boolean
variables object (keys:string, values:Variable)
testSecretUUID string	test secret UUID
testSuiteSecretUUID string	The test suite secret uuid, if it's run as a part of a test suite.
args string array	Additional executor binary arguments.
argsMode ArgsModeType	Usage mode for arguments.
command string array	Executor binary command.
image string	Container executor image.
imagePullSecrets LocalObjectReference array	Container executor image pull secrets.
envs object (keys:string, values:string)	Environment variables passed to executor. Deprecated: use Basic Variables instead.
secretEnvs object (keys:string, values:string)	Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead.
sync boolean	Whether to start execution sync or async.
httpProxy string	HTTP proxy for executor containers.
httpsProxy string	HTTPS proxy for executor containers.
negativeTest boolean	A negative test will fail the execution if it is a success and it will succeed if it is a failure.
activeDeadlineSeconds integer	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer.
artifactRequest ArtifactRequest
jobTemplate string	job template extensions
cronJobTemplate string	cron job template extensions
preRunScript string	The script to run before test execution.
scraperTemplate string	scraper template extensions
envConfigMaps EnvReference array	config map references
envSecrets EnvReference array	secret references
runningContext RunningContext

GitAuthType

Underlying type: string

GitAuthType defines the Git auth type.

Appears in:

• Repository

Repository

Repository represents VCS repo, currently we're handling Git only.

Appears in:

• TestContent

Field	Description
type string	VCS repository type
uri string	URI of content file or Git directory
branch string	branch/tag name for checkout
commit string	commit id (sha) for checkout
path string	If needed, we can checkout a particular path (dir or file) in the case of BIG/mono repositories.
usernameSecret SecretRef
tokenSecret SecretRef
certificateSecret string	Git auth certificate secret for private repositories
workingDir string	If provided, we check out the whole repository and run the test from this directory.
authType GitAuthType	auth type for git requests

RunningContext

The Running context for test or test suite execution.

Appears in:

• ExecutionRequest

Field	Description
type RunningContextType	One of possible context types
context string	Context value depending from its type

RunningContextType

Underlying type: string

Appears in:

• RunningContext

SecretRef

Testkube internal reference for secret storage in Kubernetes secrets.

Appears in:

• Repository

Field	Description
namespace string	object kubernetes namespace
name string	object name
key string	object key

Test

Test is the Schema for the tests API.

Appears in:

• TestList

Field	Description
apiVersion string	tests.testkube.io/v3
kind string	Test
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSpec

TestContent

TestContent defines test content.

Appears in:

• TestSpec

Field	Description
type TestContentType	test type
repository Repository	repository of test content
data string	test content body
uri string	uri of test content

TestContentType

Underlying type: string

Appears in:

• TestContent

TestList

TestList contains a list of the Test.

Field	Description
apiVersion string	tests.testkube.io/v3
kind string	TestList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Test array

TestSpec

TestSpec defines the the desired state of a Test.

Appears in:

• Test

Field	Description
type string	test type
name string	test name
content TestContent	test content object
source string	reference to test source resource
schedule string	schedule in cron job format for scheduled test execution
executionRequest ExecutionRequest
uploads string array	files to be used from minio uploads

Variable

Appears in:

• ExecutionRequest
• TestSpec
• TestSuiteExecutionRequest
• TestSuiteSpec

Field	Description
type string	variable type
name string	variable name
value string	variable string value
valueFrom EnvVarSource	or load it from var source