cnabprovider

Documentation

Index

• Constants
• Variables
• type ActionArguments
• type Duffle
  • func NewDuffle(c *config.Config) *Duffle
  • func (d *Duffle) FetchClaim(name string) (*claim.Claim, error)
  • func (d *Duffle) Install(args ActionArguments) error
  • func (d *Duffle) Invoke(action string, args ActionArguments) error
  • func (d *Duffle) LoadBundle(bundleFile string, insecure bool) (*bundle.Bundle, error)
  • func (d *Duffle) NewClaimStore() (claim.Store, error)
  • func (d *Duffle) Uninstall(args ActionArguments) error
  • func (d *Duffle) Upgrade(args ActionArguments) error
  • func (d *Duffle) WriteClaimOutputs(c *claim.Claim, action string) error

Constants

const (
	// ClaimsDirectory represents the name of the directory where claims are stored
	ClaimsDirectory = "claims"
)

const (
	// CredentialsDirectory represents the name of the directory where credentials are stored
	CredentialsDirectory = "credentials"
)

Variables

var ErrNotSigned = errors.New("bundle is not signed")

TODO: Export everything in this file from duffle cmd/duffle/pull.go

Types

type ActionArguments

type ActionArguments struct {
	// Name of the claim.
	Claim string

	// Either a filepath to the bundle or the name of the bundle.
	BundleIdentifier string

	// BundleIdentifier is a filepath.
	BundleIsFile bool

	// Insecure bundle action allowed.
	Insecure bool

	// Params is the set of parameters to pass to the bundle.
	Params map[string]string

	// Either a filepath to a credential file or the name of a set of a credentials.
	CredentialIdentifiers []string

	// Driver is the CNAB-compliant driver used to run bundle actions.
	Driver string
}

Shared arguments for all CNAB actions supported by duffle

type Duffle

type Duffle struct {
	*config.Config
}

func NewDuffle

func NewDuffle(c *config.Config) *Duffle

func (*Duffle) FetchClaim

func (d *Duffle) FetchClaim(name string) (*claim.Claim, error)

FetchClaim fetches a claim from the given CNABProvider's claim store

func (*Duffle) Install

func (d *Duffle) Install(args ActionArguments) error

func (*Duffle) Invoke

func (d *Duffle) Invoke(action string, args ActionArguments) error

func (*Duffle) LoadBundle

func (d *Duffle) LoadBundle(bundleFile string, insecure bool) (*bundle.Bundle, error)

func (*Duffle) NewClaimStore

func (d *Duffle) NewClaimStore() (claim.Store, error)

func (*Duffle) Uninstall

func (d *Duffle) Uninstall(args ActionArguments) error

func (*Duffle) Upgrade

func (d *Duffle) Upgrade(args ActionArguments) error

func (*Duffle) WriteClaimOutputs

func (d *Duffle) WriteClaimOutputs(c *claim.Claim, action string) error

WriteClaimOutputs writes outputs to a claim, according to the provided bundle and Duffle config