SyncNamespaceFiles

yaml

type: "io.kestra.plugin.git.SyncNamespaceFiles"

Sync Namespace Files from Git to Kestra.

This task syncs Namespace Files from a given Git branch to a Kestra `namespace. If the delete property is set to true, any Namespace Files available in kestra but not present in the gitDirectory will be deleted, allowing to maintain Git as a single source of truth for your Namespace Files. Check the Version Control with Git documentation for more details. Using this task, you can push one or more Namespace Files from a given kestra namespace to Git. Check the Version Control with Git documentation for more details.

Examples

Sync Namespace Files from a Git repository. This flow can run either on a schedule (using the Schedule trigger) or anytime you push a change to a given Git branch (using the Webhook trigger).

yaml

id: sync_from_git
namespace: system

tasks:
  - id: git
    type: io.kestra.plugin.git.SyncNamespaceFiles
    namespace: prod
    gitDirectory: _files # optional; set to _files by default
    delete: true # optional; by default, it's set to false to avoid destructive behavior
    url: https://github.com/kestra-io/flows
    branch: main
    username: git_username
    password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
    dryRun: true  # if true, the task will only log which flows from Git will be added/modified or deleted in kestra without making any changes in kestra backend yet

triggers:
  - id: every_minute
    type: io.kestra.plugin.core.trigger.Schedule
    cron: "*/1 * * * *"

Properties

`branch`

Type: string
Dynamic: ✔️
Required: ❌
Default: kestra

The branch from which Namespace Files will be synced to Kestra.

`cloneSubmodules`

Type: boolean
Dynamic: ❌
Required: ❌

Whether to clone submodules.

`delete`

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

Whether you want to delete Namespace Files present in kestra but not present in Git.

It’s false by default to avoid destructive behavior. Use with caution because when set to true, this task will delete all Namespace Files which are not present in Git.

`dryRun`

Type: boolean
Dynamic: ❌
Required: ❌
Default: false

If true, the task will only output modifications without performing any modification to Kestra. If false (default), all listed modifications will be applied.

`gitDirectory`

Type: string
Dynamic: ✔️
Required: ❌
Default: _files

Directory from which Namespace Files should be synced.

If not set, this task assumes your branch includes a directory named _files

`namespace`

Type: string
Dynamic: ✔️
Required: ❌
Default: {{ flow.namespace }}

The namespace from which files should be synced from the gitDirectory to Kestra.

`passphrase`

Type: string
Dynamic: ✔️
Required: ❌

The passphrase for the privateKey.

`password`

Type: string
Dynamic: ✔️
Required: ❌

The password or Personal Access Token (PAT). When you authenticate the task with a PAT, any flows or files pushed to Git from Kestra will be pushed from the user associated with that PAT. This way, you don't need to configure the commit author (the authorName and authorEmail properties).

`privateKey`

Type: string
Dynamic: ✔️
Required: ❌

PEM-format private key content that is paired with a public key registered on Git.

To generate an ECDSA PEM format key from OpenSSH, use the following command: ssh-keygen -t ecdsa -b 256 -m PEM. You can then set this property with your private key content and put your public key on Git.

`url`

Type: string
Dynamic: ✔️
Required: ❌

The URI to clone from.

`username`

Type: string
Dynamic: ✔️
Required: ❌

The username or organization.

Was this page helpful?

​Sync​Namespace​Files

SyncNamespaceFiles

SyncNamespaceFiles