pluginsplugin-git

SyncDashboards​Sync​Dashboards

Sync dashboards from Git to Kestra.

This task syncs dashboards from a given Git branch to Kestra. If the delete property is set to true, any dashboard available in Kestra but not present in the gitDirectory will be deleted, considering Git as a single source of truth for your dashboards. Check the Version Control with Git documentation for more details.

yaml
type: "io.kestra.plugin.git.SyncDashboards"

Sync all dashboards from Git to Kestra every full hour.

yaml
id: git_sync
namespace: company

tasks:
  - id: sync_dashboards
    type: io.kestra.plugin.git.SyncDashboards
    gitDirectory: _dashboards
    branch: dashboards

pluginDefaults:
  - type: io.kestra.plugin.git
    values:
      username: kestra-git-user
      url: https://github.com/my-company/my-repo
      password: "{{ secret('GITHUB_ACCESS_TOKEN') }}"
      branch: main
      dryRun: false

triggers:
  - id: every_full_hour
    type: io.kestra.plugin.core.trigger.Schedule
    cron: "0 * * * *"
Properties
Default main

The branch from which dashboards will be synced to Kestra.

Whether to clone submodules.

Default false

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

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.

Default _dashboards

Directory from which dashboards should be synced.

The passphrase for the privateKey.

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).

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.

The URI to clone from.

The username or organization.