https://github.com/nicolastakashi/gitana

Gitana is a lightweight dashboard sync
https://github.com/nicolastakashi/gitana

grafana grafana-dashboard grafana-dashboards kubernetes

Last synced: about 7 hours ago
JSON representation

Gitana is a lightweight dashboard sync

• Host: GitHub
• URL: https://github.com/nicolastakashi/gitana
• Owner: nicolastakashi
• License: apache-2.0
• Created: 2021-10-06T07:21:16.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-05T16:02:21.000Z (over 1 year ago)
• Last Synced: 2024-04-15T22:55:21.592Z (7 months ago)
• Topics: grafana, grafana-dashboard, grafana-dashboards, kubernetes
• Language: Go
• Homepage:
• Size: 18.3 MB
• Stars: 65
• Watchers: 2
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Overview

Gitana is a lightweight application that will help you sync Grafana dashboards from a Git repository to Kubernetes ConfigMap and leverages the dashboard sidecar on the [Grafana helm chart](https://github.com/grafana/helm-charts/tree/main/charts/grafana) that provisions dashboard ConfigMaps created by Gitana into Grafana.

# Sync Command Flags

```bash

./gitana sync --help

The sync command pulls the Grafana dashboards from a Git repository and foreach dashboard it will creates a config map for that dashboard:

Usage:

  gitana sync [flags]

Flags:

      --dashboard.folder-annotation string   dashboard folder annotation

      --dashboard.labels string              dashboard label selector (default "grafana_dashboard=nil")

  -h, --help                                 help for sync

      --http.port string                     listem port for http endpoints (default ":9754")

      --kubeconfig string                    (optional) absolute path to the kubeconfig file

      --log.level string                     log level (default "info")

      --namespace string                     namespace that will store the dashboard config map (default "default")

      --repository.auth.password string      password to perform authentication

      --repository.auth.username string      username to perform authentication

      --repository.branch string             git repository branch (default "main")

      --repository.url string                git repository url

      --sync-timer duration                  interval to sync and sync dashboards (default 5m)

```

# Contributing

Contributions are very welcome! See our [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## Docker images

Docker images are available on [Docker Hub](https://hub.docker.com/r/ntakashi/gitana).

## Building from source

To build Gitana from source code, first ensure that you have a working

Go environment with [version 1.16 or greater installed](https://golang.org/doc/install).

To build the source code you can use the `make build`, which will compile in

the assets so that Gitana can be run from anywhere:

```bash

    $ mkdir -p $GOPATH/src/github.com/gitana

    $ cd $GOPATH/src/github.com/gitana

    $ git clone https://github.com/nicolastakashi/gitana.git

    $ cd gitana

    $ make build

    $ ./gitana sync 

```

The Makefile provides several targets:

  * *build*: build the `gitana`

  * *fmt*: format the source code

  * *vet*: check the source code for common errors