config

Documentation

Overview

Package config provides configurations for subcommands.

It consists of both configuration values shared by all microservices and values specific to this microservice.

Default values can be obtained from various sources (constants, environment variables, etc.) and then overridden by flags.

As configuration is global you can get it only once for safety: you can call only one of Get… functions and call it just once.

Index

• func GetGoosePostgres() (c *cobrax.GoosePostgresConfig, err error)
• func Init(sharedCfg *SharedCfg, flagsets FlagSets) error
• type FlagSets
• type ServeConfig
  • func GetServe() (c *ServeConfig, err error)
  • func MustGetServeTest() *ServeConfig
• type SharedCfg

Functions

func GetGoosePostgres

func GetGoosePostgres() (c *cobrax.GoosePostgresConfig, err error)

func Init

func Init(sharedCfg *SharedCfg, flagsets FlagSets) error

Init updates config defaults (from env) and setup subcommands flags.

Init must be called once before using this package.

Types

type FlagSets

type FlagSets struct {
	Serve         *pflag.FlagSet
	GoosePostgres *pflag.FlagSet
}

FlagSets for all CLI subcommands which use flags to set config values.

type ServeConfig

type ServeConfig struct {
	Postgres         *def.PostgresConfig
	GoosePostgresDir string
	AuthAddr         netx.Addr
	BindAddr         netx.Addr
	BindAddrInt      netx.Addr
	BindGRPCGWAddr   netx.Addr
	BindMetricsAddr  netx.Addr
	Secret           sensitive.Bytes
	TLSCACert        string
	TLSCert          string
	TLSCertInt       string
	TLSKey           string
	TLSKeyInt        string
}

ServeConfig contains configuration for subcommand.

func GetServe

func GetServe() (c *ServeConfig, err error)

GetServe validates and returns configuration for subcommand.

func MustGetServeTest

func MustGetServeTest() *ServeConfig

MustGetServeTest returns config suitable for use in tests.

type SharedCfg

type SharedCfg = config.Shared