API Reference

Packages

• testworkflows.testkube.io/v1

testworkflows.testkube.io/v1

Package v1 contains API Schema definitions for the Test Workflows v1 API group

Resource Types

• TestWorkflow
• TestWorkflowExecution
• TestWorkflowExecutionList
• TestWorkflowList
• TestWorkflowTemplate
• TestWorkflowTemplateList

ArtifactCompression

Appears in:

• StepArtifacts

Field	Description	Default	Validation
name string	artifact name		MinLength: 1 Required: {}

ContainerConfig

Appears in:

• IndependentServiceSpec
• IndependentStep
• ServiceSpec
• Step
• StepDefaults
• StepRun
• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
workingDir string	override default working directory in the image (empty string to default WORKDIR for the image)
image string	image to be used for the container
imagePullPolicy PullPolicy	pulling policy for the image
env EnvVar array	environment variables to append to the container
envFrom EnvFromSource array	external environment variables to append to the container
command string	override default command in the image (empty string to default ENTRYPOINT of the image)
args string	override default command in the image (empty string to default CMD of the image)
resources Resources	expected resources for the container
securityContext SecurityContext	security context for the container
volumeMounts VolumeMount array	volume mounts to append to the container

Content

Appears in:

• IndependentServiceSpec
• IndependentStep
• ServiceSpec
• Step
• StepSource
• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
git ContentGit	git repository details
files ContentFile array	files to load
tarball ContentTarball array	tarballs to unpack

ContentFile

Appears in:

• Content

Field	Description	Default	Validation
path string	path where the file should be accessible at		MinLength: 1
content string	plain-text content to put inside
contentFrom EnvVarSource	external source to use
mode integer	mode to use for the file

ContentGit

Appears in:

• Content

Field	Description	Default	Validation
uri string	uri for the Git repository
revision string	branch, commit or a tag name to fetch
username string	plain text username to fetch with
usernameFrom EnvVarSource	external username to fetch with
token string	plain text token to fetch with
tokenFrom EnvVarSource	external token to fetch with
sshKey string	plain text SSH private key to fetch with
sshKeyFrom EnvVarSource	external SSH private key to fetch with
authType GitAuthType	authorization type for the credentials		Enum: [basic header]
mountPath string	where to mount the fetched repository contents (defaults to "repo" directory in the data volume)
paths string array	paths to fetch for the sparse checkout

ContentTarball

Appears in:

• Content

Field	Description	Default	Validation
url string	url for the tarball to extract
path string	path where the tarball should be extracted
mount boolean	should it mount a new volume there

CronJobConfig

cron job configuration

Appears in:

• Event

Field	Description	Default	Validation
cron string	cron schedule to run a test workflow
labels object (keys:string, values:string)	labels to attach to the cron job
annotations object (keys:string, values:string)	annotations to attach to the cron job

DynamicList

Validation:

• Type: dynamicList

Appears in:

• IndependentServiceSpec
• ServiceSpec
• StepExecuteStrategy
• StepExecuteTest
• StepExecuteWorkflow
• StepParallelFetch
• StepParallelTransfer
• TarballRequest
• TestWorkflowOutput

Field	Description	Default	Validation
Dynamic boolean
Static interface{} array
Expression string

Event

Appears in:

• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
cronjob CronJobConfig

IndependentServiceSpec

Appears in:

• IndependentStep
• ServiceSpec
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
matrix object (keys:string, values:DynamicList)	matrix of parameters to spawn instances (static)
count IntOrString	static number of sharded instances to spawn
maxCount IntOrString	dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
shards object (keys:string, values:DynamicList)	parameters that should be distributed across sharded instances
description string	service description to display
logs string	should save logs for the service (false if not specified)
timeout string	maximum time until reaching readiness		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
transfer StepParallelTransfer array	instructions for transferring files
content Content	global content that should be fetched into all containers
pod PodConfig	configuration for the scheduled pod
workingDir string	override default working directory in the image (empty string to default WORKDIR for the image)
image string	image to be used for the container
imagePullPolicy PullPolicy	pulling policy for the image
env EnvVar array	environment variables to append to the container
envFrom EnvFromSource array	external environment variables to append to the container
command string	override default command in the image (empty string to default ENTRYPOINT of the image)
args string	override default command in the image (empty string to default CMD of the image)
resources Resources	expected resources for the container
securityContext SecurityContext	security context for the container
volumeMounts VolumeMount array	volume mounts to append to the container
shell string	script to run in a default shell for the container
restartPolicy ServiceRestartPolicy	Restart policy for the main container in the pod. One of OnFailure or Never.
readinessProbe Probe	Probe to check if the service has started correctly

IndependentStep

Appears in:

• IndependentStep
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
name string	readable name for the step
condition string	expression to declare under which conditions the step should be run defaults to: "passed", except artifacts where it defaults to "always"
pure boolean	mark the step as pure, applying optimizations to merge the containers together
negative boolean	is the step expected to fail
optional boolean	is the step optional, so its failure won't affect the TestWorkflow result
paused boolean	pause the step initially
retry RetryPolicy	policy for retrying the step
timeout string	maximum time this step may take		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
content Content	content that should be fetched for this step
services object (keys:string, values:IndependentServiceSpec)	list of accompanying services to start
container ContainerConfig	defaults for the containers in this step
workingDir string	working directory to use for this step
setup IndependentStep array	steps to run before other operations in this step		Schemaless: {}
delay string	delay before the step		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
shell string	script to run in a default shell for the container
run StepRun	run specific container in the current step
execute StepExecute	execute other Testkube resources
artifacts StepArtifacts	scrape artifacts from the volumes
parallel IndependentStepParallel	instructions for parallel execution
steps IndependentStep array	sub-steps to run		Schemaless: {}

IndependentStepParallel

Underlying type: struct{Parallelism int32 "json:"parallelism,omitempty""; StepExecuteStrategy "json:",inline" expr:"include""; Description string "json:"description,omitempty" expr:"template""; Logs *string "json:"logs,omitempty" expr:"expression""; Transfer []StepParallelTransfer "json:"transfer,omitempty" expr:"include""; Fetch []StepParallelFetch "json:"fetch,omitempty" expr:"include""; TestWorkflowTemplateSpec "json:",inline" expr:"include""; StepControl "json:",inline" expr:"include""; StepOperations "json:",inline" expr:"include""}

Appears in:

• IndependentStep

JobConfig

Appears in:

• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
labels object (keys:string, values:string)	labels added to the scheduled job
annotations object (keys:string, values:string)	annotations added to the scheduled job
namespace string	namespace for execution of test workflow
activeDeadlineSeconds integer	duration in seconds the job may be active on the node

NotificationsConfig

Appears in:

• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
disableWebhooks boolean

ParameterNumberSchema

Appears in:

• ParameterSchema

Field	Description	Default	Validation
minimum integer	minimum value for the number (inclusive)
maximum integer	maximum value for the number (inclusive)
exclusiveMinimum integer	minimum value for the number (exclusive)
exclusiveMaximum integer	maximum value for the number (exclusive)
multipleOf integer	the number needs to be multiple of this value

ParameterSchema

Appears in:

• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
description string	parameter description
type ParameterType	type of the parameter	string	Enum: [string integer number boolean]
enum string array	the list of allowed values, when limited
example IntOrString	exemplary value
default IntOrString	default value - if not provided, the parameter is required		XIntOrString: {}
sensitive boolean	whether this value should be stored in the secret
format string	predefined format for the string
pattern string	regular expression to match
minLength integer	minimum length for the string
maxLength integer	maximum length for the string
minimum integer	minimum value for the number (inclusive)
maximum integer	maximum value for the number (inclusive)
exclusiveMinimum integer	minimum value for the number (exclusive)
exclusiveMaximum integer	maximum value for the number (exclusive)
multipleOf integer	the number needs to be multiple of this value

ParameterStringSchema

Appears in:

• ParameterSchema

Field	Description	Default	Validation
format string	predefined format for the string
pattern string	regular expression to match
minLength integer	minimum length for the string
maxLength integer	maximum length for the string

ParameterType

Underlying type: string

Validation:

• Enum: [string integer number boolean]

Appears in:

• ParameterSchema

Field	Description
string
integer
number
boolean

PodConfig

Appears in:

• IndependentServiceSpec
• ServiceSpec
• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
serviceAccountName string	default service account name for the scheduled pod
imagePullSecrets LocalObjectReference array	references to secrets with credentials for pulling the images from registry
nodeSelector object (keys:string, values:string)	node selector to define on which node the pod should land
labels object (keys:string, values:string)	labels added to the scheduled pod
annotations object (keys:string, values:string)	annotations added to the scheduled pod
volumes Volume array	volumes to include in the pod		Schemaless: {}
activeDeadlineSeconds integer	duration in seconds the pod may be active on the node
dnsPolicy DNSPolicy	DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy.
nodeName string	NodeName is a request to schedule this pod onto a specific node.
securityContext PodSecurityContext	SecurityContext holds pod-level security attributes and common container settings.
hostname string	Specifies the hostname of the Pod
subdomain string	If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
affinity Affinity	If specified, the pod's scheduling constraints		Schemaless: {}
tolerations Toleration array	If specified, the pod's tolerations.
hostAliases HostAlias array	HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified
priorityClassName string	If specified, indicates the pod's priority.
priority integer	The priority value. Various system components use this field to find the priority of the pod.
dnsConfig PodDNSConfig	Specifies the DNS parameters of a pod.
preemptionPolicy PreemptionPolicy	PreemptionPolicy is the Policy for preempting pods with lower priority.
topologySpreadConstraints TopologySpreadConstraint array	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.		Schemaless: {}
schedulingGates PodSchedulingGate array	SchedulingGates is an opaque list of values that if specified will block scheduling the pod.
resourceClaims PodResourceClaim array	ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start.

Resources

Appears in:

• ContainerConfig
• IndependentServiceSpec
• ServiceSpec
• StepRun

Field	Description	Default	Validation
limits object (keys:ResourceName, values:IntOrString)	resource limits for the container
requests object (keys:ResourceName, values:IntOrString)	resource requests for the container

RetryPolicy

Appears in:

• IndependentStep
• Step
• StepControl

Field	Description	Default	Validation
count integer	how many times at most it should retry		Minimum: 1 Required: {}
until string	until when it should retry (defaults to: "passed")

ServiceRestartPolicy

Underlying type: string

Appears in:

• IndependentServiceSpec
• ServiceSpec

Field	Description
OnFailure
Never

ServiceSpec

Appears in:

• Step
• TestWorkflowSpec

Field	Description	Default	Validation
use TemplateRef array	multiple templates to include in this step
matrix object (keys:string, values:DynamicList)	matrix of parameters to spawn instances (static)
count IntOrString	static number of sharded instances to spawn
maxCount IntOrString	dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
shards object (keys:string, values:DynamicList)	parameters that should be distributed across sharded instances
description string	service description to display
logs string	should save logs for the service (false if not specified)
timeout string	maximum time until reaching readiness		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
transfer StepParallelTransfer array	instructions for transferring files
content Content	global content that should be fetched into all containers
pod PodConfig	configuration for the scheduled pod
workingDir string	override default working directory in the image (empty string to default WORKDIR for the image)
image string	image to be used for the container
imagePullPolicy PullPolicy	pulling policy for the image
env EnvVar array	environment variables to append to the container
envFrom EnvFromSource array	external environment variables to append to the container
command string	override default command in the image (empty string to default ENTRYPOINT of the image)
args string	override default command in the image (empty string to default CMD of the image)
resources Resources	expected resources for the container
securityContext SecurityContext	security context for the container
volumeMounts VolumeMount array	volume mounts to append to the container
shell string	script to run in a default shell for the container
restartPolicy ServiceRestartPolicy	Restart policy for the main container in the pod. One of OnFailure or Never.
readinessProbe Probe	Probe to check if the service has started correctly

Step

Appears in:

• Step
• TestWorkflowSpec

Field	Description	Default	Validation
name string	readable name for the step
condition string	expression to declare under which conditions the step should be run defaults to: "passed", except artifacts where it defaults to "always"
pure boolean	mark the step as pure, applying optimizations to merge the containers together
negative boolean	is the step expected to fail
optional boolean	is the step optional, so its failure won't affect the TestWorkflow result
paused boolean	pause the step initially
retry RetryPolicy	policy for retrying the step
timeout string	maximum time this step may take		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
use TemplateRef array	multiple templates to include in this step
content Content	content that should be fetched for this step
services object (keys:string, values:ServiceSpec)	list of accompanying services to start
container ContainerConfig	defaults for the containers in this step
workingDir string	working directory to use for this step
setup Step array	steps to run before other operations in this step		Schemaless: {}
delay string	delay before the step		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
shell string	script to run in a default shell for the container
run StepRun	run specific container in the current step
execute StepExecute	execute other Testkube resources
artifacts StepArtifacts	scrape artifacts from the volumes
template TemplateRef	single template to run in this step
parallel StepParallel	instructions for parallel execution
steps Step array	sub-steps to run		Schemaless: {}

StepArtifacts

Appears in:

• IndependentStep
• Step
• StepOperations

Field	Description	Default	Validation
workingDir string	working directory to override, so it will be used as a base dir
compress ArtifactCompression	compression options for the artifacts
paths string array	paths to fetch from the container

StepControl

Appears in:

• IndependentStep
• Step

Field	Description	Default	Validation
negative boolean	is the step expected to fail
optional boolean	is the step optional, so its failure won't affect the TestWorkflow result
paused boolean	pause the step initially
retry RetryPolicy	policy for retrying the step
timeout string	maximum time this step may take		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$

StepDefaults

Appears in:

• IndependentStep
• Step

Field	Description	Default	Validation
container ContainerConfig	defaults for the containers in this step
workingDir string	working directory to use for this step

StepExecute

Appears in:

• IndependentStep
• Step
• StepOperations

Field	Description	Default	Validation
parallelism integer	how many resources could be scheduled in parallel
async boolean	only schedule the resources, don't watch the results (unless it is needed for parallelism)
tests StepExecuteTest array	tests to run
workflows StepExecuteWorkflow array	workflows to run

StepExecuteStrategy

Appears in:

• IndependentServiceSpec
• ServiceSpec
• StepExecuteTest
• StepExecuteWorkflow

Field	Description	Default	Validation
matrix object (keys:string, values:DynamicList)	matrix of parameters to spawn instances (static)
count IntOrString	static number of sharded instances to spawn
maxCount IntOrString	dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
shards object (keys:string, values:DynamicList)	parameters that should be distributed across sharded instances

StepExecuteTest

Appears in:

• StepExecute

Field	Description	Default	Validation
name string	test name to run
description string	test execution description to display
matrix object (keys:string, values:DynamicList)	matrix of parameters to spawn instances (static)
count IntOrString	static number of sharded instances to spawn
maxCount IntOrString	dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
shards object (keys:string, values:DynamicList)	parameters that should be distributed across sharded instances
tarball object (keys:string, values:TarballRequest)	pack some data from the original file system to serve them down
executionRequest TestExecutionRequest	pass the execution request overrides

StepExecuteWorkflow

Appears in:

• StepExecute

Field	Description	Default	Validation
name string	workflow name to run
description string	test workflow execution description to display
matrix object (keys:string, values:DynamicList)	matrix of parameters to spawn instances (static)
count IntOrString	static number of sharded instances to spawn
maxCount IntOrString	dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
shards object (keys:string, values:DynamicList)	parameters that should be distributed across sharded instances
executionName string	unique execution name to use
tarball object (keys:string, values:TarballRequest)	pack some data from the original file system to serve them down
config object (keys:string, values:IntOrString)	configuration to pass for the workflow

StepMeta

Appears in:

• IndependentStep
• Step

Field	Description	Default	Validation
name string	readable name for the step
condition string	expression to declare under which conditions the step should be run defaults to: "passed", except artifacts where it defaults to "always"
pure boolean	mark the step as pure, applying optimizations to merge the containers together

StepOperations

Appears in:

• IndependentStep
• Step

Field	Description	Default	Validation
delay string	delay before the step		Pattern: ^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
shell string	script to run in a default shell for the container
run StepRun	run specific container in the current step
execute StepExecute	execute other Testkube resources
artifacts StepArtifacts	scrape artifacts from the volumes

StepParallel

Underlying type: struct{Parallelism int32 "json:"parallelism,omitempty""; StepExecuteStrategy "json:",inline" expr:"include""; Description string "json:"description,omitempty" expr:"template""; Logs *string "json:"logs,omitempty" expr:"expression""; Transfer []StepParallelTransfer "json:"transfer,omitempty" expr:"include""; Fetch []StepParallelFetch "json:"fetch,omitempty" expr:"include""; TestWorkflowSpec "json:",inline" expr:"include""; StepControl "json:",inline" expr:"include""; StepOperations "json:",inline" expr:"include""; Template *TemplateRef "json:"template,omitempty" expr:"include""}

Appears in:

• Step

StepParallelTransfer

Appears in:

• IndependentServiceSpec
• ServiceSpec

Field	Description	Default	Validation
from string	path to load the files from
files DynamicList	file patterns to pack		Type: dynamicList
to string	path where the tarball should be extracted
mount boolean	should it mount a new volume there

StepRun

Appears in:

• IndependentServiceSpec
• IndependentStep
• ServiceSpec
• Step
• StepOperations

Field	Description	Default	Validation
workingDir string	override default working directory in the image (empty string to default WORKDIR for the image)
image string	image to be used for the container
imagePullPolicy PullPolicy	pulling policy for the image
env EnvVar array	environment variables to append to the container
envFrom EnvFromSource array	external environment variables to append to the container
command string	override default command in the image (empty string to default ENTRYPOINT of the image)
args string	override default command in the image (empty string to default CMD of the image)
resources Resources	expected resources for the container
securityContext SecurityContext	security context for the container
volumeMounts VolumeMount array	volume mounts to append to the container
shell string	script to run in a default shell for the container

StepSource

Appears in:

• IndependentStep
• Step

Field	Description	Default	Validation
content Content	content that should be fetched for this step

TarballRequest

Appears in:

• StepExecuteTest
• StepExecuteWorkflow

Field	Description	Default	Validation
from string	path to load the files from
files DynamicList	file patterns to pack		Type: dynamicList

TemplateRef

TemplateRef is the reference for the template inclusion

Appears in:

• ServiceSpec
• Step
• TestWorkflowSpec

Field	Description	Default	Validation
name string	name of the template to include
config object (keys:string, values:IntOrString)	trait configuration values if needed

TestExecutionRequest

Appears in:

• StepExecuteTest

Field	Description	Default	Validation
name string	test execution custom name
executionLabels object (keys:string, values:string)	test execution labels
variablesFile string	variables file content - need to be in format for particular executor (e.g. postman envs file)
isVariablesFileUploaded boolean
variables object (keys:string, values:Variable)
testSecretUUID string	test secret uuid
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
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	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	script to run before test execution
postRunScript string	script to run after test execution
executePostRunScriptBeforeScraping boolean	execute post run script before scraping (prebuilt executor only)
sourceScripts boolean	run scripts using source command (container executor only)
scraperTemplate string	scraper template extensions
envConfigMaps EnvReference array	config map references
envSecrets EnvReference array	secret references
executionNamespace string	namespace for test execution (Pro edition only)

TestWorkflow

TestWorkflow is the Schema for the workflows API

Appears in:

• TestWorkflowExecutionDetails
• TestWorkflowList

Field	Description	Default	Validation
apiVersion string	testworkflows.testkube.io/v1
kind string	TestWorkflow
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
description string	TestWorkflow readable description
spec TestWorkflowSpec	TestWorkflow specification

TestWorkflowExecution

TestWorkflowExecution is the Schema for the workflows API

Appears in:

• TestWorkflowExecutionList

Field	Description	Default	Validation
apiVersion string	testworkflows.testkube.io/v1
kind string	TestWorkflowExecution
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestWorkflowExecutionSpec	TestWorkflowExecution specification

TestWorkflowExecutionDetails

TestWorkflowExecutionDetails contains the details of TestWorkflowExecution

Appears in:

• TestWorkflowExecutionStatus

Field	Description	Default	Validation
id string	unique execution identifier
name string	execution name
namespace string	execution namespace
number integer	sequence number for the execution
scheduledAt Time	when the execution has been scheduled to run
statusAt Time	when the execution result's status has changed last time (queued, passed, failed)
signature TestWorkflowSignature array	structured tree of steps
result TestWorkflowResult
output TestWorkflowOutput array	additional information from the steps, like referenced executed tests or artifacts
reports TestWorkflowReport array	generated reports from the steps, like junit
workflow TestWorkflow			Schemaless: {}
resolvedWorkflow TestWorkflow			Schemaless: {}
testWorkflowExecutionName string	test workflow execution name started the test workflow execution
disableWebhooks boolean	whether webhooks should be disabled for this execution
tags object (keys:string, values:string)	test workflow execution tags

TestWorkflowExecutionList

TestWorkflowExecutionList contains a list of TestWorkflowExecutiom

Field	Description	Default	Validation
apiVersion string	testworkflows.testkube.io/v1
kind string	TestWorkflowExecutionList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestWorkflowExecution array

TestWorkflowExecutionRequest

TestWorkflowExecutionRequest contains TestWorkflow execution parameters

Appears in:

• TestWorkflowExecutionSpec

Field	Description	Default	Validation
name string	custom execution name
config object (keys:string, values:IntOrString)
testWorkflowExecutionName string	test workflow execution name started the test workflow execution
disableWebhooks boolean	whether webhooks should be disabled for this execution
tags object (keys:string, values:string)	test workflow execution tags

TestWorkflowExecutionSpec

TestWorkflowExecutionSpec defines the desired state of TestWorkflowExecution

Appears in:

• TestWorkflowExecution

Field	Description	Default	Validation
testWorkflow LocalObjectReference
executionRequest TestWorkflowExecutionRequest

TestWorkflowExecutionSummary

TestWorkflowExecutionSummary contains TestWorkflow execution summary

Appears in:

• TestWorkflowStatusSummary

Field	Description	Default	Validation
id string	unique execution identifier
name string	execution name
number integer	sequence number for the execution
scheduledAt Time	when the execution has been scheduled to run
statusAt Time	when the execution result's status has changed last time (queued, passed, failed)
result TestWorkflowResultSummary
workflow TestWorkflowSummary
tags object (keys:string, values:string)	test workflow execution tags

TestWorkflowList

TestWorkflowList contains a list of TestWorkflow

Field	Description	Default	Validation
apiVersion string	testworkflows.testkube.io/v1
kind string	TestWorkflowList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestWorkflow array

TestWorkflowOutput

TestWorkflowOutput defines output of TestWorkflow

Appears in:

• TestWorkflowExecutionDetails

Field	Description	Default	Validation
ref string	step reference
name string	output kind name
value object (keys:string, values:DynamicList)	value returned

TestWorkflowPause

TestWorkflowPause defines pause of TestWorkflow

Appears in:

• TestWorkflowResult

Field	Description	Default	Validation
ref string	step at which it was paused
pausedAt Time	when the pause has started
resumedAt Time	when the pause has ended

TestWorkflowReport

TestWorkflowStepReport contains report of TestWorkflow

Appears in:

• TestWorkflowExecutionDetails

Field	Description	Default	Validation
ref string	step reference
kind string	report kind/type
file string	file path to full report in artifact storage
summary TestWorkflowReportSummary

TestWorkflowReportSummary

TestWorkflowStepReportSummary contains report summary of TestWorkflow

Appears in:

• TestWorkflowReport

Field	Description	Default	Validation
tests integer	total number of test cases
passed integer	number of passed test cases
failed integer	number of failed test cases
skipped integer	number of skipped test cases
errored integer	number of error test cases
duration integer	total duration of all test cases in milliseconds

TestWorkflowResult

TestWorkflowResult contains result of TestWorkflow

Appears in:

• TestWorkflowExecutionDetails

Field	Description	Default	Validation
predictedStatus TestWorkflowStatus			Enum: [queued running paused passed failed aborted]
queuedAt Time	when the pod was created
startedAt Time	when the pod has been successfully assigned
finishedAt Time	when the pod has been completed
duration string	Go-formatted (human-readable) duration
totalDuration string	Go-formatted (human-readable) total duration (incl. pause)
durationMs integer	Duration in milliseconds
pausedMs integer	Pause duration in milliseconds
totalDurationMs integer	Total duration in milliseconds (incl. pause)
pauses TestWorkflowPause array
initialization TestWorkflowStepResult
steps object (keys:string, values:TestWorkflowStepResult)

TestWorkflowResultSummary

TestWorkflowResultSummary defines TestWorkflow result summary

Appears in:

• TestWorkflowExecutionSummary

Field	Description	Default	Validation
predictedStatus TestWorkflowStatus			Enum: [queued running paused passed failed aborted]
queuedAt Time	when the pod was created
startedAt Time	when the pod has been successfully assigned
finishedAt Time	when the pod has been completed
duration string	Go-formatted (human-readable) duration
totalDuration string	Go-formatted (human-readable) duration (incl. pause)
durationMs integer	Duration in milliseconds
totalDurationMs integer	Duration in milliseconds (incl. pause)
pausedMs integer	Pause duration in milliseconds

TestWorkflowSignature

TestWorkflowSignature has signature of TestWorkflow

Appears in:

• TestWorkflowExecutionDetails
• TestWorkflowSignature

Field	Description	Default	Validation
ref string	step reference
name string	step name
category string	step category, that may be used as name fallback
optional boolean	is the step/group meant to be optional
negative boolean	is the step/group meant to be negative
children TestWorkflowSignature array			Schemaless: {}

TestWorkflowSpec

TestWorkflowSpec defines the desired state of TestWorkflow

Appears in:

• TestWorkflow

Field	Description	Default	Validation
use TemplateRef array	templates to include at a top-level of workflow
events Event array	events triggering execution of the test workflow
system TestWorkflowSystem	system configuration to define the orchestration behavior
config object (keys:string, values:ParameterSchema)	make the instance configurable with some input data for scheduling it
content Content	global content that should be fetched into all containers
container ContainerConfig	defaults for the containers for all the TestWorkflow steps
job JobConfig	configuration for the scheduled job
pod PodConfig	configuration for the scheduled pod
notifications NotificationsConfig	configuration for notifications Deprecated: field is not used
execution TestWorkflowTagSchema	values to be used for test workflow execution
services object (keys:string, values:ServiceSpec)	list of accompanying services to start
setup Step array	steps for setting up the workflow
steps Step array	steps to execute in the workflow
after Step array	steps to run at the end of the workflow

TestWorkflowSpecBase

Appears in:

• TestWorkflowSpec
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
events Event array	events triggering execution of the test workflow
system TestWorkflowSystem	system configuration to define the orchestration behavior
config object (keys:string, values:ParameterSchema)	make the instance configurable with some input data for scheduling it
content Content	global content that should be fetched into all containers
container ContainerConfig	defaults for the containers for all the TestWorkflow steps
job JobConfig	configuration for the scheduled job
pod PodConfig	configuration for the scheduled pod
notifications NotificationsConfig	configuration for notifications Deprecated: field is not used
execution TestWorkflowTagSchema	values to be used for test workflow execution

TestWorkflowStatus

Underlying type: string

TestWorkflowStatus has status of TestWorkflow

Validation:

• Enum: [queued running paused passed failed aborted]

Appears in:

• TestWorkflowResult
• TestWorkflowResultSummary

Field	Description
queued
running
paused
passed
failed
aborted

TestWorkflowStepResult

TestWorkflowStepResult contains step result of TestWorkflow

Appears in:

• TestWorkflowResult

Field	Description	Default	Validation
errorMessage string
exitCode integer
queuedAt Time	when the container was created
startedAt Time	when the container was started
finishedAt Time	when the container was finished

TestWorkflowSummary

TestWorkflowSummary fas TestWorkflow summary

Appears in:

• TestWorkflowExecutionSummary

Field	Description	Default	Validation
name string
namespace string
labels object (keys:string, values:string)
annotations object (keys:string, values:string)

TestWorkflowSystem

Appears in:

• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
pureByDefault boolean	assume all the steps are pure by default
isolatedContainers boolean	disable the behavior of merging multiple operations in a single container

TestWorkflowTagSchema

Appears in:

• TestWorkflowSpec
• TestWorkflowSpecBase
• TestWorkflowTemplateSpec

Field	Description	Default	Validation
tags object (keys:string, values:string)	test workflow execution tags

TestWorkflowTemplate

TestWorkflowTemplate is the Schema for the workflows API

Appears in:

• TestWorkflowTemplateList

Field	Description	Default	Validation
apiVersion string	testworkflows.testkube.io/v1
kind string	TestWorkflowTemplate
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
description string	TestWorkflowTemplate readable description
spec TestWorkflowTemplateSpec	TestWorkflowTemplate specification

TestWorkflowTemplateList

TestWorkflowTemplateList contains a list of TestWorkflowTemplate

Field	Description	Default	Validation
apiVersion string	testworkflows.testkube.io/v1
kind string	TestWorkflowTemplateList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items TestWorkflowTemplate array

TestWorkflowTemplateSpec

TestWorkflowTemplateSpec defines the desired state of TestWorkflow

Appears in:

• TestWorkflowTemplate

Field	Description	Default	Validation
events Event array	events triggering execution of the test workflow
system TestWorkflowSystem	system configuration to define the orchestration behavior
config object (keys:string, values:ParameterSchema)	make the instance configurable with some input data for scheduling it
content Content	global content that should be fetched into all containers
container ContainerConfig	defaults for the containers for all the TestWorkflow steps
job JobConfig	configuration for the scheduled job
pod PodConfig	configuration for the scheduled pod
notifications NotificationsConfig	configuration for notifications Deprecated: field is not used
execution TestWorkflowTagSchema	values to be used for test workflow execution
services object (keys:string, values:IndependentServiceSpec)	list of accompanying services to start
setup IndependentStep array	steps for setting up the workflow
steps IndependentStep array	steps to execute in the workflow
after IndependentStep array	steps to run at the end of the workflow