conf

Documentation

Overview

Package conf provides primitives for pulling configuration data for individual modules in the controller - modules should use this package to retrieve module-specific configuration

Index

• func Flush()
• func ReadConf() []byte
• type BaseConfig
• type GlobalConf
  • func GetGlobalConf() *GlobalConf

Functions

func Flush

func Flush()

Flush will reinitialise/forget any config data already read.

func ReadConf

func ReadConf() []byte

ReadConf provides the raw data from the config file. The config file's location can be set via an environment variable `TYK_MSERV_CONFIG`, and if not specified defaults to `/etc/tyk-mserv/config.json`. A module can use this function to then parse the raw config data into it's own module-specific config type.

Types

type BaseConfig

type BaseConfig struct{}

type GlobalConf

type GlobalConf struct{}

GlobalConf is the config that the main application provides, each module actually gets it's own config objects that are locally defined.

func GetGlobalConf

func GetGlobalConf() *GlobalConf

GetGlobalConf provides the global config object that can be accessed from all modules where necessary.