assets

Documentation

Overview

Package assets contains helper types used for loading in static assets when configuring the Grafana Agent.

Index

• type Key
  • func KeyForConfigMap(namespace string, sel *v1.ConfigMapKeySelector) Key
  • func KeyForSecret(namespace string, sel *v1.SecretKeySelector) Key
  • func KeyForSelector(namespace string, sel *prom_v1.SecretOrConfigMap) Key
• type SecretStore

Types

type Key

type Key string

Key is a path-like identifier representing a Secret or ConfigMap value. It is used for looking up values during config generation that cannot be loaded directly from a file (e.g., BasicAuth Username).

The naming convention is either:

/secrets/<namespace>/<name>/<key>

or:

/configMaps/<namespace>/<name>/<key>

Resources associated with a key should be watched for changes and trigger a reconcile when modified.

func KeyForConfigMap

func KeyForConfigMap(namespace string, sel *v1.ConfigMapKeySelector) Key

KeyForConfigMap returns the key for a given namespace and a config map key selector.

func KeyForSecret

func KeyForSecret(namespace string, sel *v1.SecretKeySelector) Key

KeyForSecret returns the key for a given namespace and a secret key selector.

func KeyForSelector

func KeyForSelector(namespace string, sel *prom_v1.SecretOrConfigMap) Key

KeyForSelector retrieves the key for a SecretOrConfigMap.

type SecretStore

type SecretStore map[Key]string

SecretStore is an in-memory cache for secrets, intended to be used for static secrets in generated configuration files.