resources

Documentation

Index

• func Mount(config Config, satellitesClient satellites.Client, storeClient store.Client) chi.Router
• type Config
• type Dashboard
• type Integrations
• type ResourceList
• type ResourceResponse
• type Router

Functions

func Mount

func Mount(config Config, satellitesClient satellites.Client, storeClient store.Client) chi.Router

Types

type Config

type Config struct {
	Integrations Integrations `json:"integrations"`
}

Config is the configuration for the resources API. At the moment it allows users to configure integration, which can be used to set a list of default dashboards which should be added to a resource. This is the same as the "kobs.io/dashboards" annotation, but allows to set a list of dashboards for all resources of a certain type which are matching the specified labels.

type Dashboard

type Dashboard struct {
	Resource  string                `json:"resource"`
	Labels    map[string]string     `json:"labels"`
	Dashboard dashboardv1.Reference `json:"dashboard"`
}

type Integrations

type Integrations struct {
	Dashboards []Dashboard `json:"dashboards"`
}

type ResourceList

type ResourceList struct {
	Satellite string         `json:"satellite"`
	Cluster   string         `json:"cluster"`
	List      map[string]any `json:"list"`
}

type ResourceResponse

type ResourceResponse struct {
	Resource      shared.Resource `json:"resource"`
	ResourceLists []ResourceList  `json:"resourceLists"`
	Errors        []string        `json:"errors"`
	Integrations  Integrations    `json:"integrations"`
}

type Router

type Router struct {
	*chi.Mux
	// contains filtered or unexported fields
}

Router implements the resources API. It implement a chi.Mux and contains the satellites and store client and the configured integration to serve our needs.