data

Documentation

Index

• type Env
  • func (e *Env) Getenv() (err error)
• type SecretAttribute

Types

type Env

type Env struct {
	Provider                    string   // [Required] Cloud providers eg: aws, azure, gcp
	VaultName                   string   // [Required] Vault from which secrets will be pulled
	ConsumerType                string   // [Optional] Consumer Name eg: kubernetes
	DeploymentList              []string // [Optional] Comma separated list of deployments which need to be restarted on secret update.
	StatefulsetList             []string // [Optional] Comma separated list of statefulsets which need to be restarted on secret update.
	SecretName                  string   // [Optional] Name of the secret to be created/updated. Defaults to vaultName value.
	Namespace                   string   // [Optional] Kubernetes namespace where the secret is created/updated.
	RefreshRate                 int      // [Optional] Rate at which check for updated secret should be done. Defaults to 60.
	ConvertHyphensToUnderscores bool     // [Optional] Converts secret keys with - to _. Eg: MY-KEY ==> MY_KEY . Defaults to false.
}

Env: This struct is instantiated by environment variables.

func (*Env) Getenv

func (e *Env) Getenv() (err error)

Getenv is wrapper function which instantiates Env struct from Environment Variables. Some sane defaults are set here.

type SecretAttribute

type SecretAttribute struct {
	DateUpdated       time.Time // Last time the secret was updated.
	Value             string    // The value of the secret key
	MarkedForDeletion bool      // Identifier which tells consumer if to discard the secret.
}

SecretAttribute is constructed after querying Vault for each secret. This is core object which is passed from providers to consumers.