ociinstaller

Apr 2, 2025

Changes in this version

type PluginInstallOption

+ func WithGetMetadataFunc(getMetadataFunc func(context.Context, string) (map[string][]string, error)) PluginInstallOption

Jan 30, 2025

Changes in this version

+ const DefaultConfigSchema

+ const DefaultImageOrg

+ const DefaultImageTag

+ const DefaultImageType

+ func FileExists(filePath string) bool

+ func FindLayersForMediaType(layers []ocispec.Descriptor, mediaType string) []ocispec.Descriptor

+ func MediaTypeConfig() string

+ func MediaTypePluginConfig() string

+ func MediaTypePluginDocsLayer() string

+ func MediaTypePluginLicenseLayer() string

+ func MediaTypePluginSpcLayer() string

+ func MoveFileWithinPartition(sourcePath, destPath string) error

+ func MoveFolderWithinPartition(sourcePath, destPath string) error

+ func NewTempDir(parent string) *tempDir

+ func Ungzip(sourceFile string, destDir string, opts ...UngzipOption) (string, error)

+ type ImageProvider interface

+ EmptyConfig func() C

+ GetImageData func(layers []ocispec.Descriptor) (I, error)

+ type ImageRef struct

+ RequestedRef string

+ func NewImageRef(ref string) *ImageRef

+ func (r *ImageRef) ActualImageRef() string

+ func (r *ImageRef) DisplayImageRef() string

+ func (r *ImageRef) DisplayImageRefConstraintOverride(constraint string) string

+ func (r *ImageRef) GetFriendlyName() string

+ func (r *ImageRef) GetOrgNameAndStream() (org, name, stream string)

+ func (r *ImageRef) IsFromTurbotHub() bool

+ type ImageType string

+ const ImageTypePlugin

+ type MediaTypeProvider interface

+ ConfigMediaTypes func() []string

+ MediaTypeForPlatform func(imageType ImageType) ([]string, error)

+ SharedMediaTypes func(imageType ImageType) []string

+ type OciConfigBase struct

+ SchemaVersion string

+ func (c *OciConfigBase) GetSchemaVersion() string

+ func (c *OciConfigBase) SetSchemaVersion(version string)

+ type OciDownloader struct

+ ImageProvider ImageProvider[I, C]

+ Images []*OciImage[I, C]

+ MediaTypesProvider MediaTypeProvider

+ func NewOciDownloader[I OciImageData, C OciImageConfig](baseImageRef string, mediaTypesProvider MediaTypeProvider, ...) *OciDownloader[I, C]

+ func (o *OciDownloader[I, C]) Download(ctx context.Context, ref *ImageRef, imageType ImageType, destDir string) (*OciImage[I, C], error)

+ func (o *OciDownloader[I, C]) Pull(ctx context.Context, ref string, mediaTypes []string, destDir string) (*ocispec.Descriptor, *ocispec.Descriptor, []byte, []ocispec.Descriptor, error)

+ type OciImage struct

+ Config C

+ Data I

+ ImageRef *ImageRef

+ OCIDescriptor *ocispec.Descriptor

+ func InstallPlugin(ctx context.Context, imageRef string, constraint string, sub chan struct{}, ...) (*OciImage[*PluginImage, *PluginImageConfig], error)

+ type OciImageConfig interface

+ GetSchemaVersion func() string

+ SetSchemaVersion func(string)

+ type OciImageData interface

+ Type func() ImageType

+ type PluginImage struct

+ BinaryArchitecture string

+ BinaryDigest string

+ BinaryFile string

+ ConfigFileDir string

+ DocsDir string

+ LicenseFile string

+ func (s *PluginImage) Type() ImageType

+ type PluginImageConfig struct

+ Plugin struct{ ... }

+ type PluginInstallOption = func(config *pluginInstallConfig)

+ func WithSkipConfig(skipConfigFile bool) PluginInstallOption

+ type PluginOciDownloader struct

+ func NewPluginOciDownloader(baseImageRef string, mediaTypesProvider MediaTypeProvider) *PluginOciDownloader

+ func (p *PluginOciDownloader) EmptyConfig() *PluginImageConfig

+ func (p *PluginOciDownloader) GetImageData(layers []ocispec.Descriptor) (*PluginImage, error)

+ type UngzipOption func(*gzipConfig)

+ func WithMaxDecompressedSize(size int64) UngzipOption