env

package

v0.0.0-...-536019a Latest Latest Go to latest Published: Oct 9, 2018 License: MIT 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

View Source

const (
	// DefaultFormat output envar like <NAME> = <VALUE>
	DefaultFormat = "kv"
)

View Source

var (
	// AwsselDefaultEnvvarsLimit is the max number of values
	// that it is retrieved from the SSM store
	AwsselDefaultEnvvarsLimit int = 100
)

This section is empty.

type Formatter interface {
	Format(ev Var) string
}

Formatter is used to format an env var

func BashExportFormatter() Formatter

BashExportFormatter return an instance of the bashExportFormatter This exporter prefix the output with the bash 'export' statement

func DefaultFormatter() Formatter

DefaultFormatter creates a new Defaultformatter

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

SSMStore is an implementation of a store. It is used to query SSM Parameter store

func NewSSMStore(o ...SSMStoreOptions) *SSMStore

NewSSMStore returns a client to query AWS SSM Parameter Store It use a SSMStoreOptions as a parameter to pass info needed by the store

func (s *SSMStore) QueryVarsForService(name string, opts ...StoreQueryOptions) ([]*Var, error)

QueryVarsForService is used to query SSM Parameter Store It returns all env vars related to a given service. or and error if something went wrong

See env.StoreQueryOption for more information about available options

type SSMStoreOptions struct {
	Region string

	Endpoint string
	// contains filtered or unexported fields
}

SSMStoreOptions gather information need to create a session with the AWS SSM service

type StoreQueryOptions struct {
	FilterPattern string
	PrefixPath    string
}

StoreQueryOptions contains additonnal options needed to query a store

type Storer interface {
	QueryVarsForService(serviceName string, opts ...StoreQueryOptions) ([]*Var, error)
}

Storer is the API that any Store implementation must satisfy

type Var struct {
	Name  string
	Value string
}

Var represent a value object for an Env Variable

func VarFromSSMParameter(p *ssm.Parameter) *Var

VarFromSSMParameter create a new env var object from an SSM Paramater Struct

func (v *Var) Export(f Formatter) string

Export return a string representation of an env var according to the given formatter spec

func (v *Var) String() string

String return the string representation of an evn var