SyncDashboards

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"

Examples

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

branch string

Default main

The branch from which dashboards will be synced to Kestra.

cloneSubmodules booleanstring

Whether to clone submodules

delete booleanstring

Default false

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

dryRun booleanstring

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.

failOnMissingDirectory booleanstring

Default true

If true (default), the task will fail if the specified directory doesn't exist. If false, missing directories will be skipped.

gitConfig object

Git configuration to apply to the repository

Map of Git config keys and values, applied after clone few examples: - 'core.fileMode': false -> ignore file permission changes - 'core.autocrlf': false -> prevent line ending conversion

gitDirectory string

Default _dashboards

Directory from which dashboards should be synced.

passphrase string

The passphrase for the privateKey

password string

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 string

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.

trustedCaPemPath string

Optional path to a PEM-encoded CA certificate to trust (in addition to the JVM default truststore)

Equivalent to git config http.sslCAInfo <path>. Use this for self-signed/internal CAs.

url string

The URI to clone from

username string

The username or organization

​Sync​Dashboards

SyncDashboards