plugin

Documentation

Index

• Constants
• func Exists(plugin string) (bool, error)
• func GetAllUpdateReport(installationID string, timeout time.Duration) map[string]VersionCheckReport
• func GetUpdateReport(installationID string, check []*versionfile.InstalledVersion, ...) map[string]VersionCheckReport
• func Install(ctx context.Context, plugin string, sub chan struct{}) (*ociinstaller.SteampipeImage, error)
• func Remove(ctx context.Context, image string, ...) (*display.PluginRemoveReport, error)
• func SkipUpdate(report VersionCheckReport) (bool, string)
• type PluginListItem
  • func List(pluginConnectionMap map[string][]modconfig.Connection) ([]PluginListItem, error)
• type VersionCheckReport
  • func (vr *VersionCheckReport) ShortName() string
• type VersionChecker

Constants

const (
	DefaultImageTag     = "latest"
	DefaultImageRepoURL = "us-docker.pkg.dev/steampipe/plugin"
	DefaultImageOrg     = "turbot"
)

Functions

func Exists

func Exists(plugin string) (bool, error)

Exists looks up the version file and reports whether a plugin is already installed

func GetAllUpdateReport

func GetAllUpdateReport(installationID string, timeout time.Duration) map[string]VersionCheckReport

GetAllUpdateReport looks up and reports the updated version of all turbot plugins which are listed in versions.json

func GetUpdateReport

func GetUpdateReport(installationID string, check []*versionfile.InstalledVersion, timeout time.Duration) map[string]VersionCheckReport

GetUpdateReport looks up and reports the updated version of selective turbot plugins which are listed in versions.json

func Install

func Install(ctx context.Context, plugin string, sub chan struct{}) (*ociinstaller.SteampipeImage, error)

Install installs a plugin in the local file system

func Remove

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

Remove removes an installed plugin

func SkipUpdate

func SkipUpdate(report VersionCheckReport) (bool, string)

SkipUpdate determines if the latest version in a "stream" requires the plugin to update.

Types

type PluginListItem

type PluginListItem struct {
	Name        string
	Version     string
	Connections []string
}

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

func List

func List(pluginConnectionMap map[string][]modconfig.Connection) ([]PluginListItem, error)

List returns all installed plugins

type VersionCheckReport

type VersionCheckReport struct {
	Plugin        *versionfile.InstalledVersion
	CheckResponse versionCheckResponsePayload
	CheckRequest  versionCheckRequestPayload
}

VersionCheckReport ::

func (*VersionCheckReport) ShortName

func (vr *VersionCheckReport) ShortName() string

type VersionChecker

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

VersionChecker :: wrapper struct over the plugin version check utilities