config

Documentation

Overview

Package config stores all server application settings for benchmark job

Package config stores all server application settings

Index

• Constants
• Variables
• type Data
  • func NewConfig(ctx context.Context, path string) (cfg *Data, err error)
• type GlobalConfig

Constants

const (
	JOBNAME_ANNOTATION      = "before-job-name"
	JOBNAMESPACE_ANNOTATION = "before-job-namespace"
	SERVICE_NAME            = "vald-benchmark-job"
)

Variables

var (
	NAMESPACE = os.Getenv("CRD_NAMESPACE")
	NAME      = os.Getenv("CRD_NAME")
)

NAMESPACE and NAME are resolved once from the pod's environment at package init time; they identify the benchmark job's own ValdBenchmarkJob CR so NewConfig can load its override settings.

Types

type Data

type Data struct {
	// K8sClient represent k8s client configuration
	K8sClient client.Client `json:"k8s_client" yaml:"k8s_client"`

	// Server represent all server configurations
	Server *config.Servers `json:"server_config" yaml:"server_config"` //nolint:tagliatelle // fixed by the existing config.yaml wire format, not renameable

	// Observability represent observability configurations
	Observability *config.Observability `json:"observability" yaml:"observability"`

	// Job represent benchmark job configuration
	Job *config.BenchmarkJob `json:"job" yaml:"job"`

	// GlobalConfig represent the global configuration
	config.GlobalConfig `json:",inline" yaml:",inline"`
}

Data represents an application setting data content (config.yaml). In K8s environment, this configuration is stored in K8s ConfigMap.

func NewConfig

func NewConfig(ctx context.Context, path string) (cfg *Data, err error)

NewConfig represents the set config from the given setting file path.

type GlobalConfig

type GlobalConfig = config.GlobalConfig

GlobalConfig is type alias for config.GlobalConfig.