secretsyml

README

github.com/conjurinc/summon/secretsyml

Defines the secret.yml format and provides function to parse it into a map.

Documentation

Overview

Package secretsyml provides functions for parsing a string or file in secrets.yml format.

Index

• type SecretSpec
  • func (s *SecretSpec) IsFile() bool
  • func (s *SecretSpec) IsLiteral() bool
  • func (s *SecretSpec) IsVar() bool
  • func (spec *SecretSpec) SetYAML(tag string, value interface{}) bool
• type SecretsMap
  • func ParseFromFile(filepath string, subs map[string]string) (SecretsMap, error)
  • func ParseFromString(content string, subs map[string]string) (SecretsMap, error)
• type YamlTag
  • func (t YamlTag) String() string

Types

type SecretSpec

type SecretSpec struct {
	Tags []YamlTag
	Path string
}

func (*SecretSpec) IsFile

func (s *SecretSpec) IsFile() bool

func (*SecretSpec) IsLiteral

func (s *SecretSpec) IsLiteral() bool

func (*SecretSpec) IsVar

func (s *SecretSpec) IsVar() bool

func (*SecretSpec) SetYAML

func (spec *SecretSpec) SetYAML(tag string, value interface{}) bool

type SecretsMap

type SecretsMap map[string]SecretSpec

func ParseFromFile

func ParseFromFile(filepath string, subs map[string]string) (SecretsMap, error)

ParseFromFile parses a file in secrets.yml format to a map.

func ParseFromString

func ParseFromString(content string, subs map[string]string) (SecretsMap, error)

ParseFromString parses a string in secrets.yml format to a map.

type YamlTag

type YamlTag uint8

const (
	File YamlTag = iota
	Var
	Literal
)

func (YamlTag) String

func (t YamlTag) String() string