Skip to content

GitOps promotion gates

Make Flux or Argo CD stop the next rollout step when a service breaks its contract. Copy one snippet below and a NonCompliant Pacto turns the Kustomization unready or the Application Degraded.

These snippets stop the next step, not the current deploy: by the time the operator has a verdict the pods are already serving. The Kustomization goes unready, the dependent one waits and the Argo Application goes Degraded. To catch a breaking change before it lands, use pacto impact in the pull request.

Flux and Argo CD read status.contractStatus only through an extension point. Without one, a Kustomization holding a NonCompliant Pacto reports healthy. The two snippets below configure that extension point.

Flux

Flux decides health with kstatus, its built-in status reader, which recognises only the Ready, Reconciling and Stalled conditions. Pacto publishes ContractValid, RuntimeObserved and ReadinessSatisfied, so kstatus discards all three and the object falls through to Current: the gate looks configured and passes everything. spec.healthCheckExprs (kustomize-controller v1.5.0, flux2 v2.5.0 and later) replaces that fallback with a CEL expression:

# Flux promotion gate driven by the Pacto contract verdict.
#
# This file is published verbatim in integrations/kubernetes/docs/gitops.md and
# applied verbatim by tests/acceptance/kind/gitops-flux.sh. Edit it and you edit
# both; the documented snippet cannot drift from the tested one.
---
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
  name: orders-staging
  namespace: flux-system
spec:
  interval: 1m
  # Must exceed the operator's stabilization window (default 2m) plus one
  # requeue interval, or a real violation arrives as an ambiguous timeout
  # instead of a clean failure.
  timeout: 5m
  prune: true
  wait: true
  sourceRef:
    kind: OCIRepository
    name: orders
  path: ./staging
  healthCheckExprs:
    - apiVersion: pacto.trianalab.io/v1alpha1
      kind: Pacto
      failed: status.contractStatus in ['NonCompliant', 'Invalid']
      current: status.contractStatus in ['Compliant', 'Reference', 'Warning']
---
apiVersion: kustomize.toolkit.fluxcd.io/v1
kind: Kustomization
metadata:
  name: orders-production
  namespace: flux-system
spec:
  interval: 1m
  timeout: 5m
  prune: true
  wait: true
  # Production does not start until staging is healthy, and healthy now
  # includes the contract verdict. This line is the promotion gate.
  dependsOn:
    - name: orders-staging
  sourceRef:
    kind: OCIRepository
    name: orders
  path: ./production

sourceRef is whatever you already use. Three things about that snippet, each checked against fluxcd/pkg runtime/cel/status_evaluator.go:

  • The snippet leaves out inProgress on purpose. When no expression matches, Flux falls through to in-progress, so an unrecognised verdict holds the deploy until it times out. It fails closed.
  • Warning sits in the passing set. Move that one word to failed if you want contract warnings to block promotions. That is the whole knob.
  • timeout must exceed the operator's stabilization window, or a real violation reaches you as an ambiguous timeout. See Timing.

A freshly created Pacto has no status and the expression errors while that is true; Flux treats the error as not-yet-healthy and keeps polling.

tests/acceptance/kind/gitops-flux.sh applies that exact file to a kind cluster and asserts the dependent Kustomization never reaches it while the contract is violated.

Argo CD

Argo picks a health check from a fixed list of built-in kinds and returns no health for any other kind. The roll-up into Application health skips a resource with no health, so Argo ignores a Pacto. A resource health customization in argocd-cm supplies the missing check:

# Argo CD health customization that makes a violated Pacto contract turn its
# Application red.
#
# This file is published verbatim in integrations/kubernetes/docs/gitops.md.
# Apply it as a MERGE PATCH, never as a plain `kubectl apply` -- argocd-cm holds
# Argo's own keys and a full apply would drop them:
#
#   kubectl -n argocd patch configmap argocd-cm --type merge \
#     --patch-file argocd-cm-pacto-health.yaml
#
# The data key must be typed exactly. Argo silently ignores a key it does not
# recognise, which looks identical to having configured nothing at all.
apiVersion: v1
kind: ConfigMap
metadata:
  name: argocd-cm
  namespace: argocd
data:
  resource.customizations.health.pacto.trianalab.io_Pacto: |
    -- Argo runs this with the Lua string library disabled.
    -- Only concatenation, comparison, ipairs and tostring() are available.

    -- Set to "Degraded" to make contract warnings block a promotion.
    local warningHealth = "Healthy"

    local hs = {}

    if obj.status == nil or obj.status.contractStatus == nil then
      hs.status = "Progressing"
      hs.message = "waiting for the first contract evaluation"
      return hs
    end

    if obj.status.observedGeneration ~= obj.metadata.generation then
      hs.status = "Progressing"
      hs.message = "contract not yet evaluated at this generation"
      return hs
    end

    local s = obj.status.contractStatus

    if s == "Compliant" or s == "Reference" then
      hs.status = "Healthy"
      hs.message = "contract satisfied"
      return hs
    end

    if s == "Warning" then
      hs.status = warningHealth
      hs.message = "contract satisfied with warnings"
      return hs
    end

    if s == "NonCompliant" then
      hs.status = "Degraded"
      hs.message = "contract violated"
      if obj.status.findings ~= nil then
        for _, f in ipairs(obj.status.findings) do
          if f.severity == "error" then
            hs.message = "contract violated: " .. tostring(f.code) .. ": " .. tostring(f.message)
            break
          end
        end
      end
      return hs
    end

    if s == "Invalid" then
      hs.status = "Degraded"
      hs.message = "contract is invalid and could not be evaluated"
      return hs
    end

    -- Unknown, NotEvaluated, and anything added later.
    hs.status = "Progressing"
    hs.message = "contract verdict pending: " .. tostring(s)
    return hs

Apply it as a merge patch, because argocd-cm holds Argo's own configuration and a plain kubectl apply would drop it. Then restart the controller:

kubectl -n argocd patch configmap argocd-cm --type merge \
  --patch-file argocd-cm-pacto-health.yaml
kubectl -n argocd rollout restart statefulset/argocd-application-controller

The restart is required. The application controller reads health customizations into its resource cache at startup, and that cached verdict is what it compares to decide whether a changed object needs re-examining. Until it has the customization, every verdict the operator writes compares equal to the last and the Application only catches up on the next periodic resync. On a core install, without argocd-server, a restart is the only way in: hot reload of argocd-cm needs server.secretkey, which only argocd-server creates.

In the Lua, anything unrecognised becomes Progressing. Argo's Unknown ranks worse than Degraded and would mask broken workloads, so the script never returns it. The string library is also disabled, so string.format and s:gsub() fail at runtime, after the script loads.

tests/acceptance/kind/gitops-argocd.sh runs that exact file through the Lua sandbox with no cluster, and then inside a kind cluster where an Application must go Degraded naming the finding and back to Healthy once corrected.

Check that it took

Argo ignores a data key it does not recognise, and an ignored key looks exactly like having configured nothing:

# The key must read back exactly, group and kind included.
kubectl -n argocd get cm argocd-cm \
  -o jsonpath='{.data.resource\.customizations\.health\.pacto\.trianalab\.io_Pacto}'

Then ask Argo what it makes of a real object. argocd admin settings evaluates the customization against files on disk, in the same Lua sandbox the controller uses, so it answers without waiting for a sync:

kubectl -n argocd get cm argocd-cm -o yaml > /tmp/argocd-cm.yaml
kubectl -n <namespace> get pacto <name> -o yaml > /tmp/pacto.yaml

argocd admin settings resource-overrides health /tmp/pacto.yaml \
  --argocd-cm-path /tmp/argocd-cm.yaml

A Compliant Pacto prints STATUS: Healthy and MESSAGE: contract satisfied. A key that did not take prints Health script is not configured while exiting 0, so read the output and ignore the exit code. Both checks read the ConfigMap, so they also pass on a controller that started before the patch.

Timing

The gate is as fresh as the verdict behind it, and verdicts land at different speeds.

Change When it becomes NonCompliant
A mismatch: workload, persistence or configuration conformance The first reconcile after the workload is observed
An absence: a missing interface, capability, dependency, Secret or ConfigMap After the stabilization window (default two minutes) plus one requeue interval

That split is why timeout has a floor: five minutes against the default two-minute window leaves room for the window, one requeue and the apply.

Argo re-examines a Pacto when its health status changes, so Healthy to Degraded shows up in about a second. But one NonCompliant reason replaced by another keeps the stale message until the next periodic resync. The status changes at once and the message catches up later.

Limits

  • Argo health customizations are instance-global. One Argo serving several teams cannot give one a blocking Warning and another a passing one.
  • Neither tool can refuse an artifact for what is inside it. "Reject this because its contract breaks three consumers" is a pull-request check.
  • The verdict is about the contract. Compliant says the workload matches its contract. It says nothing about request errors or saturation.
  • status.lastReconciledAt cannot gate on freshness. Neither tool hands the expression a clock.