env

Documentation

Index

• func ParseJavaOptionsMap(envCache EnvCache) map[string]string
• func SaveJavaOptionsMap(envCache EnvCache, options map[string]string, lock bool)
• 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

Functions

func ParseJavaOptionsMap

func ParseJavaOptionsMap(envCache EnvCache) map[string]string

func SaveJavaOptionsMap

func SaveJavaOptionsMap(envCache EnvCache, options map[string]string, lock bool)

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

	IsLocked() bool
}

type EnvCacheEntryBuilder

type EnvCacheEntryBuilder interface {
	SetDependency(name string) EnvCacheEntryBuilder

	SetPriority(priority Priority) EnvCacheEntryBuilder

	Lock() 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_DEPLOYMENT Priority = 0 // TODO Deprecated
	PRIORITY_SPEC       Priority = 1
	PRIORITY_OPERATOR   Priority = 2
	PRIORITY_MAX        Priority = PRIORITY_OPERATOR
)