syncdashboards
Enterprise Edition Talk to us
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, maintaining Git as the single source of truth for your dashboards.
Check the Version Control with Git documentation for more details.
type: "io.kestra.plugin.git.syncdashboards"Examples
Sync all dashboards from Git to Kestra every full hour.
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
branchstring
mainThe branch from which dashboards will be synced to Kestra.
cloneSubmodulesbooleanstring
Whether to clone submodules
connectTimeoutintegerstring
10000Connect timeout in milliseconds for HTTP connections.
deletebooleanstring
falseWhether you want to delete dashboards present in kestra but not present in Git.
dryRunbooleanstring
falseIf true, the task will only output modifications without performing any modification to Kestra. If false (default), all listed modifications will be applied.
failOnMissingDirectorybooleanstring
trueIf true (default), the task will fail if the specified directory doesn't exist. If false, missing directories will be skipped.
gitConfigobject
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
gitDirectorystring
_dashboardsDirectory from which dashboards should be synced.
noProxybooleanstring
Specify whether to disable proxy.
passphrasestring
The passphrase for the privateKey
passwordstring
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).
privateKeystring
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.
readTimeoutintegerstring
60000Read timeout in milliseconds for HTTP connections.
trustedCaPemPathstring
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.
urlstring
The URI to clone from
usernamestring
The username or organization
