backends

package
v0.7.0-1a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package backends holds the fixed set of state backends and encrypters a factory can use. An operator selects one by bare name in a config's state: block (@backend, @key-source), and the resolver looks the name up here.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Backends

func Backends() map[string]sdkstate.BackendType

Backends returns the state backends keyed by the bare name an operator selects with @backend. Names are unique by construction: this is one map literal, so a duplicate is a compile error.

func Encrypters

func Encrypters() map[string]sdkencrypt.EncrypterType

Encrypters returns the state encrypters keyed by the bare name an operator selects with @key-source.

Types

type EnvKeyConfig

type EnvKeyConfig struct {
	EnvVar cfg.String
}

EnvKeyConfig is the operator-facing body under `encryption: { @key-source: env-key ... }`.

type LocalBackendConfig

type LocalBackendConfig struct {
	Path cfg.String
}

LocalBackendConfig is the operator-facing body under `state: { @backend: local ... }`.

type S3BackendConfig added in v0.7.0

type S3BackendConfig struct {
	Bucket       cfg.String
	Prefix       *cfg.String
	KMSKeyID     *cfg.String
	UsePathStyle *cfg.Boolean
	AWS          *awscfg.Configuration
}

S3BackendConfig is the operator-facing body under `state: { @backend: s3 ... }`. The aws object holds the shared AWS connection settings from pkg/awscfg; bucket, prefix, kms-key-id, and use-path-style are the backend's own.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL