agent

Documentation

Index

• Variables
• type Agent
  • func New(opts ...Option) (Agent, error)
• type Option
  • func WithBasePath(path string) Option
  • func WithClientConfig(namespace string, name string) Option
  • func WithKubeConfig(masterURL string, kubeConfigPath string) Option
  • func WithLogger(logger logr.Logger) Option
  • func WithRestConfig(config *rest.Config) Option
  • func WithTokenPath(path string) Option
  • func WithVaultToken(token string) Option
• type Secret
• type StatusType
• type SyncStatus

Variables

var (
	// ErrNotYetSynced is returned when the config hasn't been synced yet.
	ErrNotYetSynced = erx.New("Heist Agent", "Config is not synced yet").
					WithDetails("config has not been synced to the agent yet, this may take up to a couple of seconds")
	// ErrAPIRequestFailed is returned when vault returned an unexpected response.
	ErrAPIRequestFailed = erx.New("Heist Agent", "REST requests to Vault could not be completed")
	// ErrNotFound is returned when a secret doesn't exist.
	ErrNotFound = erx.New("Heist Agent", "not found")
)

var ErrInitAgentFailed = erx.New("Heist Agent", "failed to initialize new agent")

ErrInitAgentFailed is returned when the agent can't be initialized.

Types

type Agent

type Agent interface {
	ListSecrets() (names []string, err error)
	FetchSecret(name string) (secret *Secret, err error)
	GetClientSecret() *Secret
	GetStatus() *SyncStatus
	Stop()
	CreateUpdateChannel(chan bool)
}

func New

func New(opts ...Option) (Agent, error)

type Option

type Option func(a *agent) error

func WithBasePath

func WithBasePath(path string) Option

func WithClientConfig

func WithClientConfig(namespace string, name string) Option

func WithKubeConfig

func WithKubeConfig(masterURL string, kubeConfigPath string) Option

func WithLogger

func WithLogger(logger logr.Logger) Option

func WithRestConfig

func WithRestConfig(config *rest.Config) Option

func WithTokenPath

func WithTokenPath(path string) Option

func WithVaultToken

func WithVaultToken(token string) Option

type Secret

type Secret struct {
	Value      string
	Name       string
	OutputPath string
	Mode       os.FileMode
}

type StatusType

type StatusType string

const (
	// StatusNotYetSynced indicates that the agent hasn't yet fetched it's config.
	StatusNotYetSynced StatusType = "not_yet_synced"
	// StatusSynced indicates that the agent has successfully fetched the config
	// and all configured secrets.
	StatusSynced StatusType = "synced"
	// StatusStopped indicates that the agent has been stopped and will no longer sync secrets.
	StatusStopped StatusType = "stopped"
	// StatusError indicates that an error has occurred.
	StatusError StatusType = "error"
)

type SyncStatus

type SyncStatus struct {
	Status StatusType
	Reason string
}