source

Documentation

Index

• Constants
• type GitIdentifier
  • func NewGitIdentifier(remoteURL string) (*GitIdentifier, error)
  • func (i *GitIdentifier) ID() string
• type HttpIdentifier
  • func NewHttpIdentifier(str string, tls bool) (*HttpIdentifier, error)
  • func (_ *HttpIdentifier) ID() string
• type Identifier
  • func FromLLB(op *pb.Op_Source, platform *pb.Platform) (Identifier, error)
  • func FromString(s string) (Identifier, error)
• type ImageIdentifier
  • func NewImageIdentifier(str string) (*ImageIdentifier, error)
  • func (_ *ImageIdentifier) ID() string
• type LocalIdentifier
  • func NewLocalIdentifier(str string) (*LocalIdentifier, error)
  • func (*LocalIdentifier) ID() string
• type Manager
  • func NewManager() (*Manager, error)
  • func (sm *Manager) Register(src Source)
  • func (sm *Manager) Resolve(ctx context.Context, id Identifier) (SourceInstance, error)
• type ResolveMode
  • func ParseImageResolveMode(v string) (ResolveMode, error)
  • func (r ResolveMode) String() string
• type Source
• type SourceInstance

Constants

const (
	DockerImageScheme = "docker-image"
	GitScheme         = "git"
	LocalScheme       = "local"
	HttpScheme        = "http"
	HttpsScheme       = "https"
)

Types

type GitIdentifier

type GitIdentifier struct {
	Remote     string
	Ref        string
	Subdir     string
	KeepGitDir bool
}

func NewGitIdentifier

func NewGitIdentifier(remoteURL string) (*GitIdentifier, error)

func (*GitIdentifier) ID

func (i *GitIdentifier) ID() string

type HttpIdentifier

type HttpIdentifier struct {
	TLS      bool
	URL      string
	Checksum digest.Digest
	Filename string
	Perm     int
	UID      int
	GID      int
}

func NewHttpIdentifier

func NewHttpIdentifier(str string, tls bool) (*HttpIdentifier, error)

func (*HttpIdentifier) ID

func (_ *HttpIdentifier) ID() string

type Identifier

type Identifier interface {
	ID() string // until sources are in process this string comparison could be avoided
}

func FromLLB

func FromLLB(op *pb.Op_Source, platform *pb.Platform) (Identifier, error)

func FromString

func FromString(s string) (Identifier, error)

type ImageIdentifier

type ImageIdentifier struct {
	Reference   reference.Spec
	Platform    *specs.Platform
	ResolveMode ResolveMode
	RecordType  client.UsageRecordType
}

func NewImageIdentifier

func NewImageIdentifier(str string) (*ImageIdentifier, error)

func (*ImageIdentifier) ID

func (_ *ImageIdentifier) ID() string

type LocalIdentifier

type LocalIdentifier struct {
	Name            string
	SessionID       string
	IncludePatterns []string
	ExcludePatterns []string
	FollowPaths     []string
	SharedKeyHint   string
}

func NewLocalIdentifier

func NewLocalIdentifier(str string) (*LocalIdentifier, error)

func (*LocalIdentifier) ID

func (*LocalIdentifier) ID() string

type Manager

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

func NewManager

func NewManager() (*Manager, error)

func (*Manager) Register

func (sm *Manager) Register(src Source)

func (*Manager) Resolve

func (sm *Manager) Resolve(ctx context.Context, id Identifier) (SourceInstance, error)

type ResolveMode

type ResolveMode int

const (
	ResolveModeDefault ResolveMode = iota
	ResolveModeForcePull
	ResolveModePreferLocal
)

func ParseImageResolveMode

func ParseImageResolveMode(v string) (ResolveMode, error)

func (ResolveMode) String

func (r ResolveMode) String() string

type Source

type Source interface {
	ID() string
	Resolve(ctx context.Context, id Identifier) (SourceInstance, error)
}

type SourceInstance

type SourceInstance interface {
	CacheKey(ctx context.Context, index int) (string, bool, error)
	Snapshot(ctx context.Context) (cache.ImmutableRef, error)
}