env

Documentation

Index

• Constants
• func GetOptionalConfigBool(logger *zap.Logger, envKey string, defaultValue string, name string) (bool, error)
• func GetOptionalConfigInt64(logger *zap.Logger, envKey string, defaultValue string, name string) (int64, error)
• func GetOptionalConfigValue(logger *zap.Logger, key string, defaultValue string) string
• func GetRequiredConfigBool(logger *zap.Logger, envKey string, name string) (bool, bool, error)
• func GetRequiredConfigInt(logger *zap.Logger, envKey string, name string) (int, error)
• func GetRequiredConfigInt16(logger *zap.Logger, envKey string, name string) (int16, error)
• func GetRequiredConfigInt32(logger *zap.Logger, envKey string, name string) (int32, error)
• func GetRequiredConfigInt64(logger *zap.Logger, envKey string, name string) (int64, error)
• func GetRequiredConfigValue(logger *zap.Logger, key string) (string, error)
• func GetRequiredQuantityConfigValue(logger *zap.Logger, envVarKey string) (*resource.Quantity, error)

Constants

const (

	// Eventing-Kafka Configuration
	ServiceAccountEnvVarKey = "SERVICE_ACCOUNT"
	MetricsPortEnvVarKey    = "METRICS_PORT"
	MetricsDomainEnvVarKey  = "METRICS_DOMAIN"
	HealthPortEnvVarKey     = "HEALTH_PORT"
	PodNameEnvVarKey        = "POD_NAME"
	ContainerNameEnvVarKEy  = "CONTAINER_NAME"

	// Kafka Authorization
	KafkaBrokerEnvVarKey   = "KAFKA_BROKERS"
	KafkaUsernameEnvVarKey = "KAFKA_USERNAME"
	KafkaPasswordEnvVarKey = "KAFKA_PASSWORD"

	// Kafka Configuration
	KafkaTopicEnvVarKey = "KAFKA_TOPIC"

	// Knative Logging Configuration
	KnativeLoggingConfigMapNameEnvVarKey = "CONFIG_LOGGING_NAME" // Note - Matches value of configMapNameEnv constant in Knative.dev/pkg/logging !

	// Dispatcher Configuration
	ChannelKeyEnvVarKey  = "CHANNEL_KEY"
	ServiceNameEnvVarKey = "SERVICE_NAME"
)

Package Constants

Functions

func GetOptionalConfigBool

func GetOptionalConfigBool(logger *zap.Logger, envKey string, defaultValue string, name string) (bool, error)

Get The Specified Optional Config Value From OS & Log Errors If Not Present Or Not Boolean

func GetOptionalConfigInt64

func GetOptionalConfigInt64(logger *zap.Logger, envKey string, defaultValue string, name string) (int64, error)

Get The Specified Optional Config Value From OS & Log Errors If Not Present Or Not An Int64

func GetOptionalConfigValue

func GetOptionalConfigValue(logger *zap.Logger, key string, defaultValue string) string

Get The Specified Optional Config Value From OS

func GetRequiredConfigBool

func GetRequiredConfigBool(logger *zap.Logger, envKey string, name string) (bool, bool, error)

Get The Specified Required Config Value From OS & Log Errors If Not Present Or Not Boolean

func GetRequiredConfigInt

func GetRequiredConfigInt(logger *zap.Logger, envKey string, name string) (int, error)

Get The Specified Required Config Value From OS & Log Errors If Not Present Or Not An Int

func GetRequiredConfigInt16

func GetRequiredConfigInt16(logger *zap.Logger, envKey string, name string) (int16, error)

Get The Specified Required Config Value From OS & Log Errors If Not Present Or Not An Int16

func GetRequiredConfigInt32

func GetRequiredConfigInt32(logger *zap.Logger, envKey string, name string) (int32, error)

Get The Specified Required Config Value From OS & Log Errors If Not Present Or Not An Int32

func GetRequiredConfigInt64

func GetRequiredConfigInt64(logger *zap.Logger, envKey string, name string) (int64, error)

Get The Specified Required Config Value From OS & Log Errors If Not Present Or Not An Int64

func GetRequiredConfigValue

func GetRequiredConfigValue(logger *zap.Logger, key string) (string, error)

Get The Specified Required Config Value From OS & Log Errors If Not Present

func GetRequiredQuantityConfigValue

func GetRequiredQuantityConfigValue(logger *zap.Logger, envVarKey string) (*resource.Quantity, error)

Parse Quantity Value