Test Workflows - Job and Pod
You may need to configure the Job and Pod used for execution. It can be also used for parallel workers and services.
Read more about the Workflow Architecture to understand how Testkube creates Jobs and Pods to execute your Workflows.
Job
Allows you to configure the underlying Kubernetes Job generated for a Workflow - Schema Reference.
Labels & Annotations
You may simply add labels and annotations for the Job using labels
and annotations
properties:
spec:
job:
labels:
some-label: some-value
variadic-label: '{{ execution.id }}'
annotations:
example.io/some-annotation: some-text
Timeout
To configure maximum time for a job to live, you can use activeDeadlineSeconds
property:
spec:
job:
# kill the TestWorkflow if it's not finished 10 minutes after scheduled
activeDeadlineSeconds: 600
Execution Namespace
You may select a different namespace for execution, if Testkube is configured to work with it.
spec:
job:
# schedule the execution in `another-testkube-zone` namespace
namespace: another-testkube-zone
Pod
To pass custom Pod configuration, you may pass it in the pod
property. It supports most of the native Kubernetes' PodSpec configuration.
Labels & Annotations
You may simply add labels and annotations for the Pod using labels
and annotations
properties:
spec:
pod:
labels:
some-label: some-value
variadic-label: '{{ execution.id }}'
annotations:
example.io/some-annotation: some-text
Security Context
You may configure PodSecurityContext using securityContext
to override the defaults.
pod:
securityContext:
runAsNonRoot: true
runAsUser: 100690000
Service Account
By default, Testkube creates and uses a service account that will allow you to use all Testkube features. If you need to use custom service account, you may configure it:
pod:
serviceAccountName: some-account
Example: Single Execution Per Node
You can design Kubernetes' Affinity and anti-affinity to choose where the pod should be scheduled.
pod:
labels:
sync-execution: '{{ workflow.name }}-execution'
affinity:
# Ensure no other {{ workflow.name }} execution on same node
podAntiAffinity:
requiredDuringSchedulingIgnoredDuringExecution:
- topologyKey: kubernetes.io/hostname
labelSelector:
matchExpressions:
- key: sync-execution
operator: In
values:
- '{{ workflow.name }}-execution'
Example: Distribute Evenly Across Nodes
To ensure that multiple executions will be distributed evenly across Kubernetes nodes in the cluster, you may use Pod Topology Spread Constraints:
pod:
topologySpreadConstraints:
- maxSkew: 1
topologyKey: kubernetes.io/hostname
whenUnsatisfiable: ScheduleAnyway
labelSelector:
matchLabels:
# execution level - for distributing parallel workers of execution
distribute-evenly: '{{execution.id}}-worker'
# Test Workflow level - for distributing parallel executions
# distribute-evenly: '{{workflow.name}}-execution'
Example: Mount Custom Volume
You can easily attach Volumes for the Pod and mount them to Containers.
pod:
volumes:
- name: some-name
ephemeral:
volumeClaimTemplate:
storageClassName: standard
resources:
requests:
storage: 1Gi
container:
volumeMounts:
- name: some-name
mountPath: /mnt/some/name