cas

Documentation

Overview

Package cas implements a content-addressable-store on disk. It leverages the `diskv` package to store items in a simple key-value blob store: https://github.com/peterbourgon/diskv

Index

• func WriteACIInfo(tx *sql.Tx, aciinfo *ACIInfo) error
• func WriteRemote(tx *sql.Tx, remote *Remote) error
• type ACIInfo
  • func GetACIInfosWithAppName(tx *sql.Tx, appname string) ([]*ACIInfo, bool, error)
  • func GetACIInfosWithKeyPrefix(tx *sql.Tx, prefix string) ([]*ACIInfo, error)
  • func NewACIInfo(blobKey string, latest bool, t time.Time) *ACIInfo
• type DB
  • func NewDB(dbdir string) (*DB, error)
  • func (db *DB) Begin() (*sql.Tx, error)
  • func (db *DB) Close() error
  • func (db *DB) Do(fns ...txfunc) error
  • func (db *DB) DoTx(fns ...txfunc) error
  • func (db *DB) Open() error
• type Remote
  • func GetRemote(tx *sql.Tx, aciURL string) (remote *Remote, found bool, err error)
  • func NewRemote(aciurl, sigurl string) *Remote
  • func (r Remote) Download(ds Store, ks *keystore.Keystore) (*openpgp.Entity, *os.File, error)
  • func (r Remote) Store(ds Store, aci io.Reader, latest bool) (*Remote, error)
• type Store
  • func NewStore(base string) (*Store, error)
  • func (ds Store) Dump(hex bool)
  • func (ds Store) GetACI(name types.ACName, labels types.Labels) (string, error)
  • func (ds Store) GetImageManifest(key string) (*schema.ImageManifest, error)
  • func (ds Store) GetRemote(aciURL string) (*Remote, bool, error)
  • func (ds Store) HashToKey(h hash.Hash) string
  • func (ds Store) ReadStream(key string) (io.ReadCloser, error)
  • func (ds Store) ResolveKey(key string) (string, error)
  • func (ds Store) WriteACI(r io.Reader, latest bool) (string, error)
  • func (ds Store) WriteRemote(remote *Remote) error
  • func (ds Store) WriteStream(key string, r io.Reader) error

Functions

func WriteACIInfo

func WriteACIInfo(tx *sql.Tx, aciinfo *ACIInfo) error

WriteACIInfo adds or updates the provided aciinfo.

func WriteRemote

func WriteRemote(tx *sql.Tx, remote *Remote) error

WriteRemote adds or updates the provided Remote.

Types

type ACIInfo

type ACIInfo struct {
	// BlobKey is the key in the blob/imageManifest store of the related
	// ACI file and is the db primary key.
	BlobKey string
	// AppName is the app name provided by the ACI.
	AppName string
	// ImportTime is the time this ACI was imported in the store.
	ImportTime time.Time
	// Latest defines if the ACI was imported using the latest pattern (no
	// version label was provided on ACI discovery)
	Latest bool
}

ACIInfo is used to store information about an ACI.

func GetACIInfosWithAppName

func GetACIInfosWithAppName(tx *sql.Tx, appname string) ([]*ACIInfo, bool, error)

GetAciInfosWithAppName returns all the ACIInfos for a given appname. found will be false if no aciinfo exists.

func GetACIInfosWithKeyPrefix

func GetACIInfosWithKeyPrefix(tx *sql.Tx, prefix string) ([]*ACIInfo, error)

GetAciInfosWithKeyPrefix returns all the ACIInfos with a blobkey starting with the given prefix.

func NewACIInfo

func NewACIInfo(blobKey string, latest bool, t time.Time) *ACIInfo

type DB

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

func NewDB

func NewDB(dbdir string) (*DB, error)

func (*DB) Begin

func (db *DB) Begin() (*sql.Tx, error)

func (*DB) Close

func (db *DB) Close() error

func (*DB) Do

func (db *DB) Do(fns ...txfunc) error

Do Opens the db, executes DoTx and then Closes the DB

func (*DB) DoTx

func (db *DB) DoTx(fns ...txfunc) error

DoTx executes the provided txfuncs inside a unique transaction. If one of the functions returns an error the whole transaction is rolled back.

func (*DB) Open

func (db *DB) Open() error

type Remote

type Remote struct {
	ACIURL string
	SigURL string
	ETag   string
	// The key in the blob store under which the ACI has been saved.
	BlobKey string
}

func GetRemote

func GetRemote(tx *sql.Tx, aciURL string) (remote *Remote, found bool, err error)

GetRemote tries to retrieve a remote with the given aciURL. found will be false if remote doesn't exist.

func NewRemote

func NewRemote(aciurl, sigurl string) *Remote

func (Remote) Download

func (r Remote) Download(ds Store, ks *keystore.Keystore) (*openpgp.Entity, *os.File, error)

Download downloads and verifies the remote ACI. If Keystore is nil signature verification will be skipped. Download returns the signer, an *os.File representing the ACI, and an error if any. err will be nil if the ACI downloads successfully and the ACI is verified.

func (Remote) Store

func (r Remote) Store(ds Store, aci io.Reader, latest bool) (*Remote, error)

TODO: add locking Store stores the ACI represented by r in the target data store.

type Store

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

Store encapsulates a content-addressable-storage for storing ACIs on disk.

func NewStore

func NewStore(base string) (*Store, error)

func (Store) Dump

func (ds Store) Dump(hex bool)

func (Store) GetACI

func (ds Store) GetACI(name types.ACName, labels types.Labels) (string, error)

GetACI retrieves the ACI that best matches the provided app name and labels. The returned value is the blob store key of the retrieved ACI. If there are multiple matching ACIs choose the latest one (defined as the last one imported in the store). If no version label is requested, ACIs marked as latest in the ACIInfo are preferred.

func (Store) GetImageManifest

func (ds Store) GetImageManifest(key string) (*schema.ImageManifest, error)

Get the ImageManifest with the specified key.

func (Store) GetRemote

func (ds Store) GetRemote(aciURL string) (*Remote, bool, error)

GetRemote tries to retrieve a remote with the given ACIURL. found will be false if remote doesn't exist.

func (Store) HashToKey

func (ds Store) HashToKey(h hash.Hash) string

HashToKey takes a hash.Hash (which currently _MUST_ represent a full SHA512), calculates its sum, and returns a string which should be used as the key to store the data matching the hash.

func (Store) ReadStream

func (ds Store) ReadStream(key string) (io.ReadCloser, error)

func (Store) ResolveKey

func (ds Store) ResolveKey(key string) (string, error)

ResolveKey resolves a partial key (of format `sha512-0c45e8c0ab2`) to a full key by considering the key a prefix and using the store for resolution. If the key is longer than the full key length, it is first truncated.

func (Store) WriteACI

func (ds Store) WriteACI(r io.Reader, latest bool) (string, error)

WriteACI takes an ACI encapsulated in an io.Reader, decompresses it if necessary, and then stores it in the store under a key based on the image ID (i.e. the hash of the uncompressed ACI) latest defines if the aci has to be marked as the latest. For example an ACI discovered without asking for a specific version (latest pattern).

func (Store) WriteRemote

func (ds Store) WriteRemote(remote *Remote) error

WriteRemote adds or updates the provided Remote.

func (Store) WriteStream

func (ds Store) WriteStream(key string, r io.Reader) error