plugin

Documentation

Index

• func GetInstalledPlugins(ctx context.Context, pluginVersions map[string]*versionfile.InstalledVersion) (map[string]*plugin.PluginVersionString, error)
• func Install(ctx context.Context, plugin plugin.ResolvedPluginVersion, sub chan struct{}, ...) (...)
• type PluginConnection
• type PluginListItem
  • func List(ctx context.Context, pluginConnectionMap map[string][]PluginConnection, ...) ([]PluginListItem, error)
• type PluginRemoveReport
  • func Remove(ctx context.Context, image string, ...) (*PluginRemoveReport, error)
• type PluginRemoveReports
  • func (r PluginRemoveReports) Print()

Functions

func GetInstalledPlugins

func GetInstalledPlugins(ctx context.Context, pluginVersions map[string]*versionfile.InstalledVersion) (map[string]*plugin.PluginVersionString, error)

GetInstalledPlugins returns the list of plugins keyed by the shortname (org/name) and its specific version Does not validate/check of available connections

func Install

func Install(ctx context.Context, plugin plugin.ResolvedPluginVersion, sub chan struct{}, baseImageRef string, mediaTypesProvider ociinstaller.MediaTypeProvider, opts ...ociinstaller.PluginInstallOption) (*ociinstaller.OciImage[*ociinstaller.PluginImage, *ociinstaller.PluginImageConfig], error)

Install installs a plugin in the local file system

Types

type PluginConnection

type PluginConnection interface {
	GetDeclRange() hclhelpers.Range
	GetName() string
	GetDisplayName() string
}

type PluginListItem

type PluginListItem struct {
	Name        string
	Version     *plugin.PluginVersionString
	Connections []string
}

PluginListItem is a struct representing an item in the list of plugins

func List

func List(ctx context.Context, pluginConnectionMap map[string][]PluginConnection, pluginVersions map[string]*versionfile.InstalledVersion) ([]PluginListItem, error)

List returns all installed plugins

type PluginRemoveReport

type PluginRemoveReport struct {
	Image       *ociinstaller.ImageRef
	ShortName   string
	Connections []PluginConnection
}

func Remove

func Remove(ctx context.Context, image string, pluginConnections map[string][]PluginConnection) (*PluginRemoveReport, error)

Remove removes an installed plugin

type PluginRemoveReports

type PluginRemoveReports []PluginRemoveReport

func (PluginRemoveReports) Print

func (r PluginRemoveReports) Print()