secrets

Documentation

Overview

Package secrets defines provider-neutral secret naming and management.

Index

• Variables
• func Name(cluster, namespace, pod, key string) (string, error)
• func Prefix(cluster, namespace, pod string) (string, error)
• type Manager
• type Provider
  • func ParseProvider(value string) (Provider, error)

Variables

var ErrUnsupported = errors.New("secret operation unsupported")

ErrUnsupported identifies an operation unavailable from a provider.

Functions

func Name

func Name(cluster, namespace, pod, key string) (string, error)

Name validates a scope and key and returns its provider name.

func Prefix

func Prefix(cluster, namespace, pod string) (string, error)

Prefix validates a scope and returns its leading-slash provider name prefix.

Types

type Manager

type Manager interface {
	Create(context.Context, string, []byte) error
	Update(context.Context, string, []byte) error
	List(context.Context, string) ([]string, error)
	Archive(context.Context, string) error
	Restore(context.Context, string) error
	Destroy(context.Context, string) error
}

Manager manages scoped secret values.

type Provider

type Provider string

Provider identifies a secret storage provider.

const (
	// AWSParameterStore identifies AWS Systems Manager Parameter Store.
	AWSParameterStore Provider = "aws-parameter-store"
	// AWSSecretsManager identifies AWS Secrets Manager.
	AWSSecretsManager Provider = "aws-secrets-manager"
)

func ParseProvider

func ParseProvider(value string) (Provider, error)

ParseProvider validates and returns a provider.