cnabprovider

Documentation

Index

• Constants
• Variables
• type ActionArguments
• type Runtime
  • func NewRuntime(c *config.Config) *Runtime
  • func (d *Runtime) AddFiles(args ActionArguments) action.OperationConfigFunc
  • func (d *Runtime) ApplyConfig(args ActionArguments) action.OperationConfigs
  • func (d *Runtime) FetchClaim(name string) (*claim.Claim, error)
  • func (d *Runtime) Install(args ActionArguments) error
  • func (d *Runtime) Invoke(action string, args ActionArguments) error
  • func (d *Runtime) LoadBundle(bundleFile string, insecure bool) (*bundle.Bundle, error)
  • func (d *Runtime) NewClaimStore() (claim.Store, error)
  • func (d *Runtime) SetOutput() action.OperationConfigFunc
  • func (d *Runtime) Uninstall(args ActionArguments) error
  • func (d *Runtime) Upgrade(args ActionArguments) 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")

Types

type ActionArguments

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

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

	// Additional files to copy into the bundle
	// Target Path => File Contents
	Files map[string]string

	// 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

type Runtime

type Runtime struct {
	*config.Config
}

func NewRuntime

func NewRuntime(c *config.Config) *Runtime

func (*Runtime) AddFiles

func (d *Runtime) AddFiles(args ActionArguments) action.OperationConfigFunc

func (*Runtime) ApplyConfig

func (d *Runtime) ApplyConfig(args ActionArguments) action.OperationConfigs

func (*Runtime) FetchClaim

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

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

func (*Runtime) Install

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

func (*Runtime) Invoke

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

func (*Runtime) LoadBundle

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

func (*Runtime) NewClaimStore

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

func (*Runtime) SetOutput

func (d *Runtime) SetOutput() action.OperationConfigFunc

func (*Runtime) Uninstall

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

func (*Runtime) Upgrade

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