downloader

Documentation

Index

• Constants
• type DownloadStatistic
• type ModuleDownloadResult
• type ModuleDownloader
  • func NewModuleDownloader(dc dependency.Container, downloadedModulesDir string, ...) *ModuleDownloader
  • func (md *ModuleDownloader) DownloadByModuleVersion(ctx context.Context, moduleName, moduleVersion string) (*DownloadStatistic, error)
  • func (md *ModuleDownloader) DownloadDevImageTag(moduleName, imageTag, checksum string) (string, *moduletypes.Definition, error)
  • func (md *ModuleDownloader) DownloadMetadataByVersion(moduleName, moduleVersion string) (ModuleDownloadResult, error)
  • func (md *ModuleDownloader) DownloadMetadataFromReleaseChannel(ctx context.Context, moduleName, releaseChannel string) (ModuleDownloadResult, error)
  • func (md *ModuleDownloader) DownloadModuleDefinitionByVersion(moduleName, moduleVersion string) (*moduletypes.Definition, error)
  • func (md *ModuleDownloader) GetDocumentationArchive(moduleName, moduleVersion string) (io.ReadCloser, error)
• type ModuleReleaseMetadata

Constants

const (
	DefaultDevVersion = "dev"
)

Types

type DownloadStatistic

type DownloadStatistic struct {
	Size         uint32
	PullDuration time.Duration
}

type ModuleDownloadResult

type ModuleDownloadResult struct {
	Checksum      string
	ModuleVersion string

	ModuleDefinition *moduletypes.Definition
	Changelog        map[string]any
}

type ModuleDownloader

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

func NewModuleDownloader

func NewModuleDownloader(dc dependency.Container, downloadedModulesDir string, ms *v1alpha1.ModuleSource, registryOptions []cr.Option) *ModuleDownloader

func (*ModuleDownloader) DownloadByModuleVersion

func (md *ModuleDownloader) DownloadByModuleVersion(ctx context.Context, moduleName, moduleVersion string) (*DownloadStatistic, error)

func (*ModuleDownloader) DownloadDevImageTag

func (md *ModuleDownloader) DownloadDevImageTag(moduleName, imageTag, checksum string) (string, *moduletypes.Definition, error)

DownloadDevImageTag downloads image tag and store it in the .../<moduleName>/dev fs path if checksum is equal to a module image digest - do nothing otherwise return new digest

func (*ModuleDownloader) DownloadMetadataByVersion

func (md *ModuleDownloader) DownloadMetadataByVersion(moduleName, moduleVersion string) (ModuleDownloadResult, error)

DownloadMetadataByVersion downloads only module release image with metadata: version.json does not fetch and install the desired version on the module, only fetches its module definition

func (*ModuleDownloader) DownloadMetadataFromReleaseChannel

func (md *ModuleDownloader) DownloadMetadataFromReleaseChannel(ctx context.Context, moduleName, releaseChannel string) (ModuleDownloadResult, error)

DownloadMetadataFromReleaseChannel downloads only module release image with metadata: version.json, checksum.json(soon) does not fetch and install the desired version on the module, only fetches its module definition

func (*ModuleDownloader) DownloadModuleDefinitionByVersion

func (md *ModuleDownloader) DownloadModuleDefinitionByVersion(moduleName, moduleVersion string) (*moduletypes.Definition, error)

DownloadModuleDefinitionByVersion returns a module definition from the repo by the module's name and version(tag)

func (*ModuleDownloader) GetDocumentationArchive

func (md *ModuleDownloader) GetDocumentationArchive(moduleName, moduleVersion string) (io.ReadCloser, error)

type ModuleReleaseMetadata

type ModuleReleaseMetadata struct {
	Version *semver.Version `json:"version"`

	Changelog map[string]any `json:"-"`
}