config

Documentation

Index

• Constants
• type AdminConfig
• type AuthConfig
  • func (c AuthConfig) ClientCredentials() management.Option
  • func (c AuthConfig) IssuerURL() (u *url.URL, err error)
  • func (c AuthConfig) Validate() error
• type Config
  • func New() (conf Config, err error)
  • func (c Config) GetLogLevel() zerolog.Level
  • func (c Config) IsZero() bool
  • func (c Config) Mark() (Config, error)
  • func (c Config) Validate() (err error)
• type DatabaseConfig
  • func (c DatabaseConfig) Validate() error
• type DirectoryConfig
• type MTLSConfig
  • func (c MTLSConfig) DialOption(endpoint string) (opt grpc.DialOption, err error)
  • func (c MTLSConfig) Validate() error
• type MembersConfig
  • func (c MembersConfig) Validate() error
• type NetworkConfig
  • func (c NetworkConfig) Validate() error

Constants

const (
	TestNet = "testnet"
	MainNet = "mainnet"
)

Types

type AdminConfig

type AdminConfig struct {
	Endpoint string `split_words:"true" required:"true"`
	// Audience and TokenKeys should match the Admin server configuration, since the
	// BFF uses these parameters to sign its own JWT tokens.
	Audience  string            `split_words:"true"`
	TokenKeys map[string]string `split_words:"true" required:"true"`
}

AdminConfig is a configuration for connecting to an Admin service.

type AuthConfig

type AuthConfig struct {
	Domain        string        `split_words:"true" required:"true"`
	Issuer        string        `split_words:"true" required:"false"` // Set to the custom domain if enabled in Auth0 (ensure trailing slash is set if required!)
	Audience      string        `split_words:"true" required:"true"`
	ProviderCache time.Duration `split_words:"true" default:"5m"`
	ClientID      string        `split_words:"true"`
	ClientSecret  string        `split_words:"true"`
	Testing       bool          `split_words:"true" default:"false"` // If true a mock authenticator is used for testing
}

AuthConfig handles Auth0 configuration and authentication

func (AuthConfig) ClientCredentials

func (c AuthConfig) ClientCredentials() management.Option

func (AuthConfig) IssuerURL

func (c AuthConfig) IssuerURL() (u *url.URL, err error)

func (AuthConfig) Validate

func (c AuthConfig) Validate() error

type Config

type Config struct {
	Maintenance  bool                `split_words:"true" default:"false"`
	BindAddr     string              `split_words:"true" default:":4437"`
	Mode         string              `split_words:"true" default:"release"`
	LogLevel     logger.LevelDecoder `split_words:"true" default:"info"`
	ConsoleLog   bool                `split_words:"true" default:"false"`
	AllowOrigins []string            `split_words:"true" default:"http://localhost,http://localhost:3000,http://localhost:3003"`
	CookieDomain string              `split_words:"true"`
	Auth0        AuthConfig
	TestNet      NetworkConfig
	MainNet      NetworkConfig
	Database     DatabaseConfig
	Sentry       sentry.Config
	// contains filtered or unexported fields
}

Config uses envconfig to load the required settings from the environment, parse and validate them in preparation for running the GDS BFF API service.

func New

func New() (conf Config, err error)

New creates a new Config object from environment variables prefixed with GDS_BFF.

func (Config) GetLogLevel

func (c Config) GetLogLevel() zerolog.Level

func (Config) IsZero

func (c Config) IsZero() bool

func (Config) Mark

func (c Config) Mark() (Config, error)

Mark a manually constructed as processed as long as it is validated.

func (Config) Validate

func (c Config) Validate() (err error)

Validate the config to make sure that it is usable to run the GDS BFF server.

type DatabaseConfig

type DatabaseConfig struct {
	URL           string `split_words:"true" required:"true"`
	ReindexOnBoot bool   `split_words:"true" default:"false"`
	MTLS          MTLSConfig
}

func (DatabaseConfig) Validate

func (c DatabaseConfig) Validate() error

type DirectoryConfig

type DirectoryConfig struct {
	Insecure bool          `split_words:"true" default:"true"`
	Endpoint string        `split_words:"true" required:"true"`
	Timeout  time.Duration `split_words:"true" default:"10s"`
}

DirectoryConfig is a generic configuration for connecting to a GDS service.

type MTLSConfig

type MTLSConfig struct {
	Insecure bool   `split_words:"true"`
	CertPath string `split_words:"true"`
	PoolPath string `split_words:"true"`
}

func (MTLSConfig) DialOption

func (c MTLSConfig) DialOption(endpoint string) (opt grpc.DialOption, err error)

DialOption returns a configured dial option which can be directly used in a grpc.Dial or grpc.DialContext call to connect using mTLS.

func (MTLSConfig) Validate

func (c MTLSConfig) Validate() error

type MembersConfig

type MembersConfig struct {
	Endpoint string        `split_words:"true" required:"true"`
	Timeout  time.Duration `split_words:"true" default:"10s"`
	MTLS     MTLSConfig
}

MembersConfig is a configuration for connecting to a members service.

func (MembersConfig) Validate

func (c MembersConfig) Validate() error

type NetworkConfig

type NetworkConfig struct {
	Admin     AdminConfig
	Directory DirectoryConfig
	Members   MembersConfig
}

NetworkConfig contains sub configurations for connecting to specific GDS and members services.

func (NetworkConfig) Validate

func (c NetworkConfig) Validate() error