apis

Documentation

Index

• Constants
• type CertsLoader
• type EvaluateOpts
• type InterpolateOpts
• type MultiVars
  • func NewMultiVars(varss []Variables) MultiVars
  • func (m MultiVars) Get(varDef VariableDefinition) (interface{}, bool, error)
  • func (m MultiVars) List() ([]VariableDefinition, error)
• type OpsFileArg
  • func (a *OpsFileArg) UnmarshalFlag(filePath string) error
• type OpsFlags
  • func (f OpsFlags) AsOp() patch.Op
• type Patching
  • func NewPatching(stateStore storage.Store, fs fileio.Fs) Patching
  • func (p Patching) ProvisionManifest() (*artifacts.Manifest, error)
• type RSAKey
• type RSAKeyGenerator
  • func NewRSAKeyGenerator() RSAKeyGenerator
  • func (g RSAKeyGenerator) Generate(parameters interface{}) (interface{}, error)
• type SSHKey
• type SSHKeyGenerator
  • func NewSSHKeyGenerator() SSHKeyGenerator
  • func (g SSHKeyGenerator) Generate(parameters interface{}) (interface{}, error)
• type StaticVariables
  • func (v StaticVariables) Get(varDef VariableDefinition) (interface{}, bool, error)
  • func (v StaticVariables) List() ([]VariableDefinition, error)
• type Template
  • func NewTemplate(bytes []byte) Template
  • func (t Template) Evaluate(vars Variables, op patch.Op, opts EvaluateOpts) ([]byte, error)
• type ValueGenerator
  • func NewPasswordGenerator() ValueGenerator
• type ValueGeneratorConcrete
  • func NewValueGeneratorConcrete(loader CertsLoader) ValueGeneratorConcrete
  • func (vgc ValueGeneratorConcrete) GetGenerator(valueType string) (ValueGenerator, error)
• type ValueGeneratorFactory
• type VarFlags
  • func (f VarFlags) AsVariables() Variables
• type VariableDefinition
• type Variables
• type VarsCertLoader
  • func NewVarsCertLoader(vars Variables) VarsCertLoader
  • func (l VarsCertLoader) LoadCerts(name string) (*x509.Certificate, *rsa.PrivateKey, error)
• type VarsFSStore
  • func NewVarsFSStore(fs fileio.Fs) VarsFSStore
  • func (s VarsFSStore) Get(varDef VariableDefinition) (interface{}, bool, error)
  • func (s VarsFSStore) IsSet() bool
  • func (s VarsFSStore) List() ([]VariableDefinition, error)
  • func (s *VarsFSStore) UnmarshalFlag(data string) error
• type VarsFileArg
  • func (a *VarsFileArg) UnmarshalFlag(filePath string) error

Constants

const DefaultPasswordLength = 20

Types

type CertsLoader

type CertsLoader interface {
	LoadCerts(string) (*x509.Certificate, *rsa.PrivateKey, error)
}

type EvaluateOpts

type EvaluateOpts struct {
	ExpectAllKeys     bool
	ExpectAllVarsUsed bool
}

type InterpolateOpts

type InterpolateOpts struct {
	VarFlags
	OpsFlags
}

type MultiVars

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

func NewMultiVars

func NewMultiVars(varss []Variables) MultiVars

func (MultiVars) Get

func (m MultiVars) Get(varDef VariableDefinition) (interface{}, bool, error)

func (MultiVars) List

func (m MultiVars) List() ([]VariableDefinition, error)

type OpsFileArg

type OpsFileArg struct {
	Ops patch.Ops
	// contains filtered or unexported fields
}

func (*OpsFileArg) UnmarshalFlag

func (a *OpsFileArg) UnmarshalFlag(filePath string) error

type OpsFlags

type OpsFlags struct {
	OpsFiles []OpsFileArg `long:"ops-file" short:"o" value-name:"PATH" description:"Load manifest operations from a YAML file"`
}

Shared

func (OpsFlags) AsOp

func (f OpsFlags) AsOp() patch.Op

type Patching

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

func NewPatching

func NewPatching(
	stateStore storage.Store,
	fs fileio.Fs,
) Patching

func (Patching) ProvisionManifest

func (p Patching) ProvisionManifest() (*artifacts.Manifest, error)

type RSAKey

type RSAKey struct {
	PrivateKey string `json:"private_key" yaml:"private_key"`
	PublicKey  string `json:"public_key" yaml:"public_key"`
}

type RSAKeyGenerator

type RSAKeyGenerator struct{}

func NewRSAKeyGenerator

func NewRSAKeyGenerator() RSAKeyGenerator

func (RSAKeyGenerator) Generate

func (g RSAKeyGenerator) Generate(parameters interface{}) (interface{}, error)

type SSHKey

type SSHKey struct {
	PrivateKey           string `json:"private_key" yaml:"private_key"`
	PublicKey            string `json:"public_key" yaml:"public_key"`
	PublicKeyFingerprint string `json:"public_key_fingerprint" yaml:"public_key_fingerprint"`
}

type SSHKeyGenerator

type SSHKeyGenerator struct{}

func NewSSHKeyGenerator

func NewSSHKeyGenerator() SSHKeyGenerator

func (SSHKeyGenerator) Generate

func (g SSHKeyGenerator) Generate(parameters interface{}) (interface{}, error)

type StaticVariables

type StaticVariables map[string]interface{}

func (StaticVariables) Get

func (v StaticVariables) Get(varDef VariableDefinition) (interface{}, bool, error)

func (StaticVariables) List

func (v StaticVariables) List() ([]VariableDefinition, error)

type Template

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

func NewTemplate

func NewTemplate(bytes []byte) Template

func (Template) Evaluate

func (t Template) Evaluate(vars Variables, op patch.Op, opts EvaluateOpts) ([]byte, error)

type ValueGenerator

type ValueGenerator interface {
	Generate(interface{}) (interface{}, error)
}

func NewPasswordGenerator

func NewPasswordGenerator() ValueGenerator

type ValueGeneratorConcrete

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

func NewValueGeneratorConcrete

func NewValueGeneratorConcrete(loader CertsLoader) ValueGeneratorConcrete

func (ValueGeneratorConcrete) GetGenerator

func (vgc ValueGeneratorConcrete) GetGenerator(valueType string) (ValueGenerator, error)

type ValueGeneratorFactory

type ValueGeneratorFactory interface {
	GetGenerator(valueType string) (ValueGenerator, error)
}

type VarFlags

type VarFlags struct {
	VarsFiles   []VarsFileArg `long:"vars-file"  short:"l" value-name:"PATH"      description:"Load variables from a YAML file"`
	VarsFSStore VarsFSStore   `long:"vars-store"           value-name:"PATH"      description:"Load/save variables from/to a YAML file"`
}

func (VarFlags) AsVariables

func (f VarFlags) AsVariables() Variables

type VariableDefinition

type VariableDefinition struct {
	Name    string
	Type    string
	Options interface{}
}

type Variables

type Variables interface {
	Get(VariableDefinition) (interface{}, bool, error)
	List() ([]VariableDefinition, error)
}

type VarsCertLoader

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

func NewVarsCertLoader

func NewVarsCertLoader(vars Variables) VarsCertLoader

func (VarsCertLoader) LoadCerts

func (l VarsCertLoader) LoadCerts(name string) (*x509.Certificate, *rsa.PrivateKey, error)

type VarsFSStore

type VarsFSStore struct {
	ValueGeneratorFactory ValueGeneratorFactory
	// contains filtered or unexported fields
}

func NewVarsFSStore

func NewVarsFSStore(fs fileio.Fs) VarsFSStore

func (VarsFSStore) Get

func (s VarsFSStore) Get(varDef VariableDefinition) (interface{}, bool, error)

func (VarsFSStore) IsSet

func (s VarsFSStore) IsSet() bool

func (VarsFSStore) List

func (s VarsFSStore) List() ([]VariableDefinition, error)

func (*VarsFSStore) UnmarshalFlag

func (s *VarsFSStore) UnmarshalFlag(data string) error

type VarsFileArg

type VarsFileArg struct {
	Vars StaticVariables
	// contains filtered or unexported fields
}

func (*VarsFileArg) UnmarshalFlag

func (a *VarsFileArg) UnmarshalFlag(filePath string) error