Skip to content
Proud to collaborate with Microsoft for Startups

gitops.sync ​

Reconcile one GitOpsApplication (resolve → render → apply/diff → record)

Reconcile one GitOpsApplication: resolve its revision, read manifests from the repo, and apply them to the cluster (or report drift in preview mode).

Inputs:

  • organization_uuid: calling org (required).
  • application_uuid: the GitOpsApplication to reconcile (required).
  • trigger: webhook | poll | manual (default manual). A webhook trigger whose SHA is unchanged short-circuits to skipped; poll always reconciles so it can self-heal drift.

Composes: data.gitops.application.get, github.refs.resolve, github.code.get_tree, github.code.get_blob, k8s.manifest.sync / k8s.manifest.diff_set, data.gitops.sync-run.record.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-gitops
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
application_uuiduuidYes——
triggerstringNo—webhook

Output Schema ​

FieldTypeRequiredDefaultDescription
application_uuiduuidNo——
statusstringNo—synced
commit_shastringNo——
resolved_refstringNo——
manifest_countintegerNo——
resultjsonNo——
sync_run_uuiduuidNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—reconcile—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingreconcilecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "gitops.sync",
  "initial_data": {
    "organization_uuid": "value",
    "application_uuid": "value"
  }
}