config

Documentation

Overview

Package config exposes helpers for robot configuration

Index

• Constants
• func ValidateItemsConfig[C any](c C, repoMap map[string]any) error
• func ValidateRepoConfig[C any](c C) error
• func ValidateRequiredConfig[C any](c C) error
• type Configmap
• type ConfigmapAgent
  • func NewConfigmapAgent(c Configmap, path string) (a *ConfigmapAgent, err error)
  • func (a *ConfigmapAgent) GetConfigmap() Configmap
• type FrameworkOptions
  • func (o *FrameworkOptions) AddFlags(fs *flag.FlagSet)
  • func (o *FrameworkOptions) ValidateComposite(c Configmap, logger *logrus.Entry)
  • func (o *FrameworkOptions) ValidateConfigFile(c Configmap, logger *logrus.Entry)
  • func (o *FrameworkOptions) ValidateHmac(logger *logrus.Entry)
  • func (o *FrameworkOptions) ValidateTLS(logger *logrus.Entry)
  • func (o *FrameworkOptions) ValidateToken(logger *logrus.Entry)

Constants

const (
	YamlTagNameJson            = "json"
	YamlTagNameRequired        = "required"
	YamlFiledNameRepos         = "repos"
	YamlFiledNameExcludedRepos = "excluded_repos"
	YamlFiledNameConfigItems   = "config_items"
)

Functions

func ValidateItemsConfig

func ValidateItemsConfig[C any](c C, repoMap map[string]any) error

func ValidateRepoConfig

func ValidateRepoConfig[C any](c C) error

ValidateRepoConfig to check the repoConfig data's validation, returns an error if invalid

func ValidateRequiredConfig

func ValidateRequiredConfig[C any](c C) error

Types

type Configmap

type Configmap interface {
	Validate() error
}

type ConfigmapAgent

type ConfigmapAgent struct {
	// contains filtered or unexported fields
}

func NewConfigmapAgent

func NewConfigmapAgent(c Configmap, path string) (a *ConfigmapAgent, err error)

func (*ConfigmapAgent) GetConfigmap

func (a *ConfigmapAgent) GetConfigmap() Configmap

type FrameworkOptions

type FrameworkOptions struct {
	Address            string
	Port               int
	ConfigFile         string
	GracePeriod        time.Duration
	EnableTLS          bool
	HandlePath         string
	CertFile           string
	KeyFile            string
	DelHmacSecretFile  bool
	HmacSecretFilePath string
	DelTokenFile       bool
	TokenFilePath      string
	Interrupt          bool
	TokenValue         []byte
	HmacValue          []byte
	ConfigmapValue     Configmap
}

func (*FrameworkOptions) AddFlags

func (o *FrameworkOptions) AddFlags(fs *flag.FlagSet)

func (*FrameworkOptions) ValidateComposite

func (o *FrameworkOptions) ValidateComposite(c Configmap, logger *logrus.Entry)

func (*FrameworkOptions) ValidateConfigFile

func (o *FrameworkOptions) ValidateConfigFile(c Configmap, logger *logrus.Entry)

func (*FrameworkOptions) ValidateHmac

func (o *FrameworkOptions) ValidateHmac(logger *logrus.Entry)

func (*FrameworkOptions) ValidateTLS

func (o *FrameworkOptions) ValidateTLS(logger *logrus.Entry)

func (*FrameworkOptions) ValidateToken

func (o *FrameworkOptions) ValidateToken(logger *logrus.Entry)