env

Documentation

Index

• Constants
• func GetEnv(haystack []core.EnvVar, name string) (*core.EnvVar, bool)
• func MergeMaps(base map[string]string, update map[string]string)
• func ParseCombinedJavaOptionsMap(envCache EnvCache) (map[string]string, error)
• func ParseOperatorJavaOptionsMap(envCache EnvCache) (map[string]string, error)
• func ParseShellArgs(input string) (map[string]string, error)
• func RemoveEnv(haystack []core.EnvVar, name string) ([]core.EnvVar, bool)
• func SaveCombinedJavaOptionsMap(envCache EnvCache, javaOptions map[string]string)
• func SaveOperatorJavaOptionsMap(envCache EnvCache, javaOptions map[string]string)
• type EnvCache
  • func NewEnvCache(log *zap.Logger) EnvCache
• type EnvCacheEntry
• type EnvCacheEntryBuilder
  • func NewEnvCacheEntryBuilder(value *core.EnvVar) EnvCacheEntryBuilder
  • func NewSimpleEnvCacheEntryBuilder(name string, value string) EnvCacheEntryBuilder
• type Priority

Constants

const JAVA_OPTIONS = "JAVA_OPTS_APPEND"

const JAVA_OPTIONS_COMBINED = "__JAVA_OPTIONS_COMBINED__bedc397c-9486-4d87-8741-e4c90e72abe5__"

const JAVA_OPTIONS_LEGACY = "JAVA_OPTIONS"

const JAVA_OPTIONS_OPERATOR = "__JAVA_OPTIONS_OPERATOR__bedc397c-9486-4d87-8741-e4c90e72abe5__"

Functions

func GetEnv

func GetEnv(haystack []core.EnvVar, name string) (*core.EnvVar, bool)

func MergeMaps

func MergeMaps(base map[string]string, update map[string]string)

func ParseCombinedJavaOptionsMap

func ParseCombinedJavaOptionsMap(envCache EnvCache) (map[string]string, error)

func ParseOperatorJavaOptionsMap

func ParseOperatorJavaOptionsMap(envCache EnvCache) (map[string]string, error)

func ParseShellArgs

func ParseShellArgs(input string) (map[string]string, error)

func RemoveEnv

func RemoveEnv(haystack []core.EnvVar, name string) ([]core.EnvVar, bool)

func SaveCombinedJavaOptionsMap

func SaveCombinedJavaOptionsMap(envCache EnvCache, javaOptions map[string]string)

func SaveOperatorJavaOptionsMap

func SaveOperatorJavaOptionsMap(envCache EnvCache, javaOptions map[string]string)

Types

type EnvCache

type EnvCache interface {
	// Returns the value and a boolean representing if the value exists
	Get(key string) (EnvCacheEntry, bool)

	Set(value EnvCacheEntry)

	// Get the entries based on the declared dependencies,
	// entry that has a dependency goes after it
	// panics if there is a dependency chain longer than 20 items
	GetSorted() []core.EnvVar

	// Try to delete and return true if the key existed
	Delete(value EnvCacheEntry) bool

	DeleteByName(key string) bool

	// Return true if the enty with the given key was marked fo deletion in the
	// given period
	WasDeleted(key string) bool

	// Delete the entries marked for deletion,
	// and mark the cache as not-changed again.
	// Do not call this outside of env CF!
	ProcessAndAdvanceToNextPeriod()

	IsChanged() bool
}

func NewEnvCache

func NewEnvCache(log *zap.Logger) EnvCache

The cache tries to preserve the order of addition. When sorting, it only reorders so far that it satisfies dependency relation

type EnvCacheEntry

type EnvCacheEntry interface {
	GetName() string

	GetValue() *core.EnvVar

	GetDependencies() []string

	GetPriority() Priority
}

type EnvCacheEntryBuilder

type EnvCacheEntryBuilder interface {
	SetDependency(name string) EnvCacheEntryBuilder

	SetPriority(priority Priority) EnvCacheEntryBuilder

	Build() EnvCacheEntry
}

func NewEnvCacheEntryBuilder

func NewEnvCacheEntryBuilder(value *core.EnvVar) EnvCacheEntryBuilder

Makes a deep copy of the inner value

func NewSimpleEnvCacheEntryBuilder

func NewSimpleEnvCacheEntryBuilder(name string, value string) EnvCacheEntryBuilder

type Priority

type Priority int

const (
	// TODO DEPRECATION:
	// - Remove support for variables from Deployment
	// - Make sure unused env. variables are deleted (see cf_kafkasql_security_scram)
	// - Operator-set variables are now lowest precedence
	PRIORITY_MIN        Priority = 0
	PRIORITY_DEPLOYMENT Priority = 1 // TODO Deprecated
	PRIORITY_SPEC       Priority = 2
	PRIORITY_OPERATOR   Priority = 3
	PRIORITY_MAX        Priority = 4
)