TestWorkflowTemplate
testworkflows.testkube.io / v1
apiVersion: testworkflows.testkube.io/v1
kind: TestWorkflowTemplate
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
description
string
TestWorkflowTemplate readable description
kind
string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object required
TestWorkflowTemplate specification
after []object
steps to run at the end of the workflow
artifacts object
scrape artifacts from the volumes
compress object
compression options for the artifacts
name
string required
artifact name
minLength:
1
paths
[]string
paths to fetch from the container
workingDir
string
working directory to override, so it will be used as a base dir
condition
string
expression to declare under which conditions the step should be run
defaults to: "passed", except artifacts where it defaults to "always"
container object
defaults for the containers in this step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
content object
content that should be fetched for this step
files []object
files to load
content
string
plain-text content to put inside
contentFrom object
external source to use
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
mode
integer
mode to use for the file
format:
int32
path
string required
path where the file should be accessible at
minLength:
1git object
git repository details
authType
string
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
paths to fetch for the sparse checkout
revision
string
branch, commit or a tag name to fetch
sshKey
string
plain text SSH private key to fetch with
sshKeyFrom object
external SSH private key to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
token
string
plain text token to fetch with
tokenFrom object
external token to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
uri
string
uri for the Git repository
username
string
plain text username to fetch with
usernameFrom object
external username to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
tarball []object
tarballs to unpack
mount
boolean
should it mount a new volume there
path
string required
path where the tarball should be extracted
url
string required
url for the tarball to extract
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)?$execute object
execute other Testkube resources
async
boolean
only schedule the resources, don't watch the results (unless it is needed for parallelism)
parallelism
integer
how many resources could be scheduled in parallel
format:
int32tests []object
tests to run
count
string | integer
static number of sharded instances to spawn
description
string
test execution description to display
executionRequest object
pass the execution request overrides
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
name
string
test execution custom name
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
scraperTemplate
string
scraper template extensions
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
test name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
workflows []object
workflows to run
config
object
configuration to pass for the workflow
count
string | integer
static number of sharded instances to spawn
description
string
test workflow execution description to display
executionName
string
unique execution name to use
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
workflow name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
name
string
readable name for the step
negative
boolean
is the step expected to fail
optional
boolean
is the step optional, so its failure won't affect the TestWorkflow result
parallel object
instructions for parallel execution
artifacts object
scrape artifacts from the volumes
compress object
compression options for the artifacts
name
string required
artifact name
minLength:
1
paths
[]string
paths to fetch from the container
workingDir
string
working directory to override, so it will be used as a base dir
count
string | integer
static number of sharded instances to spawn
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)?$
description
string
worker description to display
execute object
execute other Testkube resources
async
boolean
only schedule the resources, don't watch the results (unless it is needed for parallelism)
parallelism
integer
how many resources could be scheduled in parallel
format:
int32tests []object
tests to run
count
string | integer
static number of sharded instances to spawn
description
string
test execution description to display
executionRequest object
pass the execution request overrides
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
name
string
test execution custom name
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
scraperTemplate
string
scraper template extensions
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
test name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
workflows []object
workflows to run
config
object
configuration to pass for the workflow
count
string | integer
static number of sharded instances to spawn
description
string
test workflow execution description to display
executionName
string
unique execution name to use
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
workflow name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
fetch
[]object
instructions for fetching files back
logs
string
should save logs for the parallel step (true if not specified)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
negative
boolean
is the step expected to fail
optional
boolean
is the step optional, so its failure won't affect the TestWorkflow result
parallelism
integer
how many resources could be scheduled in parallel
format:
int32
paused
boolean
pause the step initially
retry object
policy for retrying the step
count
integer
how many times at most it should retry
format:
int32minimum:
1
until
string
until when it should retry (defaults to: "passed")
run object
run specific container in the current step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
shell
string
script to run in a default shell for the container
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
shards
object
parameters that should be distributed across sharded instances
shell
string
script to run in a default shell for the container
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)?$
transfer
[]object
instructions for transferring files
paused
boolean
pause the step initially
pure
boolean
mark the step as pure, applying optimizations to merge the containers together
retry object
policy for retrying the step
count
integer
how many times at most it should retry
format:
int32minimum:
1
until
string
until when it should retry (defaults to: "passed")
run object
run specific container in the current step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
shell
string
script to run in a default shell for the container
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
services
object
list of accompanying services to start
setup
object
steps to run before other operations in this step
shell
string
script to run in a default shell for the container
steps
object
sub-steps to run
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)?$
workingDir
string
working directory to use for this step
config
object
make the instance configurable with some input data for scheduling it
container object
defaults for the containers for all the TestWorkflow steps
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
content object
global content that should be fetched into all containers
files []object
files to load
content
string
plain-text content to put inside
contentFrom object
external source to use
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
mode
integer
mode to use for the file
format:
int32
path
string required
path where the file should be accessible at
minLength:
1git object
git repository details
authType
string
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
paths to fetch for the sparse checkout
revision
string
branch, commit or a tag name to fetch
sshKey
string
plain text SSH private key to fetch with
sshKeyFrom object
external SSH private key to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
token
string
plain text token to fetch with
tokenFrom object
external token to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
uri
string
uri for the Git repository
username
string
plain text username to fetch with
usernameFrom object
external username to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
tarball []object
tarballs to unpack
mount
boolean
should it mount a new volume there
path
string required
path where the tarball should be extracted
url
string required
url for the tarball to extract
events []object
events triggering execution of the test workflow
cronjob object
cron job configuration
annotations
object
annotations to attach to the cron job
cron
string required
cron schedule to run a test workflow
labels
object
labels to attach to the cron job
job object
configuration for the scheduled job
activeDeadlineSeconds
integer
duration in seconds the job may be active on the node
format:
int64
annotations
object
annotations added to the scheduled job
labels
object
labels added to the scheduled job
namespace
string
namespace for execution of test workflow
notifications object
configuration for notifications
Deprecated: field is not used
disableWebhooks
boolean
pod object
configuration for the scheduled pod
activeDeadlineSeconds
integer
duration in seconds the pod may be active on the node
format:
int64
affinity
object
annotations
object
annotations added to the scheduled pod
dnsConfig object
nameservers
[]string
options []object
name
string
value
string
searches
[]string
dnsPolicy
string
hostAliases []object
hostnames
[]string
ip
string
hostname
string
Specifies the hostname of the Pod
imagePullSecrets []object
references to secrets with credentials for pulling the images from registry
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
labels
object
labels added to the scheduled pod
nodeName
string
NodeName is a request to schedule this pod onto a specific node.
nodeSelector
object
node selector to define on which node the pod should land
preemptionPolicy
string
PreemptionPolicy is the Policy for preempting pods with lower priority.
priority
integer
The priority value. Various system components use this field to find the priority of the pod.
format:
int32
priorityClassName
string
If specified, indicates the pod's priority.
resourceClaims []object
name
string required
source object
resourceClaimName
string
resourceClaimTemplateName
string
schedulingGates []object
name
string required
securityContext object
fsGroup
integer
format:
int64
fsGroupChangePolicy
string
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
supplementalGroups
[]integer
sysctls []object
name
string required
value
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
serviceAccountName
string
default service account name for the scheduled pod
subdomain
string
If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>".
tolerations []object
effect
string
key
string
operator
string
tolerationSeconds
integer
format:
int64
value
string
topologySpreadConstraints
object
volumes
object
services
object
list of accompanying services to start
setup []object
steps for setting up the workflow
artifacts object
scrape artifacts from the volumes
compress object
compression options for the artifacts
name
string required
artifact name
minLength:
1
paths
[]string
paths to fetch from the container
workingDir
string
working directory to override, so it will be used as a base dir
condition
string
expression to declare under which conditions the step should be run
defaults to: "passed", except artifacts where it defaults to "always"
container object
defaults for the containers in this step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
content object
content that should be fetched for this step
files []object
files to load
content
string
plain-text content to put inside
contentFrom object
external source to use
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
mode
integer
mode to use for the file
format:
int32
path
string required
path where the file should be accessible at
minLength:
1git object
git repository details
authType
string
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
paths to fetch for the sparse checkout
revision
string
branch, commit or a tag name to fetch
sshKey
string
plain text SSH private key to fetch with
sshKeyFrom object
external SSH private key to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
token
string
plain text token to fetch with
tokenFrom object
external token to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
uri
string
uri for the Git repository
username
string
plain text username to fetch with
usernameFrom object
external username to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
tarball []object
tarballs to unpack
mount
boolean
should it mount a new volume there
path
string required
path where the tarball should be extracted
url
string required
url for the tarball to extract
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)?$execute object
execute other Testkube resources
async
boolean
only schedule the resources, don't watch the results (unless it is needed for parallelism)
parallelism
integer
how many resources could be scheduled in parallel
format:
int32tests []object
tests to run
count
string | integer
static number of sharded instances to spawn
description
string
test execution description to display
executionRequest object
pass the execution request overrides
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
name
string
test execution custom name
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
scraperTemplate
string
scraper template extensions
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
test name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
workflows []object
workflows to run
config
object
configuration to pass for the workflow
count
string | integer
static number of sharded instances to spawn
description
string
test workflow execution description to display
executionName
string
unique execution name to use
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
workflow name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
name
string
readable name for the step
negative
boolean
is the step expected to fail
optional
boolean
is the step optional, so its failure won't affect the TestWorkflow result
parallel object
instructions for parallel execution
artifacts object
scrape artifacts from the volumes
compress object
compression options for the artifacts
name
string required
artifact name
minLength:
1
paths
[]string
paths to fetch from the container
workingDir
string
working directory to override, so it will be used as a base dir
count
string | integer
static number of sharded instances to spawn
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)?$
description
string
worker description to display
execute object
execute other Testkube resources
async
boolean
only schedule the resources, don't watch the results (unless it is needed for parallelism)
parallelism
integer
how many resources could be scheduled in parallel
format:
int32tests []object
tests to run
count
string | integer
static number of sharded instances to spawn
description
string
test execution description to display
executionRequest object
pass the execution request overrides
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
name
string
test execution custom name
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
scraperTemplate
string
scraper template extensions
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
test name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
workflows []object
workflows to run
config
object
configuration to pass for the workflow
count
string | integer
static number of sharded instances to spawn
description
string
test workflow execution description to display
executionName
string
unique execution name to use
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
workflow name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
fetch
[]object
instructions for fetching files back
logs
string
should save logs for the parallel step (true if not specified)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
negative
boolean
is the step expected to fail
optional
boolean
is the step optional, so its failure won't affect the TestWorkflow result
parallelism
integer
how many resources could be scheduled in parallel
format:
int32
paused
boolean
pause the step initially
retry object
policy for retrying the step
count
integer
how many times at most it should retry
format:
int32minimum:
1
until
string
until when it should retry (defaults to: "passed")
run object
run specific container in the current step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
shell
string
script to run in a default shell for the container
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
shards
object
parameters that should be distributed across sharded instances
shell
string
script to run in a default shell for the container
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)?$
transfer
[]object
instructions for transferring files
paused
boolean
pause the step initially
pure
boolean
mark the step as pure, applying optimizations to merge the containers together
retry object
policy for retrying the step
count
integer
how many times at most it should retry
format:
int32minimum:
1
until
string
until when it should retry (defaults to: "passed")
run object
run specific container in the current step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
shell
string
script to run in a default shell for the container
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
services
object
list of accompanying services to start
setup
object
steps to run before other operations in this step
shell
string
script to run in a default shell for the container
steps
object
sub-steps to run
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)?$
workingDir
string
working directory to use for this step
steps []object
steps to execute in the workflow
artifacts object
scrape artifacts from the volumes
compress object
compression options for the artifacts
name
string required
artifact name
minLength:
1
paths
[]string
paths to fetch from the container
workingDir
string
working directory to override, so it will be used as a base dir
condition
string
expression to declare under which conditions the step should be run
defaults to: "passed", except artifacts where it defaults to "always"
container object
defaults for the containers in this step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
content object
content that should be fetched for this step
files []object
files to load
content
string
plain-text content to put inside
contentFrom object
external source to use
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
mode
integer
mode to use for the file
format:
int32
path
string required
path where the file should be accessible at
minLength:
1git object
git repository details
authType
string
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
paths to fetch for the sparse checkout
revision
string
branch, commit or a tag name to fetch
sshKey
string
plain text SSH private key to fetch with
sshKeyFrom object
external SSH private key to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
token
string
plain text token to fetch with
tokenFrom object
external token to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
uri
string
uri for the Git repository
username
string
plain text username to fetch with
usernameFrom object
external username to fetch with
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
tarball []object
tarballs to unpack
mount
boolean
should it mount a new volume there
path
string required
path where the tarball should be extracted
url
string required
url for the tarball to extract
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)?$execute object
execute other Testkube resources
async
boolean
only schedule the resources, don't watch the results (unless it is needed for parallelism)
parallelism
integer
how many resources could be scheduled in parallel
format:
int32tests []object
tests to run
count
string | integer
static number of sharded instances to spawn
description
string
test execution description to display
executionRequest object
pass the execution request overrides
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
name
string
test execution custom name
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
scraperTemplate
string
scraper template extensions
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
test name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
workflows []object
workflows to run
config
object
configuration to pass for the workflow
count
string | integer
static number of sharded instances to spawn
description
string
test workflow execution description to display
executionName
string
unique execution name to use
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
workflow name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
name
string
readable name for the step
negative
boolean
is the step expected to fail
optional
boolean
is the step optional, so its failure won't affect the TestWorkflow result
parallel object
instructions for parallel execution
artifacts object
scrape artifacts from the volumes
compress object
compression options for the artifacts
name
string required
artifact name
minLength:
1
paths
[]string
paths to fetch from the container
workingDir
string
working directory to override, so it will be used as a base dir
count
string | integer
static number of sharded instances to spawn
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)?$
description
string
worker description to display
execute object
execute other Testkube resources
async
boolean
only schedule the resources, don't watch the results (unless it is needed for parallelism)
parallelism
integer
how many resources could be scheduled in parallel
format:
int32tests []object
tests to run
count
string | integer
static number of sharded instances to spawn
description
string
test execution description to display
executionRequest object
pass the execution request overrides
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
name
string
test execution custom name
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
scraperTemplate
string
scraper template extensions
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
test name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
workflows []object
workflows to run
config
object
configuration to pass for the workflow
count
string | integer
static number of sharded instances to spawn
description
string
test workflow execution description to display
executionName
string
unique execution name to use
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
name
string
workflow name to run
shards
object
parameters that should be distributed across sharded instances
tarball
object
pack some data from the original file system to serve them down
fetch
[]object
instructions for fetching files back
logs
string
should save logs for the parallel step (true if not specified)
matrix
object
matrix of parameters to spawn instances (static)
maxCount
string | integer
dynamic number of sharded instances to spawn - it will be lowered if there is not enough sharded values
negative
boolean
is the step expected to fail
optional
boolean
is the step optional, so its failure won't affect the TestWorkflow result
parallelism
integer
how many resources could be scheduled in parallel
format:
int32
paused
boolean
pause the step initially
retry object
policy for retrying the step
count
integer
how many times at most it should retry
format:
int32minimum:
1
until
string
until when it should retry (defaults to: "passed")
run object
run specific container in the current step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
shell
string
script to run in a default shell for the container
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
shards
object
parameters that should be distributed across sharded instances
shell
string
script to run in a default shell for the container
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)?$
transfer
[]object
instructions for transferring files
paused
boolean
pause the step initially
pure
boolean
mark the step as pure, applying optimizations to merge the containers together
retry object
policy for retrying the step
count
integer
how many times at most it should retry
format:
int32minimum:
1
until
string
until when it should retry (defaults to: "passed")
run object
run specific container in the current step
args
[]string
override default command in the image (empty string to default CMD of the image)
command
[]string
override default command in the image (empty string to default ENTRYPOINT of the image)
env []object
environment variables to append to the container
name
string required
Name of the environment variable. Must be a C_IDENTIFIER.
value
string
Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".
valueFrom object
Source for the environment variable's value. Cannot be used if value is not empty.
configMapKeyRef object
key
string required
name
string
optional
boolean
fieldRef object
apiVersion
string
fieldPath
string required
resourceFieldRef object
containerName
string
divisor
string | integer
string pattern:
^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
resource
string required
secretKeyRef object
key
string required
name
string
optional
boolean
envFrom []object
external environment variables to append to the container
configMapRef object
The ConfigMap to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the ConfigMap must be defined
prefix
string
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
secretRef object
The Secret to select from
name
string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Add other useful fields. apiVersion, kind, uid?
optional
boolean
Specify whether the Secret must be defined
image
string
image to be used for the container
imagePullPolicy
string
pulling policy for the image
resources object
expected resources for the container
limits
object
resource limits for the container
requests
object
resource requests for the container
securityContext object
allowPrivilegeEscalation
boolean
capabilities object
add
[]string
drop
[]string
privileged
boolean
procMount
string
readOnlyRootFilesystem
boolean
runAsGroup
integer
format:
int64
runAsNonRoot
boolean
runAsUser
integer
format:
int64seLinuxOptions object
level
string
role
string
type
string
user
string
seccompProfile object
localhostProfile
string
type
string required
windowsOptions object
gmsaCredentialSpec
string
gmsaCredentialSpecName
string
hostProcess
boolean
runAsUserName
string
shell
string
script to run in a default shell for the container
volumeMounts []object
mountPath
string required
mountPropagation
string
name
string required
readOnly
boolean
subPath
string
subPathExpr
string
workingDir
string
override default working directory in the image (empty string to default WORKDIR for the image)
services
object
list of accompanying services to start
setup
object
steps to run before other operations in this step
shell
string
script to run in a default shell for the container
steps
object
sub-steps to run
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)?$
workingDir
string
working directory to use for this step
system object
system configuration to define the orchestration behavior
isolatedContainers
boolean
disable the behavior of merging multiple operations in a single container
pureByDefault
boolean
assume all the steps are pure by default
No matches. Try .spec.after for an exact path