Skip to content
Proud to collaborate with Microsoft for Startups

gitops.application.create ​

Bind a GitHub repo path to a Kubernetes cluster and start GitOps sync

Create a GitOpsApplication (repo path ↔ cluster) and start reconciling it.

Validates the cluster connection type and the repo, persists the binding with its sync policy (auto_sync / self_heal / prune default True), and launches a gitops.controller poll loop when auto-sync is enabled.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-gitops
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
namestringYes——
cloud_connection_uuiduuidYes—Target cluster (CloudConnection of type kubernetes)
github_repository_uuiduuidYes——
repo_pathstringNo—Manifests dir in the repo (repo root if omitted)
ref_kindstringNo—branch
refstringNo—Branch/tag name (default main; ignored for latest_release)
target_namespacestringNo——
auto_syncbooleanNo——
self_healbooleanNo——
prunebooleanNo——
poll_interval_secondsintegerNo——
descriptionstringNo——
registry_account_uuiduuidNo—Private registry used to pull images into the target namespace

Output Schema ​

FieldTypeRequiredDefaultDescription
application_uuiduuidNo——
statusstringNo——
controller_workflow_idstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—create—
createdNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingcreatecreated—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "gitops.application.create",
  "initial_data": {
    "organization_uuid": "value",
    "name": "value",
    "cloud_connection_uuid": "value",
    "github_repository_uuid": "value"
  }
}