Skip to content
Proud to collaborate with Microsoft for Startups

k8s.app.set-image ​

Patch a Deployment's container image and wait for rollout to be Available. Helm-safe — only touches the image field.

Patch a Deployment's container image and wait for rollout to be Available.

Overview ​

PropertyValue
Workflow typeDag
LibraryApp-kubernetes
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—CloudConnection UUID for the target Kubernetes cluster, picked from the organization's kubernetes-type connections.
namespacestringYes—Namespace the Deployment lives in
namestringYes—Deployment name
containerstringYes—Name of the container within the pod template to update
imagestringYes—New image reference, e.g. registry/repo:tag
timeout_secondsintegerNo—Total wait budget for rollout to become Available (default 300, cap 1800)
poll_intervalintegerNo—Seconds between status reads while waiting (default 5, cap 60)

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID for the target cluster, echoed from input.
namespacestringNo——
namestringNo——
containerstringNo——
imagestringNo——
timeout_secondsintegerNo——
poll_intervalintegerNo——
workflow_run_uuidstringNo—Engine-stamped DAG run id written by action_start.
set_imagejsonNo——
wait_readyjsonNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

DAG Layers ​

#LayerStepsCompensation
1set_imagekubernetes.deployment.set_image—
2wait_readykubernetes.deployment.wait_for_available—

Execution Flow ​

Sub-workflows ​

Sub-workflowStep name
kubernetes.deployment.set_imageset_image
kubernetes.deployment.wait_for_availablewait_ready

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "k8s.app.set-image",
  "initial_data": {
    "connection_uuid": "value",
    "namespace": "value",
    "name": "value",
    "container": "value"
  }
}