search

grafana-wizzy / wizzy

Manage & automate Grafana with easy wizzy
https://grafana-wizzy.com
Apache License 2.0
468 stars 60 forks source link

Delete local commands that are "pointless" with GridLayout #166

Open iori-yja opened 4 years ago

iori-yja commented 4 years ago

Summary

There is 0.7.0 milestone which seems to mean partially updating wizzy features for grafana 5.0 or later (except folders and login). With this release, it is expected to be capable to manage new gridlayout dashboard.

cf. https://github.com/grafana-wizzy/wizzy/issues/129, https://github.com/grafana-wizzy/wizzy/issues/121

In the recent conversation with @Sytten, as I see it very reasonable, it is shown a policy that one version of wizzy should support only the corresponding grafana version.

we should only support one version (the latest) and tag the releases according to that

https://github.com/grafana-wizzy/wizzy/issues/129#issuecomment-531403059

And this means that the several current subcommands in wizzy will be obsoleted in that release. This issue is intended to point this task out.

Commands to be obsoleted

I took a glance to list the obsolete subcommands, but of course, it's an open list. Please add or edit this list.

All row Objective type (after 5.0, a row is a panel, so it must be possible to treat it as a panel)

Row is not a special model anymore, so all of these commands can be deleted.

   wizzy move row SOURCE DESTINATION
   wizzy remove row ROW_NUMBER
   wizzy extract row ROW_NUMBER ROW_NAME
   wizzy insert row ROW_NAME <DASHBOARD_SLUG>

Alternative idea is to have a row command for the convenience, but the argument type must be changed in this case.

Panel command arguments format

  wizzy copy panel SOURCE DESTINATION
  wizzy move panel SOURCE DESTINATION
  wizzy remove panel ROW_NUMBER.PANEL_NUMBER
  wizzy extract row ROW_NUMBER.PANEL_NUMBER PANEL_NAME
  wizzy insert row ROW_NAME <DASHBOARD_SLUG>

Panels are not children of a row, so ROW_NUMBER.PANEL_NUMBER format is meaningless. Also, SOURCE and DESTINATION format in copy|move panel must be noted.

I think the panel copy, move or remove commands will be specified a panel with an id, but I'm not sure about copy or move's destination.