config

package

v0.8.0 Latest Latest Go to latest Published: Oct 20, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitea.com/withlin/pipeline

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ToContext(ctx context.Context, c *Config) context.Context
type Config
- func FromContext(ctx context.Context) *Config
- func FromContextOrDefaults(ctx context.Context) *Config
type Defaults
- func NewDefaultsFromConfigMap(config *corev1.ConfigMap) (*Defaults, error)
- func NewDefaultsFromMap(cfgMap map[string]string) (*Defaults, error)
type Store
- func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value interface{})) *Store
- func (s *Store) Load() *Config
- func (s *Store) ToContext(ctx context.Context) context.Context

Constants ¶

View Source

const (
	// ConfigName is the name of the configmap
	DefaultsConfigName    = "config-defaults"
	DefaultTimeoutMinutes = 60
	NoTimeoutDuration     = 0 * time.Minute
)

Variables ¶

This section is empty.

Functions ¶

func ToContext ¶

func ToContext(ctx context.Context, c *Config) context.Context

ToContext attaches the provided Config to the provided context, returning the new context with the Config attached.

Types ¶

type Config ¶

type Config struct {
	Defaults *Defaults
}

Config holds the collection of configurations that we attach to contexts. +k8s:deepcopy-gen=false

func FromContext ¶

func FromContext(ctx context.Context) *Config

FromContext extracts a Config from the provided context.

func FromContextOrDefaults ¶

func FromContextOrDefaults(ctx context.Context) *Config

FromContextOrDefaults is like FromContext, but when no Config is attached it returns a Config populated with the defaults for each of the Config fields.

type Defaults ¶

type Defaults struct {
	DefaultTimeoutMinutes int
	DefaultServiceAccount string
}

Defaults holds the default configurations +k8s:deepcopy-gen=true

func NewDefaultsFromConfigMap ¶

func NewDefaultsFromConfigMap(config *corev1.ConfigMap) (*Defaults, error)

NewDefaultsFromConfigMap returns a Config for the given configmap

func NewDefaultsFromMap ¶

func NewDefaultsFromMap(cfgMap map[string]string) (*Defaults, error)

NewDefaultsFromMap returns a Config given a map corresponding to a ConfigMap

func (*Defaults) DeepCopy ¶

func (in *Defaults) DeepCopy() *Defaults

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Defaults.

func (*Defaults) DeepCopyInto ¶

func (in *Defaults) DeepCopyInto(out *Defaults)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Defaults) Equals ¶

func (cfg *Defaults) Equals(other *Defaults) bool

Equals returns true if two Configs are identical

type Store ¶

type Store struct {
	*configmap.UntypedStore
}

Store is a typed wrapper around configmap.Untyped store to handle our configmaps. +k8s:deepcopy-gen=false

func NewStore ¶

func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value interface{})) *Store

NewStore creates a new store of Configs and optionally calls functions when ConfigMaps are updated.

func (*Store) Load ¶

func (s *Store) Load() *Config

Load creates a Config from the current config state of the Store.

func (*Store) ToContext ¶

func (s *Store) ToContext(ctx context.Context) context.Context

ToContext attaches the current Config state to the provided context.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL