config

Documentation

Index

• Constants
• type Config
  • func Instance() *Config
  • func New() *Config
  • func (c *Config) Load(requestedPath string) error
  • func (c *Config) Save(requestedPath string) error
• type KeeperConfig
• type SecretRef

Constants

const SecretRefKey = "__SECRET__"

SecretRefKey is the key used to store the secret reference in the keeper config.

Types

type Config

type Config struct {
	MasterKeeper string                  `yaml:"master"`
	Keepers      map[string]KeeperConfig `yaml:"keepers"`
}

Config is the top-level configuration for ghost. When .ghost.yaml is loaded, this is the structure it must match.

func Instance

func Instance() *Config

Instance returns the singleton instance of the configuration.

func New

func New() *Config

New creates a new, empty configuration.

func (*Config) Load

func (c *Config) Load(requestedPath string) error

Load loads the configuration from the given path. If the path is empty, the default path is used.

func (*Config) Save

func (c *Config) Save(requestedPath string) error

Save saves the configuration to the given path. If the path is empty, the default path is used.

type KeeperConfig

type KeeperConfig map[string]any

KeeperConfig is an unstructured map of configuration values for a keeper.

type SecretRef

type SecretRef struct {
	KeeperName string `mapstructure:"keeper"`
	SecretName string `mapstructure:"secret"`
	Field      string `mapstructure:"field"`
}

SecretRef is a reference to a secret in another keeper.