app

Documentation

Overview

Package app contains base application constants, flags and options.

Index

• Constants
• Variables
• type Info
• type Namespace
  • func ParseNamespace(s string) Namespace
  • func (n Namespace) String() string
  • func (n Namespace) ValuesName() string
• type Option
• type Options
  • func NewOptions(options ...Option) (*Options, error)
  • func (o *Options) AddRunOptions(options ...RunOption)
  • func (o *Options) ApplyRunOptions() error
• type RunOption

Constants

const (
	NamespaceEnv           = "namespace"
	LoggerLevelEnv         = "logger_level"
	LoggerCollectorAddrEnv = "logger_collector_addr"
	LoggerDisableStdoutEnv = "logger_disable_stdout"
	JaegerAddrEnv          = "jaeger_addr"
	HTTPPortEnv            = "service_port_http"
	GRPCPortEnv            = "service_port_grpc"
	AdminPortEnv           = "service_port_admin"
)

Application internal config keys.

const (
	DeploymentsDir  = ".deploy"
	ValuesDir       = "config"
	ValuesExt       = "yaml"
	ValuesBaseName  = "values"
	ValuesDevName   = "values_dev"
	ValuesLocalName = "values_local"
	ValuesStgName   = "values_stage"
	ValuesProdName  = "values_prod"
)

Default names for application files and directories.

Variables

var (
	InstanceUUID = uuid.New()
	StartTime    = time.Now()
	ServiceName  = "-"
	AppName      = "-"
	GitHash      = "-"
	Version      = "-"
	BuildAt      = "0001-01-01T00:00:00"
)

nolint:gochecknoglobals // build args

Types

type Info

type Info struct {
	InstanceUUID string
	ServiceName  string
	Namespace    string
	AppName      string
	GitHash      string
	Version      string
	BuildAt      string
	StartTime    time.Time
}

Info contains service information.

type Namespace

type Namespace string

Namespace type.

const (
	NamespaceDev   Namespace = "dev"
	NamespaceLocal Namespace = "local"
	NamespaceStage Namespace = "stage"
	NamespaceProd  Namespace = "prod"
)

Namespace values.

func ParseNamespace

func ParseNamespace(s string) Namespace

ParseNamespace return app Namespace.

func (Namespace) String

func (n Namespace) String() string

func (Namespace) ValuesName

func (n Namespace) ValuesName() string

ValuesName returns config values name for current namespace.

type Option

type Option func(opts *Options) error

Option sets tron options such as ports, config, etc.

type Options

type Options struct {
	// New options.
	Hostname       string
	PortAdmin      uint16
	PortHTTP       uint16
	PortGRPC       uint16
	RealtimeConfig bool
	LoggerOptions  []zap.Option
	ExitSignals    []os.Signal
	ConfigMap      map[string]interface{}
	GRPCListener   net.Listener
	HTTPListener   net.Listener

	// Run options.
	TLSConfig   *tls.Config
	GRPCOptions []grpc.ServerOption
	// contains filtered or unexported fields
}

Options is base tron options.

func NewOptions

func NewOptions(options ...Option) (*Options, error)

NewOptions returns Options with applied Option list.

func (*Options) AddRunOptions

func (o *Options) AddRunOptions(options ...RunOption)

AddRunOptions append run options to others options.

func (*Options) ApplyRunOptions

func (o *Options) ApplyRunOptions() error

ApplyRunOptions sets run options.

type RunOption

type RunOption func(opts *Options) error

RunOption sets tron run options such as grpc unary interceptors, tls config.