Git SyncDashboards

Git SyncDashboards

Certified

Sync dashboards from Git

Imports dashboards from a Git branch. Can delete dashboards missing in Git, respects .kestraignore, and supports dry-run diff output.

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
Defaultmain

Branch to sync

Defaults to main.

Clone submodules

Default false; enable to fetch and initialize nested submodules.

Default10000

HTTP connect timeout (ms)

Default 10000 ms.

Defaultfalse

Delete dashboards missing in Git

Default false to avoid destructive syncs.

Defaultfalse

Dry run only

When true, writes a diff without applying changes to Kestra.

Defaulttrue

Fail if git directory missing

Default true. If false, skips when the rendered gitDirectory path does not exist.

Git configuration overrides

Map of git config keys and values applied after clone, e.g.:

  • core.fileMode: false (ignore permission flips)
  • core.autocrlf: false (preserve line endings)
Default_dashboards

Git directory for dashboards

Relative path containing dashboard YAML; defaults to _dashboards.

Disable proxy for HTTP

When true, forces direct connections instead of using the JVM proxy settings.

Passphrase for privateKey

Password or personal access token

Supplies HTTP credentials. When a PAT is used, pushes are recorded under that PAT’s user without needing authorName and authorEmail.

**GitHub PAT permissions required: **

  • Fine-grained PAT: Contents: Read (clone/fetch) or Contents: Read and Write (push), plus Metadata: Read (mandatory base permission). Add Workflows: Read and Write when pushing .github/workflows/ files.
  • Classic PAT: repo scope covers all read/write operations; add workflow when pushing workflow files.

Reference (ref) of the pluginDefaults to apply to this task.

PEM private key

PEM-formatted private key matching a public key registered on the Git server. Generate with ssh-keygen -t ecdsa -b 256 -m PEM.

Default60000

HTTP read timeout (ms)

Default 60000 ms.

Extra trusted CA PEM path

Optional PEM-encoded CA bundle added to the JVM truststore; equivalent to git config http.sslCAInfo <path> for self-signed or internal CAs.

Repository URL

HTTP(S) or SSH URI used for clone and push operations.

Username or organization

Used for HTTP basic authentication and as a fallback commit author.

More Plugins in this Category

NetBox (EE)
NetBox
Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

7 tasks

4 blueprints

YouTube
YouTube

Tasks that interact with the YouTube Data API.

Business

4 tasks