owl

README

+++ [runme] id = '01HRA297WC2HJP7X48FM3DR1V0' version = 'v3' +++

The Owl Store 🦉

...aka smart ENV store. A better solution to specify, validate, and resolve a user's or workload's environment. Because:

The owl 🦉 is wise and knows environment variables aren't just for workloads they are for humans, too.

Documentation

Index

• Constants
• Variables
• type Operation
• type OperationSet
  • func NewOperationSet(opts ...OperationSetOption) (*OperationSet, error)
• type OperationSetOption
  • func WithOperation(operation setOperationKind) OperationSetOption
  • func WithSpecs(included bool) OperationSetOption
• type Query
  • func NewQuery(name string, varDefs []*ast.VariableDefinition, reducers []QueryNodeReducer) (*Query, error)
  • func (q *Query) Print() (string, error)
• type QueryNodeReducer
• type SetVar
• type SetVarItem
• type SetVarItems
• type SetVarSpec
• type SetVarValue
• type Spec
• type SpecResolverMutator
• type Specs
  • func ParseRawSpec(values map[string]string, comments map[string]string) Specs
• type Store
  • func NewStore(opts ...StoreOption) (*Store, error)
  • func (s *Store) InsecureValues() ([]string, error)
  • func (s *Store) Snapshot() (SetVarItems, error)
  • func (s *Store) Update(newOrUpdated, deleted []string) error
• type StoreOption
  • func WithEnvFile(specFile string, raw []byte) StoreOption
  • func WithEnvs(source string, envs ...string) StoreOption
  • func WithLogger(logger *zap.Logger) StoreOption
  • func WithSpecFile(specFile string, raw []byte) StoreOption

Constants

const (
	SpecNameOpaque   string = "Opaque"   // SpecNameOpaque specifies an opaque specification.
	SpecNamePlain    string = "Plain"    // SpecNamePlain specifies a plain specification.
	SpecNameSecret   string = "Secret"   // SpecNameSecret specifies a secret specification.
	SpecNamePassword string = "Password" // SpecNamePassword specifies a password specification.
	SpecNameDefault         = SpecNameOpaque
)

Constants representing different specification names. These constants are of type SpecName and are assigned string values.

const (
	LoadSetOperation setOperationKind = iota
	UpdateSetOperation
	DeleteSetOperation
	ReconcileSetOperation
	TransientSetOperation
)

Variables

var (
	Schema                        graphql.Schema
	EnvironmentType, ValidateType *graphql.Object
	SpecTypes                     map[string]*specType
)

Types

type Operation

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

type OperationSet

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

func NewOperationSet

func NewOperationSet(opts ...OperationSetOption) (*OperationSet, error)

type OperationSetOption

type OperationSetOption func(*OperationSet) error

func WithOperation

func WithOperation(operation setOperationKind) OperationSetOption

func WithSpecs

func WithSpecs(included bool) OperationSetOption

type Query

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

func NewQuery

func NewQuery(name string, varDefs []*ast.VariableDefinition, reducers []QueryNodeReducer) (*Query, error)

func (*Query) Print

func (q *Query) Print() (string, error)

type QueryNodeReducer

type QueryNodeReducer func(*ast.OperationDefinition, *ast.SelectionSet) (*ast.SelectionSet, error)

type SetVar

type SetVar struct {
	Key       string           `json:"key"`
	Origin    string           `json:"origin,omitempty"`
	Operation *setVarOperation `json:"operation"`
	Created   *time.Time       `json:"created,omitempty"`
	Updated   *time.Time       `json:"updated,omitempty"`
}

type SetVarItem

type SetVarItem struct {
	Var   *SetVar   `json:"var,omitempty"`
	Value *varValue `json:"value,omitempty"`
	Spec  *varSpec  `json:"spec,omitempty"`
}

type SetVarItems

type SetVarItems []*SetVarItem

type SetVarSpec

type SetVarSpec struct {
	Var  *SetVar  `json:"var,omitempty"`
	Spec *varSpec `json:"spec,omitempty"`
}

type SetVarValue

type SetVarValue struct {
	Var   *SetVar   `json:"var,omitempty"`
	Value *varValue `json:"value,omitempty"`
}

type Spec

type Spec struct {
	Name     string
	Required bool // Indicates whether the configuration is required.
	Valid    bool // Indicates whether the configuration is valid.
}

Spec represents the available configuration options and their flags.

type SpecResolverMutator

type SpecResolverMutator func(val *SetVarValue, spec *SetVarSpec, insecure bool)

type Specs

type Specs map[string]Spec

Specs represents a collection of configuration specifications.

func ParseRawSpec

func ParseRawSpec(values map[string]string, comments map[string]string) Specs

GenerateSpecsFromComments maps comments to configuration key specifications.

type Store

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

func NewStore

func NewStore(opts ...StoreOption) (*Store, error)

func (*Store) InsecureValues

func (s *Store) InsecureValues() ([]string, error)

func (*Store) Snapshot

func (s *Store) Snapshot() (SetVarItems, error)

func (*Store) Update

func (s *Store) Update(newOrUpdated, deleted []string) error

type StoreOption

type StoreOption func(*Store) error

func WithEnvFile

func WithEnvFile(specFile string, raw []byte) StoreOption

func WithEnvs

func WithEnvs(source string, envs ...string) StoreOption

func WithLogger

func WithLogger(logger *zap.Logger) StoreOption

func WithSpecFile

func WithSpecFile(specFile string, raw []byte) StoreOption