secrets

package

v0.12.0 Latest Latest Go to latest Published: Jul 12, 2024 License: Apache-2.0 Imports: 21 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

This section is empty.

This section is empty.

This section is empty.

type ClientConfig struct {
	APIServer  config.URL `yaml:"api_server,omitempty"`
	KubeConfig string     `yaml:"kubeconfig_file,omitempty"`
}

ClientConfig configures access to the Kubernetes API server.

type KubernetesSecretConfig struct {
	Namespace string `yaml:"namespace"`
	Name      string `yaml:"name"`
	Key       string `yaml:"key"`
}

KubernetesSecretConfig is the configuration pointing to a specific Kubernetes Secret.

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

Manager manages the Kubernetes secret provider.

func NewManager(ctx context.Context, reg prometheus.Registerer, opts ProviderOptions) Manager

NewManager creates a new secret manager with the provided options.

func (m *Manager) ApplyConfig(providerConfig *WatchSPConfig, configs []SecretConfig) error

ApplyConfig applies the new secrets, diffing each one with the last configuration to apply the relevant update.

func (m *Manager) Close(reg prometheus.Registerer)

Close cancels the manager, stopping the Kubernetes secret provider.

func (m *Manager) Fetch(ctx context.Context, name string) (string, error)

Fetch implements github.com/prometheus/common/config.SecretManager.Fetch.

type ProviderOptions struct {
	Logger log.Logger
}

ProviderOptions provides options for a Provider.

type Secret interface {
	// Fetch fetches the secret content.
	Fetch(ctx context.Context) (string, error)
}

Secret represents a sensitive value.

type SecretConfig struct {
	Name   string                 `yaml:"name"`
	Config KubernetesSecretConfig `yaml:"config"`
}

SecretConfig maps a secret name references to a Kubernetes secret.

type SecretFn func(ctx context.Context) (string, error)

SecretFn wraps a function to make it a Secret.

func (fn *SecretFn) Fetch(ctx context.Context) (string, error)

Fetch implements Secret.Fetch.

type WatchSPConfig struct {
	ClientConfig
}

WatchSPConfig configures access to the Kubernetes API server. TODO(TheSpiritXIII): https://github.com/GoogleCloudPlatform/prometheus-engine/issues/867