Movatterモバイル変換

esnet/gdgPublic

NotificationsYou must be signed in to change notification settings
Fork33
Star397

Grafana Dash-n-Grab

software.es.net/gdg/

License

View license

397 stars 33 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 328 Commits
.github		.github
actions		actions
cli		cli
cmd		cmd
config		config
internal		internal
pkg/test_tooling		pkg/test_tooling
test		test
tools		tools
website		website
.gitignore		.gitignore
.gitmodules		.gitmodules
.golangci.yml		.golangci.yml
.goreleaser.yml		.goreleaser.yml
.mockery.yaml		.mockery.yaml
CONTRIBUTING.md		CONTRIBUTING.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
Taskfile.yml		Taskfile.yml
docker-compose.yml		docker-compose.yml
gdg.tape		gdg.tape
go.mod		go.mod
go.sum		go.sum
lefthook.yml		lefthook.yml
renovate.json		renovate.json

Repository files navigation

Grafana Dash-n-Grab (GDG) -- Resource Manager. The purpose of this project is to provide an easy-to-use CLI to interact with the grafana API allowing you to backup and restore dashboard, connections, and other resources.

The following remote backup locations are supported:

AWS S3
Google Storage
Azure Storage
S3 Compatible Storage (Minio, Ceph, etc)

Please find the generated documentationhere and the code for updating the docs is availablehere

Quickstart

Supported Versions

GDG community will try to support the last 2 major version of grafana. Though there is nothing preventing you from using it with any version of grafana you are dependent on what the API supports/doesn't support and changes that have been added since then.

New features particularly related to Orgs, ACLs, roles etc are far less likely to work the older your version is.

Current Entities supported (See official docs for more details)

Resource	Status	Regex Filtering	Authorization	Enterprise Only
Connections	Supported	Available	Token/Basic
Dashboards	Supported	Available	Token/Basic
Folders	Supported	Optional	Token/Basic
Organization	Supported	N/A	Basic Grafana Admin
Teams	Supported	N/A	Token/Basic
Users	Supported	N/A	Basic
Library Elements	Supported	Available	Token/Basic
Alerting	Beta		Token/Basic
Connections Permissions	Supported		Token/Basic	X

Release conventions.

GDG mostly follows the semver conventions with some minor modifications.

For those that are unfamiliar semver references to X.Y.Z version patterns with

X = Major version
Y = Minor version
Z= patch

Most regular releases will increment the patch number. ie. 0.4.5 is a regular release, and next normal release would be 0.4.6.

Minor version change will likely introduce some breaking change. For example, renaming datasources to connections or someconfiguration changes that are not backward compatible etc.

Major version: Is a major feature set change for example, removing cloud support in the base release and introducing a plugin systemwould be 1.X release. Splitting the GDG binary into a tools and backup cli, or introducing a diff tooling that allow you to comparecontexts. i.e.gdg diff dashboards prod staging is a major divergences from the current expectations so it'll be a major version bump.

For more info, please see the release notes and documentation both availablehere

GDG is powered by theGrafana OpenAPI Client. Any feature exposed by the API couldbe added to GDG if desired, feel free to fill out a feature request on our GitHub issue tracker.