dashboard

Documentation

Index

• func NewDashboardLoader(fileName string, deps *depspkg.ProvisioningDeps) (provisioning.ProviderLoader, error)
• type Config
• type FileLoader
  • func NewFileLoader(dir string, org *model.Org, provider *dashboardProvider) FileLoader
• type Provider
• type ProviderType

Functions

func NewDashboardLoader

func NewDashboardLoader(fileName string, deps *depspkg.ProvisioningDeps) (provisioning.ProviderLoader, error)

NewDashboardLoader creates dashboard provider loader.

Types

type Config

type Config struct {
	Providers []Provider
}

Config represents dashboard provisioning configuration.

type FileLoader

type FileLoader interface {
	// Run runs file loader, discovery dashboard from local file system.
	Run() error
	// Shutdown shutdowns file loader
	Shutdown() error
}

FileLoader represents dashboard file loader.

func NewFileLoader

func NewFileLoader(dir string, org *model.Org, provider *dashboardProvider) FileLoader

NewFileLoader creates a FileLoader.

type Provider

type Provider struct {
	Name            string         `yaml:"name"`
	Type            ProviderType   `yaml:"type"`
	OrgUID          string         `yaml:"orgUid"`
	Editable        bool           `yaml:"editable"`
	DisableDeletion bool           `yaml:"disableDeletion"`
	AllowUIUpdates  bool           `yaml:"allowUiUpdates"`
	Options         map[string]any `yaml:"options"`
}

Provider represents dashboard provider's configuration.

type ProviderType

type ProviderType string

ProviderType represents dashboard provider type.

const (
	FileProvider ProviderType = "file"
)