config

Documentation

Overview

Package config manages the configuration of IAM platform.

Index

• Constants
• Variables
• type Config
  • func NewConfig(cfgPath, appName string) (*Config, error)
• type GRPCOptions
  • func DefaultGRPCOptions() *GRPCOptions
• type HTTPOptions
  • func DefaultHTTPOptions() *HTTPOptions
• type JWTOptions
  • func DefaultJWTOptions() *JWTOptions
• type MysqlOptions
  • func DefaultMysqlOptions() *MysqlOptions
• type RedisOptions
  • func DefaultRedisOptions() *RedisOptions

Constants

const (
	DefaultGRPCAddr       = "0.0.0.0:8001"
	DefaultGRPCMaxMsgSize = 4 * 1024 * 1024
)

const (
	DefaultHTTPMode        = "release"
	DefaultHTTPAddr        = "0.0.0.0:8000"
	DefaultHTTPPingTimeout = time.Duration(10 * time.Second)
	DefaultHealthz         = true
	DefaultMetrics         = false
	DefaultProfiling       = false
)

const (
	DefaultJWTTimeout    = time.Duration(24 * time.Second)
	DefaultJWTMaxRefresh = time.Duration(24 * time.Second)
)

const (
	DefaultMysqlAddr            = "127.0.0.1:3306"
	DefaultMysqlMaxIdleConns    = 100
	DefaultMysqlMaxOpenConns    = 100
	DefaultMysqlMaxConnLifeTime = time.Duration(10 * time.Second)
)

Variables

var (
	EnvPrefix          = "IAM"
	DefaultConfigPaths = []string{".", "./configs", "/etc/iam"}
)

Types

type Config

type Config struct {
	HTTPOpts  *HTTPOptions  `mapstructure:"http"`
	GRPCOpts  *GRPCOptions  `mapstructure:"grpc"`
	JWTOpts   *JWTOptions   `mapstructure:"jwt"`
	MysqlOpts *MysqlOptions `mapstructure:"mysql"`
	RedisOpts *RedisOptions `mapstructure:"redis"`
	// contains filtered or unexported fields
}

Config defines the structure of the iam configuration.

func NewConfig

func NewConfig(cfgPath, appName string) (*Config, error)

NewConfig builds a config from cfgPath or from <DefaultConfigPaths>/<appName>.yaml.

type GRPCOptions

type GRPCOptions struct {
	Addr       string
	MaxMsgSize int `mapstructure:"max-msg-size"`
}

GRPCOptions defines options for building a GRPCServer.

func DefaultGRPCOptions

func DefaultGRPCOptions() *GRPCOptions

DefaultGRPCOptions news an GRPCOptions.

type HTTPOptions

type HTTPOptions struct {
	Mode        string
	Addr        string
	Middlewares []string
	PingTimeout time.Duration `mapstructure:"ping-timeout"`
	Healthz     bool
	Metrics     bool
	Profiling   bool
}

HTTPOptions defines options for building an HTTPServer.

func DefaultHTTPOptions

func DefaultHTTPOptions() *HTTPOptions

DefaultHTTPOptions news an HTTPOptions.

type JWTOptions

type JWTOptions struct {
	Key        string
	Timeout    time.Duration
	MaxRefresh time.Duration `mapstructure:"max-refresh"`
}

JWTOptions defines options for building a GinJWTMiddleware.

func DefaultJWTOptions

func DefaultJWTOptions() *JWTOptions

DefaultJWTOptions news a JWTOptions.

type MysqlOptions

type MysqlOptions struct {
	Addr            string
	Username        string
	Password        string
	Database        string
	MaxIdleConns    int           `mapstructure:"max-idle-conns"`
	MaxOpenConns    int           `mapstructure:"max-open-conns"`
	MaxConnLifeTime time.Duration `mapstructure:"max-connection-life-time"`
}

MysqlOptions defines options for building a mysql instance.

func DefaultMysqlOptions

func DefaultMysqlOptions() *MysqlOptions

DefaultMysqlOptions news an MySQLOptions.

type RedisOptions

type RedisOptions struct {
	Addrs    []string
	Password string
	Database int
}

RedisOptions defines options for building a redis client.

func DefaultRedisOptions

func DefaultRedisOptions() *RedisOptions

DefaultRedisOptions news a RedisOptions.