grafana

Documentation

Index

• Variables
• func ConfigureSSOSettings(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, ...) error
• func DeleteOrganization(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, ...) error
• func PublishDashboard(grafanaAPI *client.GrafanaHTTPAPI, dashboard map[string]any) error
• func UpsertOrganization(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, ...) error
• type Datasource
  • func ConfigureDefaultDatasources(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, ...) ([]Datasource, error)
• type Organization
  • func FindOrgByName(grafanaAPI *client.GrafanaHTTPAPI, name string) (*Organization, error)

Variables

var SharedOrg = Organization{
	ID:        1,
	Name:      "Shared Org",
	TenantIDs: []string{"giantswarm"},
}

Functions

func ConfigureSSOSettings

func ConfigureSSOSettings(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, organizations []Organization) error

func DeleteOrganization

func DeleteOrganization(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, organization Organization) error

func PublishDashboard

func PublishDashboard(grafanaAPI *client.GrafanaHTTPAPI, dashboard map[string]any) error

PublishDashboard creates or updates a dashboard in Grafana

func UpsertOrganization

func UpsertOrganization(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, organization *Organization) error

Types

type Datasource

type Datasource struct {
	ID        int64
	Name      string
	IsDefault bool
	Type      string
	URL       string
	Access    string
	JSONData  map[string]interface{}
}

func ConfigureDefaultDatasources

func ConfigureDefaultDatasources(ctx context.Context, grafanaAPI *client.GrafanaHTTPAPI, organization Organization) ([]Datasource, error)

type Organization

type Organization struct {
	ID        int64
	Name      string
	TenantIDs []string
	Admins    []string
	Editors   []string
	Viewers   []string
}

func FindOrgByName

func FindOrgByName(grafanaAPI *client.GrafanaHTTPAPI, name string) (*Organization, error)

FindOrgByName is a wrapper function used to find a Grafana organization by its name