config

Documentation

Index

• Constants
• func CreateFromConfig(cf Config) ([]referrerstore.ReferrerStore, []verifier.ReferenceVerifier, ...)
• func GetDefaultPluginPath() string
• func GetDefaultPluginVersion() string
• func GetLoggerConfig(configFilePath string) (logger.Config, error)
• func InitDefaultPaths()
• type Config
  • func Load(configFilePath string) (Config, error)
• type GetExecutor
  • func GetExecutorAndWatchForUpdate(configFilePath string) (GetExecutor, error)

Constants

const (
	ConfigFileName = "config.json"
	ConfigFileDir  = ".ratify"
	PluginsFolder  = "plugins"
)

Functions

func CreateFromConfig

func CreateFromConfig(cf Config) ([]referrerstore.ReferrerStore, []verifier.ReferenceVerifier, policyprovider.PolicyProvider, error)

Returns created referer store, verifier, policyprovider objects from config

func GetDefaultPluginPath

func GetDefaultPluginPath() string

func GetDefaultPluginVersion

func GetDefaultPluginVersion() string

returns default plugin version of 1.0.0

func GetLoggerConfig

func GetLoggerConfig(configFilePath string) (logger.Config, error)

GetLoggerConfig returns logger configuration from config file at specified path.

func InitDefaultPaths

func InitDefaultPaths()

Types

type Config

type Config struct {
	StoresConfig    rsConfig.StoresConfig    `json:"store,omitempty"`
	PoliciesConfig  pcConfig.PoliciesConfig  `json:"policy,omitempty"`
	VerifiersConfig vfConfig.VerifiersConfig `json:"verifier,omitempty"`
	ExecutorConfig  exConfig.ExecutorConfig  `json:"executor,omitempty"`
	LoggerConfig    logger.Config            `json:"logger,omitempty"`
	// contains filtered or unexported fields
}

func Load

func Load(configFilePath string) (Config, error)

Load the config from file path provided, read from default path if configFilePath is empty

type GetExecutor

type GetExecutor func(context.Context) *ef.Executor

func GetExecutorAndWatchForUpdate

func GetExecutorAndWatchForUpdate(configFilePath string) (GetExecutor, error)

Create a executor from configurationFile and setup config file watcher