model

Documentation

Index

• type Config
• type CraneConfig
• type DevLakeConfig
• type HttpServerConfig
• type Image
• type ImageMetric
• type OutputWithError
• type PrometheusAuth
• type PrometheusConfig
• type RegistryAuth

Types

type Config

type Config struct {
	Prometheus PrometheusConfig `mapstructure:"prometheus"`
	Crane      CraneConfig      `mapstructure:"crane"`
	HttpServer HttpServerConfig `mapstructure:"httpServer"`
	CARootPEM  string           `mapstructure:"ca_root_pem"`
	CAFile     string           `mapstructure:"ca_root_file"`
	DevLake    DevLakeConfig    `mapstructure:"devlake"`
}

type CraneConfig

type CraneConfig struct {
	Images_whitelist []string       `mapstructure:"images_whitelist"`
	Registries       []RegistryAuth `mapstructure:"registries"`
}

type DevLakeConfig

type DevLakeConfig struct {
	URL      string `mapstructure:"url"`
	Token    string `mapstructure:"token"`
	Projects []struct {
		ConnectionID int      `mapstructure:"connection_id"`
		Images       []string `mapstructure:"images"`
	} `mapstructure:"projects"`
}

type HttpServerConfig

type HttpServerConfig struct {
	Port string `mapstructure:"port"`
}

HttpServerConfig holds configuration for the HTTP server (e.g., for health probes)

type Image

type Image struct {
	Image_spec string
	Labels     map[string]string
}

An image as returned by Crane - Labels are different then the ones in Prometheus

type ImageMetric

type ImageMetric struct {
	Image_spec string
	Labels     map[string]string
}

A metric as returned by Prometheus, Labels are namespace, cluster and so on.

type OutputWithError

type OutputWithError struct {
	Result any
	Err    error
}

type PrometheusAuth

type PrometheusAuth struct {
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
	Token    string `mapstructure:"token"`
}

type PrometheusConfig

type PrometheusConfig struct {
	URL      string         `mapstructure:"url"`
	Interval string         `mapstructure:"interval"`
	Query    string         `mapstructure:"query"` // Query to fetch image metrics, default:, "kube_pod_container_info"
	Auth     PrometheusAuth `mapstructure:"auth"`  // Deprecated, use crane.registries instead
}

type RegistryAuth

type RegistryAuth struct {
	Registry string `mapstructure:"registry"`
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
}