Custom folder if for dashboard push (#9)

mpostument · Mar 8, 2021 · ebe68a2 · ebe68a2
1 parent dd0f8be
commit ebe68a2
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/README.MD b/README.MD
@@ -17,6 +17,7 @@ Keep your grafana dashboards in sync.
     - [Push](#push)
       - [Push dashboards to grafana](#push-dashboards-to-grafana)
       - [Push folders to grafana](#push-folders-to-grafana)
+      - [Push folders to grafana in custom folder](#push-folders-to-grafana-in-custom-folder)
       - [Push notifications to grafana](#push-notifications-to-grafana)
       - [Push datasources to grafana](#push-datasources-to-grafana)
   - [Global parameters](#global-parameters)
@@ -33,13 +34,13 @@ Download the latest binary from [releases](https://github.com/mpostument/grafana
 
 #### Save all dashboards to directory
 
-`grafana-sync pull-dashboards`  
+`grafana-sync pull-dashboards --directory="dashboards`  
 Example:
  `grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000`
 
 #### Save dashboards with specific tags to directory
 
-`grafana-sync pull-dashboards`  
+`grafana-sync pull-dashboards --tag=export`  
 Example:
  `grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --tag=export`  
 
@@ -75,6 +76,23 @@ Example:
 Example:
  `grafana-sync push-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000`
 
+#### Push folders to grafana in custom folder
+
+Find grafana folder Id by opening /api/folders in browser.  
+Example:
+`http://127.0.0.1:3000/api/folders`
+
+Find required folderId in output
+
+```json
+[{"id":1,"uid":"RcuWg5UMz","title":"TestFolder"}]
+```
+
+Specify folder id in push command
+`grafana-sync push-folders --folderId=<FolderId>`  
+Example:
+ `grafana-sync push-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000 --folderId=1`
+
 #### Push notifications to grafana
 
 `grafana-sync push-notifications`  

diff --git a/cmd/root.go b/cmd/root.go
@@ -60,7 +60,8 @@ var pushDashboardsCmd = &cobra.Command{
 		url, _ := cmd.Flags().GetString("url")
 		apiKey, _ := cmd.Flags().GetString("apikey")
 		directory, _ := cmd.Flags().GetString("directory")
-		if err := grafana.PushDashboard(url, apiKey, directory); err != nil {
+		folderId, _ := cmd.Flags().GetInt("folderId")
+		if err := grafana.PushDashboard(url, apiKey, directory, folderId); err != nil {
 			log.Fatalln("Push dashboards command failed", err)
 		}
 	},
@@ -167,7 +168,8 @@ func init() {
 	rootCmd.PersistentFlags().StringP("url", "u", "http://localhost:3000", "Grafana Url with port")
 	rootCmd.PersistentFlags().StringP("directory", "d", ".", "Directory where to save dashboards")
 	rootCmd.PersistentFlags().StringP("apikey", "a", "", "Grafana api key")
-	rootCmd.PersistentFlags().StringP("tag", "t", "", "Dashboard tag to read")
+	pullDataSourcesCmd.PersistentFlags().StringP("tag", "t", "", "Dashboard tag to read")
+	pushDashboardsCmd.PersistentFlags().IntP("folderId", "f", 0, "Directory Id to which push dashboards")
 
 	if err := viper.BindPFlag("apikey", rootCmd.PersistentFlags().Lookup("apikey")); err != nil {
 		log.Println(err)

diff --git a/grafana/dashboard.go b/grafana/dashboard.go
@@ -44,7 +44,7 @@ func PullDashboard(grafanaURL string, apiKey string, directory string, tag strin
 	return nil
 }
 
-func PushDashboard(grafanaURL string, apiKey string, directory string) error {
+func PushDashboard(grafanaURL string, apiKey string, directory string, folderId int) error {
 	var (
 		filesInDir []os.FileInfo
 		rawBoard   []byte
@@ -68,7 +68,7 @@ func PushDashboard(grafanaURL string, apiKey string, directory string) error {
 				continue
 			}
 			params := sdk.SetDashboardParams{
-				FolderID:  sdk.DefaultFolderId,
+				FolderID:  folderId,
 				Overwrite: true,
 			}
 			if _, err := c.SetDashboard(ctx, board, params); err != nil {