secrets

package

v1.13.0 Latest Latest Go to latest Published: Oct 22, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/xraph/forge

Links

Open Source Insights

Documentation ¶

Overview ¶

Package secrets reports whether named secrets resolve. Only apply reads values.

Index ¶

func EnvVarName(project, name string) string
func Generate(d *model.Deployment, st *state.Store, external map[string]string) (map[string]string, error)
func Save(st *state.Store, values map[string]string) error
type Deferred
- func (r Deferred) Check(ctx context.Context, name string) (Status, error)
type EnvResolver
type FileResolver
type HostedResolver
type KubernetesResolver
type Resolver
- func New(cfg spec.Secrets, projectRoot string, runner execx.Runner, target spec.Target, ...) (Resolver, error)
type Status
- func Reference(ctx context.Context, cfg spec.Secrets, root string, base Resolver, name string, ...) (Status, string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func EnvVarName ¶

func EnvVarName(project, name string) string

EnvVarName is UPPER(project)_UPPER(name) with hyphens as underscores.

func Generate ¶

func Generate(d *model.Deployment, st *state.Store, external map[string]string) (map[string]string, error)

func Save ¶

func Save(st *state.Store, values map[string]string) error

Types ¶

type Deferred ¶

type Deferred struct{ Resolver }

Deferred preserves references without performing remote I/O during inspection.

func (Deferred) Check ¶

func (r Deferred) Check(ctx context.Context, name string) (Status, error)

type EnvResolver ¶

type EnvResolver struct{ Project string }

func (*EnvResolver) Check ¶

func (r *EnvResolver) Check(ctx context.Context, name string) (Status, error)

func (*EnvResolver) EnvVar ¶

func (r *EnvResolver) EnvVar(name string) string

func (*EnvResolver) Name ¶

func (r *EnvResolver) Name() string

func (*EnvResolver) ValuesForApply ¶

func (r *EnvResolver) ValuesForApply(_ context.Context) (map[string]string, error)

type FileResolver ¶

type FileResolver struct {
	Root    string
	Project string
	Path    string
	Rel     string
}

func (*FileResolver) Check ¶

func (r *FileResolver) Check(ctx context.Context, name string) (Status, error)

func (*FileResolver) EnvVar ¶

func (r *FileResolver) EnvVar(name string) string

func (*FileResolver) Name ¶

func (r *FileResolver) Name() string

func (*FileResolver) ValuesForApply ¶

func (r *FileResolver) ValuesForApply(_ context.Context) (map[string]string, error)

type HostedResolver ¶

type HostedResolver struct {
	Project string
	Keys    map[string]string
}

HostedResolver reports explicit vault mappings without reading laptop credentials.

func (*HostedResolver) Check ¶

func (r *HostedResolver) Check(ctx context.Context, name string) (Status, error)

func (*HostedResolver) EnvVar ¶

func (r *HostedResolver) EnvVar(name string) string

func (*HostedResolver) Name ¶

func (r *HostedResolver) Name() string

type KubernetesResolver ¶

type KubernetesResolver struct {
	Project     string
	Environment string
	Runner      execx.Runner
	Context     string
	Namespace   string
}

func (*KubernetesResolver) Check ¶

func (r *KubernetesResolver) Check(ctx context.Context, name string) (Status, error)

func (*KubernetesResolver) EnvVar ¶

func (r *KubernetesResolver) EnvVar(name string) string

func (*KubernetesResolver) Name ¶

func (r *KubernetesResolver) Name() string

func (*KubernetesResolver) ValuesForApply ¶

func (r *KubernetesResolver) ValuesForApply(ctx context.Context) (map[string]string, error)

type Resolver ¶

type Resolver interface {
	Name() string
	Check(ctx context.Context, name string) (Status, error)
	EnvVar(name string) string
}

func New ¶

func New(cfg spec.Secrets, projectRoot string, runner execx.Runner, target spec.Target, project string) (Resolver, error)

type Status ¶

type Status struct {
	Unverified bool
	Resolved   bool
	Where      string
}

func Reference ¶

func Reference(ctx context.Context, cfg spec.Secrets, root string, base Resolver, name string, apply bool) (Status, string, error)

Reference resolves an explicitly named credential without serializing its value. Inspection returns resolution metadata; only apply asks for the value.

Source Files ¶

View all Source files

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