Skip to content

Nexo GitOps

The git transport family: getting your definitions repo onto the sink host and back. The pair moves the GitOps bundle — GitPull clones the repo for an import, GitCommitPush commits an export back. See the overview for how every module executes and the shared parameter types, and the GitOps YAML reference for the bundle format itself.

The current line is 1.0.0, the family’s first release.

What it does — clones the tenant’s definitions repo and hands the checkout path to the next action.

How it works

  • Fresh clone every run — a new temporary directory each time, shallow (--depth 1), at the configured branch. No state survives between runs; nothing is cached or reused.
  • The checkout path is emitted as result data (result.data.path) — chain the next action’s path DATA param to it (in the shipped machinery, GitOpsImport).
  • Auth
    • https_pat (default) — for http(s) remotes the username and PAT are embedded in the clone URL. With an empty username the token authenticates as x-access-token (GitHub-style); for Bitbucket and Azure DevOps fill in your username (your account username / any value respectively).
    • ssh — the URL passes through exactly as written, so SSH remotes (git@…, ssh://…) and file:// are never rewritten. SSH auth relies on the host’s ssh configuration (keys or agent) — nothing extra is configured on the action.
  • Fails loudly when git is not installed on the host — the error names git.

Needs from the node — git on the host (declared requirement binary: git — placement only matches sink nodes that cover it).

Parameters

KeyType optionsMeaning
repoSTATICThe clone URL — the first parameter
branchSTATICBranch to check out (default main)
authSTATIC — https_pat (default) or sshHow the clone authenticates
usernameSTATICBasic-auth user for https_pat; empty = x-access-token
tokenSECRETThe PAT — resolved from the Secrets store before dispatch

What it does — commits an exported bundle into the definitions repo and pushes it.

How it works

  • Clones fresh like GitPull (same auth options), then replaces the four managed directories — actions/, flows/, sources/, sinks/ — with the bundle at path. Everything else in the repo (README, CI files) is left alone, and bundle files outside the managed directories are ignored.
  • No-change skip — when the replacement changes nothing, the commit and push are skipped and the run still succeeds.
  • Commits as nexomatic-gitops <gitops@nexomatic> with the configured message and pushes to the configured branch.
  • path is DATA and therefore hostile: it must be an absolute, existing directory (the chained GitOpsExport emits one) — anything else fails loudly.

Needs from the node — git on the host (declared requirement binary: git).

Parameters

KeyType optionsMeaning
pathDATADirectory holding the exported bundle (from GitOpsExport) — the first parameter
repoSTATICThe clone URL
branchSTATICBranch to push (default main)
messageSTATICCommit message (default gitops: export tenant definitions)
authSTATIC — https_pat (default) or sshHow the clone and push authenticate
usernameSTATICBasic-auth user for https_pat; empty = x-access-token
tokenSECRETThe PAT — resolved from the Secrets store before dispatch

The shipped GitOps machinery pairs these modules with the platform family (Nexo Platform):

repo ──GitPull──► checkout ──GitOpsImport──► platform (import, auto on push)
platform ──GitOpsExport──► bundle ──GitCommitPush──► repo (export, on demand)

Onboarding, the webhook, and pruning are the GitOps Definitions guide’s business.