gateway

Documentation

Index

• Variables
• func MustReadOrValidateConfig(f *Flags) *gatewayv1.Config
• func Run(f *Flags, cf *ComponentFactory, assets http.FileSystem)
• func RunWithConfig(f *Flags, cfg *gatewayv1.Config, cf *ComponentFactory, assets http.FileSystem)
• type ComponentFactory
• type Flags
  • func ParseFlags() *Flags
  • func (f *Flags) Link()

Variables

var CoreComponentFactory = &ComponentFactory{
	Services:   Services,
	Middleware: Middleware,
	Modules:    Modules,
}

var Middleware = middleware.Factory{
	stats.Name:    stats.New,
	authn.Name:    authn.New,
	validate.Name: validate.New,
}

var Modules = module.Factory{
	assetsmod.Name:      assetsmod.New,
	authnmod.Name:       authnmod.New,
	healthcheckmod.Name: healthcheckmod.New,
	appmod.Name:         appmod.New,
}

TODO: Modules is a terrible name

var Services = service.Factory{
	authnservice.Name:        authnservice.New,
	authnservice.StorageName: authnservice.NewStorage,
	awsservice.Name:          awsservice.New,
	pgservice.Name:           pgservice.New,
	appservice.Name:          appservice.New,
	temporalservice.Name:     temporalservice.New,
}

Functions

func MustReadOrValidateConfig

func MustReadOrValidateConfig(f *Flags) *gatewayv1.Config

func Run

func Run(f *Flags, cf *ComponentFactory, assets http.FileSystem)

func RunWithConfig

func RunWithConfig(f *Flags, cfg *gatewayv1.Config, cf *ComponentFactory, assets http.FileSystem)

Types

type ComponentFactory

type ComponentFactory struct {
	Services   service.Factory
	Middleware middleware.Factory
	Modules    module.Factory
}

All available components supply their factory here. Whether or not they are used at runtime is dependent on the configuration passed to the Gateway.

type Flags

type Flags struct {
	ConfigPath string
	Template   bool
	Validate   bool
	Debug      bool
	EnvFiles   envFiles
}

func ParseFlags

func ParseFlags() *Flags

Parse command line arguments.

func (*Flags) Link

func (f *Flags) Link()

Link register the struct vars globally for parsing by the flag library.