ocifs

README

= ocifs

a read-only FUSE union filesystem for Docker and OCI images, in pure Go

Documentation

Index

• Variables
• type ImageMount
  • func (im *ImageMount) ConfigFile() (*v1.ConfigFile, error)
  • func (im *ImageMount) MountPoint() string
  • func (im *ImageMount) Unmount() error
  • func (im *ImageMount) Wait()
• type MountOption
• type OCIFS
  • func New(opts ...Option) (*OCIFS, error)
  • func (o *OCIFS) Mount(imgRef string, opts ...MountOption) (*ImageMount, error)
• type Option

Variables

var MountWithID = func(id string) MountOption {
	return func(im *ImageMount) {
		im.id = id
	}
}

var MountWithTargetPath = func(targetPath string) MountOption {
	return func(im *ImageMount) {
		im.mountPoint = targetPath
	}
}

var WithAuthSource = func(prefix string, auth authn.AuthConfig) Option {
	return func(o *OCIFS) {
		o.authn.creds[prefix] = auth
	}
}

var WithCacheExpiration = func(exp time.Duration) Option {
	return func(o *OCIFS) {
		o.exp = exp
	}
}

var WithEnableDefaultKeychain = func() Option {
	return func(o *OCIFS) {
		o.authn.includeDefaultKeychain = true
	}
}

var WithExtraDirs = func(extraDirs []string) Option {
	return func(o *OCIFS) {
		o.extraDirs = extraDirs
	}
}

var WithWorkDir = func(workDir string) Option {
	return func(o *OCIFS) {
		o.workDir = filepath.Clean(workDir)
	}
}

Types

type ImageMount

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

func (*ImageMount) ConfigFile

func (im *ImageMount) ConfigFile() (*v1.ConfigFile, error)

func (*ImageMount) MountPoint

func (im *ImageMount) MountPoint() string

func (*ImageMount) Unmount

func (im *ImageMount) Unmount() error

func (*ImageMount) Wait

func (im *ImageMount) Wait()

type MountOption

type MountOption func(*ImageMount)

type OCIFS

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

func New

func New(opts ...Option) (*OCIFS, error)

func (*OCIFS) Mount

func (o *OCIFS) Mount(imgRef string, opts ...MountOption) (*ImageMount, error)

type Option

type Option func(*OCIFS)