config

Documentation

Index

• Constants
• Variables
• func Finalize(pArgs *ProgArgs) error
• func FixExtraConfigPath(configRoot string) string
• func FromEnv(pArgs *ProgArgs)
• func FromFiles(pArgs *ProgArgs, configRoot, extraConfigPath string) error
• func FromFlags(pArgs *ProgArgs, args ...string) (string, string, error)
• func HostNameFromEnv() string
• func IsConfigRootAllowed(cfgPath string, addDirFns ...func() (string, error)) (string, error)
• func ReadConfiglet(configPath string) ([]byte, error)
• func ReadConfigletDir(configPath string) ([]fs.DirEntry, error)
• func SetDefaults(pArgs *ProgArgs)
• func TopologyManagerPolicyFromEnv() string
• func TopologyManagerScopeFromEnv() string
• func UserHomeDir() (string, error)
• func UserRunDir() (string, error)
• func Validate(pArgs *ProgArgs) error
• type GlobalArgs
  • func (args GlobalArgs) Clone() GlobalArgs
• type ProgArgs
  • func LoadArgs(args ...string) (ProgArgs, error)
  • func (pa ProgArgs) Clone() ProgArgs
  • func (pa *ProgArgs) ToJSONString() string
  • func (pa *ProgArgs) ToYAMLString() string

Constants

const (
	DefaultconfigRoot     = "/etc/rte"
	LegacyExtraConfigPath = "/etc/resource-topology-exporter/config.yaml"
)

const (
	DefaultConfigRoot = "/etc/rte"
)

Variables

var (
	SkipDirectory = errors.New("skip config directory")
)

Functions

func Finalize

func Finalize(pArgs *ProgArgs) error

func FixExtraConfigPath

func FixExtraConfigPath(configRoot string) string

func FromEnv

func FromEnv(pArgs *ProgArgs)

func FromFiles

func FromFiles(pArgs *ProgArgs, configRoot, extraConfigPath string) error

func FromFlags

func FromFlags(pArgs *ProgArgs, args ...string) (string, string, error)

func HostNameFromEnv

func HostNameFromEnv() string

func IsConfigRootAllowed

func IsConfigRootAllowed(cfgPath string, addDirFns ...func() (string, error)) (string, error)

IsConfigRootAllowed checks if an *already cleaned and canonicalized* path is among the allowed list. use `addDirFns` to inject user-dependent paths (e.g. $HOME). Returns the matched pattern, if any, and error describing the failure. The error is only relevant if failed to inject user-provided paths.

func ReadConfiglet

func ReadConfiglet(configPath string) ([]byte, error)

func ReadConfigletDir

func ReadConfigletDir(configPath string) ([]fs.DirEntry, error)

func SetDefaults

func SetDefaults(pArgs *ProgArgs)

func TopologyManagerPolicyFromEnv

func TopologyManagerPolicyFromEnv() string

func TopologyManagerScopeFromEnv

func TopologyManagerScopeFromEnv() string

func UserHomeDir

func UserHomeDir() (string, error)

func UserRunDir

func UserRunDir() (string, error)

func Validate

func Validate(pArgs *ProgArgs) error

Types

type GlobalArgs

type GlobalArgs struct {
	KubeConfig string `json:"kubeConfig,omitempty"`
	Debug      bool   `json:"debug,omitempty"`
	Verbose    int    `json:"verbose"`
}

func (GlobalArgs) Clone

func (args GlobalArgs) Clone() GlobalArgs

type ProgArgs

type ProgArgs struct {
	Global          GlobalArgs                    `json:"global,omitempty"`
	NRTupdater      nrtupdater.Args               `json:"nrtUpdater,omitempty"`
	Resourcemonitor resourcemonitor.Args          `json:"resourceMonitor,omitempty"`
	RTE             resourcetopologyexporter.Args `json:"topologyExporter,omitempty"`
	Version         bool                          `json:"-"`
	DumpConfig      string                        `json:"-"`
}

func LoadArgs

func LoadArgs(args ...string) (ProgArgs, error)

The args is passed only for testing purposes.

func (ProgArgs) Clone

func (pa ProgArgs) Clone() ProgArgs

func (*ProgArgs) ToJSONString

func (pa *ProgArgs) ToJSONString() string

func (*ProgArgs) ToYAMLString

func (pa *ProgArgs) ToYAMLString() string