app

Documentation

Index

• func Initialize()
• func IsDevEnvironment() bool
• func IsShuttingDown() bool
• func KubernetesNamespace() (string, bool)
• func ModusHomeDir() string
• func ProductVersion() string
• func SetConfig(c *AppConfig)
• func SetOutputColorMode()
• func SetShuttingDown()
• func VersionNumber() string
• type AppConfig
  • func Config() *AppConfig
  • func CreateAppConfig() *AppConfig
  • func NewAppConfig() *AppConfig
  • func (c *AppConfig) AppPath() string
  • func (c *AppConfig) Environment() string
  • func (c *AppConfig) IsDevEnvironment() bool
  • func (c *AppConfig) KubernetesSecretName() string
  • func (c *AppConfig) Port() int
  • func (c *AppConfig) RefreshInterval() time.Duration
  • func (c *AppConfig) S3Bucket() string
  • func (c *AppConfig) S3Path() string
  • func (c *AppConfig) UseAwsStorage() bool
  • func (c *AppConfig) UseJsonLogging() bool
  • func (c *AppConfig) UseKubernetesSecret() bool
  • func (c *AppConfig) WithAppPath(appPath string) *AppConfig
  • func (c *AppConfig) WithEnvironment(environment string) *AppConfig
  • func (c *AppConfig) WithJsonLogging() *AppConfig
  • func (c *AppConfig) WithPort(port int) *AppConfig
  • func (c *AppConfig) WithRefreshInterval(interval time.Duration) *AppConfig
  • func (c *AppConfig) WithS3Storage(s3Bucket, s3Path string) *AppConfig

Functions

func Initialize

func Initialize()

func IsDevEnvironment

func IsDevEnvironment() bool

IsDevEnvironment returns true if the application is running in a development environment.

func IsShuttingDown

func IsShuttingDown() bool

IsShuttingDown returns true if the application is in the process of a graceful shutdown.

func KubernetesNamespace

func KubernetesNamespace() (string, bool)

func ModusHomeDir

func ModusHomeDir() string

func ProductVersion

func ProductVersion() string

func SetConfig

func SetConfig(c *AppConfig)

SetConfig sets the global app configuration. This is typically only called in tests.

func SetOutputColorMode

func SetOutputColorMode()

SetOutputColorMode applies the FORCE_COLOR environment variable to override the default color mode.

func SetShuttingDown

func SetShuttingDown()

SetShuttingDown sets the application to a shutting down state during a graceful shutdown.

func VersionNumber

func VersionNumber() string

Types

type AppConfig

type AppConfig struct {
	// contains filtered or unexported fields
}

func Config

func Config() *AppConfig

Config returns the global app configuration.

func CreateAppConfig

func CreateAppConfig() *AppConfig

Creates the app configuration from the command line flags and environment variables.

func NewAppConfig

func NewAppConfig() *AppConfig

Creates a new AppConfig instance with default values.

func (*AppConfig) AppPath

func (c *AppConfig) AppPath() string

func (*AppConfig) Environment

func (c *AppConfig) Environment() string

func (*AppConfig) IsDevEnvironment

func (c *AppConfig) IsDevEnvironment() bool

func (*AppConfig) KubernetesSecretName

func (c *AppConfig) KubernetesSecretName() string

func (*AppConfig) Port

func (c *AppConfig) Port() int

func (*AppConfig) RefreshInterval

func (c *AppConfig) RefreshInterval() time.Duration

func (*AppConfig) S3Bucket

func (c *AppConfig) S3Bucket() string

func (*AppConfig) S3Path

func (c *AppConfig) S3Path() string

func (*AppConfig) UseAwsStorage

func (c *AppConfig) UseAwsStorage() bool

func (*AppConfig) UseJsonLogging

func (c *AppConfig) UseJsonLogging() bool

func (*AppConfig) UseKubernetesSecret

func (c *AppConfig) UseKubernetesSecret() bool

func (*AppConfig) WithAppPath

func (c *AppConfig) WithAppPath(appPath string) *AppConfig

func (*AppConfig) WithEnvironment

func (c *AppConfig) WithEnvironment(environment string) *AppConfig

func (*AppConfig) WithJsonLogging

func (c *AppConfig) WithJsonLogging() *AppConfig

func (*AppConfig) WithPort

func (c *AppConfig) WithPort(port int) *AppConfig

func (*AppConfig) WithRefreshInterval

func (c *AppConfig) WithRefreshInterval(interval time.Duration) *AppConfig

func (*AppConfig) WithS3Storage

func (c *AppConfig) WithS3Storage(s3Bucket, s3Path string) *AppConfig