service

Documentation

Index

• func NewSociSnapshotterService(ctx context.Context, root string, serviceCfg *config.ServiceConfig, ...) (snapshots.Snapshotter, error)
• func Supported(root string) error
• type Option
  • func WithCredsFuncs(creds ...resolver.Credential) Option
  • func WithCustomRegistryHosts(hosts source.RegistryHosts) Option
  • func WithFilesystemOptions(opts ...socifs.Option) Option

Functions

func NewSociSnapshotterService

func NewSociSnapshotterService(ctx context.Context, root string, serviceCfg *config.ServiceConfig, opts ...Option) (snapshots.Snapshotter, error)

NewSociSnapshotterService returns soci snapshotter.

func Supported

func Supported(root string) error

Supported returns nil when the remote snapshotter is functional on the system with the root directory. Supported is not called during plugin initialization, but exposed for downstream projects which uses this snapshotter as a library.

Types

type Option

type Option func(*options)

func WithCredsFuncs

func WithCredsFuncs(creds ...resolver.Credential) Option

WithCredsFuncs specifies credsFuncs to be used for connecting to the registries.

func WithCustomRegistryHosts

func WithCustomRegistryHosts(hosts source.RegistryHosts) Option

WithCustomRegistryHosts is registry hosts to use instead.

func WithFilesystemOptions

func WithFilesystemOptions(opts ...socifs.Option) Option

WithFilesystemOptions allowes to pass filesystem-related configuration.