configutil

Documentation

Index

• func CollectValidationErrorLogs(cfg *cortexops.CortexApplicationConfig, overriders ...CortexConfigOverrider) []*driverutil.ValidationError
• func CortexAPISpecToCortexConfig[T cortexspec](in T, overriders ...CortexConfigOverrider) (*cortex.Config, *cortex.RuntimeConfigValues, error)
• func CortexTargets() []string
• func LoadFromAPI[T any](dest T, src proto.Message) error
• func MarshalCortexConfig(config *cortex.Config) ([]byte, error)
• func MarshalRuntimeConfig(config *cortex.RuntimeConfigValues) ([]byte, error)
• func RunCustomValidationRules(cfg *cortexops.CapabilityBackendConfigSpec) []*driverutil.ValidationError
• func ValidateConfiguration(cfg *cortexops.CapabilityBackendConfigSpec, ...) []*driverutil.ValidationError
• type AlertmanagerOverrideShape
• type CortexConfigOverrider
  • func MergeOverrideLists(lists ...[]CortexConfigOverrider) []CortexConfigOverrider
  • func NewHostOverrides(impl StandardOverridesShape) []CortexConfigOverrider
  • func NewImplementationSpecificOverrides(impl ImplementationSpecificOverridesShape) []CortexConfigOverrider
  • func NewOverrider[T any](fn func(*T) bool) CortexConfigOverrider
  • func NewTargetsOverride(targets ...string) []CortexConfigOverrider
• type ImplementationSpecificOverridesShape
• type StandardOverridesShape
• type TLSClientConfigShape
• type TLSServerConfigShape

Functions

func CollectValidationErrorLogs

func CollectValidationErrorLogs(cfg *cortexops.CortexApplicationConfig, overriders ...CortexConfigOverrider) []*driverutil.ValidationError

func CortexAPISpecToCortexConfig

func CortexAPISpecToCortexConfig[T cortexspec](
	in T,
	overriders ...CortexConfigOverrider,
) (*cortex.Config, *cortex.RuntimeConfigValues, error)

func CortexTargets

func CortexTargets() []string

func LoadFromAPI

func LoadFromAPI[T any](dest T, src proto.Message) error

func MarshalCortexConfig

func MarshalCortexConfig(config *cortex.Config) ([]byte, error)

func MarshalRuntimeConfig

func MarshalRuntimeConfig(config *cortex.RuntimeConfigValues) ([]byte, error)

func RunCustomValidationRules

func RunCustomValidationRules(cfg *cortexops.CapabilityBackendConfigSpec) []*driverutil.ValidationError

func ValidateConfiguration

func ValidateConfiguration(cfg *cortexops.CapabilityBackendConfigSpec, overriders ...CortexConfigOverrider) []*driverutil.ValidationError

Types

type AlertmanagerOverrideShape

type AlertmanagerOverrideShape struct {
	AlertmanagerURL string
	EnableV2        bool
	ClientTLS       TLSClientConfigShape
}

type CortexConfigOverrider

type CortexConfigOverrider interface {
	// contains filtered or unexported methods
}

func MergeOverrideLists

func MergeOverrideLists(lists ...[]CortexConfigOverrider) []CortexConfigOverrider

func NewHostOverrides

func NewHostOverrides(impl StandardOverridesShape) []CortexConfigOverrider

These are overrides that configure host options such as networking and storage. Generally always required to have a working Cortex config.

func NewImplementationSpecificOverrides

func NewImplementationSpecificOverrides(impl ImplementationSpecificOverridesShape) []CortexConfigOverrider

These are overrides that are generally always required, but are specific to the runtime environment and are logically separate from the standard override set.

func NewOverrider

func NewOverrider[T any](fn func(*T) bool) CortexConfigOverrider

func NewTargetsOverride

func NewTargetsOverride(targets ...string) []CortexConfigOverrider

type ImplementationSpecificOverridesShape

type ImplementationSpecificOverridesShape = struct {
	QueryFrontendAddress string
	MemberlistJoinAddrs  []string
	AlertManager         AlertmanagerOverrideShape
}

type StandardOverridesShape

type StandardOverridesShape = struct {
	HttpListenAddress      string
	HttpListenPort         int
	HttpListenNetwork      string
	GrpcListenAddress      string
	GrpcListenPort         int
	GrpcListenNetwork      string
	StorageDir             string
	RuntimeConfig          string
	TLSServerConfig        TLSServerConfigShape
	TLSGatewayClientConfig TLSClientConfigShape
	TLSCortexClientConfig  TLSClientConfigShape
}

type TLSClientConfigShape

type TLSClientConfigShape = struct {
	CertPath           string
	KeyPath            string
	CAPath             string
	ServerName         string
	InsecureSkipVerify bool
}

type TLSServerConfigShape

type TLSServerConfigShape = struct {
	TLSCertPath string
	TLSKeyPath  string
	ClientAuth  string
	ClientCAs   string
}