store

Documentation

Index

• Constants
• func ComputeDigest(bundle io.WriterTo) (digest.Digest, error)
• type ApplicationStore
  • func NewApplicationStore(configDir string) (*ApplicationStore, error)
  • func (a ApplicationStore) BundleStore() (BundleStore, error)
  • func (a ApplicationStore) CredentialStore(context string) (CredentialStore, error)
  • func (a ApplicationStore) InstallationStore(context string) (InstallationStore, error)
• type BundleStore
• type CredentialStore
• type ID
  • func FromString(s string) (ID, error)
  • func (id ID) String() string
• type Installation
  • func NewInstallation(name string, reference string) (*Installation, error)
  • func (i Installation) SetParameter(name string, value string)
• type InstallationStore

Constants

const (
	// AppConfigDirectory is the Docker App directory name inside Docker config directory
	AppConfigDirectory = "app"
	// BundleStoreDirectory is the bundle store directory name
	BundleStoreDirectory = "bundles"
	// CredentialStoreDirectory is the credential store directory name
	CredentialStoreDirectory = "credentials"
	// InstallationStoreDirectory is the installations store directory name
	InstallationStoreDirectory = "installations"
)

Functions

func ComputeDigest

func ComputeDigest(bundle io.WriterTo) (digest.Digest, error)

ComputeDigest takes a bundle and produce a unigue reference.Digested

Types

type ApplicationStore

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

ApplicationStore is the main point to access different stores: - Bundle store persists all bundles built or fetched locally - Credential store persists all the credentials, per context basis - Installation store persists all the installations, per context basis

func NewApplicationStore

func NewApplicationStore(configDir string) (*ApplicationStore, error)

NewApplicationStore creates a new application store, nested inside a docker configuration directory. It will create all the directory hierarchy if anything is missing.

func (ApplicationStore) BundleStore

func (a ApplicationStore) BundleStore() (BundleStore, error)

BundleStore initializes and returns a bundle store

func (ApplicationStore) CredentialStore

func (a ApplicationStore) CredentialStore(context string) (CredentialStore, error)

CredentialStore initializes and returns a context based credential store

func (ApplicationStore) InstallationStore

func (a ApplicationStore) InstallationStore(context string) (InstallationStore, error)

InstallationStore initializes and returns a context based installation store

type BundleStore

type BundleStore interface {
	Store(ref reference.Reference, bndle *bundle.Bundle) (reference.Reference, error)
	Read(ref reference.Reference) (*bundle.Bundle, error)
	List() ([]reference.Reference, error)
	Remove(ref reference.Reference) error
}

type CredentialStore

type CredentialStore interface {
	Store(creds *credentials.CredentialSet) error
	Read(credentialSetName string) (*credentials.CredentialSet, error)
}

CredentialStore persists credential sets to a specific path.

type ID

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

ID is an unique identifier for docker app image bundle, implementing reference.Reference

func FromString

func FromString(s string) (ID, error)

func (ID) String

func (id ID) String() string

type Installation

type Installation struct {
	claim.Claim
	Reference string `json:"reference,omitempty"`
}

Installation is a CNAB claim with an information of where the bundle comes from. It persists the result of an installation and its parameters and context.

func NewInstallation

func NewInstallation(name string, reference string) (*Installation, error)

func (Installation) SetParameter

func (i Installation) SetParameter(name string, value string)

SetParameters sets the parameter value if the installation bundle has a defined parameter with that name.

type InstallationStore

type InstallationStore interface {
	List() ([]string, error)
	Store(installation *Installation) error
	Read(installationName string) (*Installation, error)
	Delete(installationName string) error
}

InstallationStore is an interface to persist, delete, list and read installations.