plugin

Documentation

Index

• Constants
• func CleanupOldTmpDirs(ctx context.Context)
• func Exists(ctx context.Context, plugin string) (bool, error)
• func GetAllUpdateReport(ctx context.Context, installationID string) map[string]VersionCheckReport
• func GetInstalledPlugins(ctx context.Context) (map[string]*modconfig.PluginVersionString, error)
• func GetUpdateReport(ctx context.Context, installationID string, ...) map[string]VersionCheckReport
• func Install(ctx context.Context, plugin ResolvedPluginVersion, sub chan struct{}, ...) (*ociinstaller.SteampipeImage, error)
• func Remove(ctx context.Context, image string, ...) (*steampipeconfig.PluginRemoveReport, error)
• func UpdateRequired(report VersionCheckReport) bool
• type PluginListItem
  • func List(ctx context.Context, pluginConnectionMap map[string][]*modconfig.Connection) ([]PluginListItem, error)
• type ResolvedPluginVersion
  • func GetLatestPluginVersionByConstraint(ctx context.Context, installationID string, org string, name string, ...) (*ResolvedPluginVersion, error)
  • func NewResolvedPluginVersion(pluginName string, version string, constraint string) ResolvedPluginVersion
  • func (r ResolvedPluginVersion) GetVersionTag() string
• type VersionCheckReport
  • func (vr *VersionCheckReport) ShortName() string
  • func (vr *VersionCheckReport) ShortNameWithConstraint() string
• type VersionChecker

Constants

const (
	VersionCheckerSchema   = "https"
	VersionCheckerHost     = "hub.steampipe.io"
	VersionCheckerEndpoint = "api/plugin/version"
)

Functions

func CleanupOldTmpDirs

func CleanupOldTmpDirs(ctx context.Context)

func Exists

func Exists(ctx context.Context, plugin string) (bool, error)

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

func GetAllUpdateReport

func GetAllUpdateReport(ctx context.Context, installationID string) map[string]VersionCheckReport

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

func GetInstalledPlugins

func GetInstalledPlugins(ctx context.Context) (map[string]*modconfig.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 GetUpdateReport

func GetUpdateReport(ctx context.Context, installationID string, check []*versionfile.InstalledVersion) 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 ResolvedPluginVersion, sub chan struct{}, opts ...ociinstaller.PluginInstallOption) (*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) (*steampipeconfig.PluginRemoveReport, error)

Remove removes an installed plugin

func UpdateRequired

func UpdateRequired(report VersionCheckReport) bool

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

Types

type PluginListItem

type PluginListItem struct {
	Name        string
	Version     *modconfig.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][]*modconfig.Connection) ([]PluginListItem, error)

List returns all installed plugins

type ResolvedPluginVersion

type ResolvedPluginVersion struct {
	PluginName string
	Version    string
	Constraint string
}

func GetLatestPluginVersionByConstraint

func GetLatestPluginVersionByConstraint(ctx context.Context, installationID string, org string, name string, constraint string) (*ResolvedPluginVersion, error)

func NewResolvedPluginVersion

func NewResolvedPluginVersion(pluginName string, version string, constraint string) ResolvedPluginVersion

func (ResolvedPluginVersion) GetVersionTag

func (r ResolvedPluginVersion) GetVersionTag() string

GetVersionTag returns the <PluginName>:<Version> (turbot/chaos:0.4.1)

type VersionCheckReport

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

VersionCheckReport ::

func (*VersionCheckReport) ShortName

func (vr *VersionCheckReport) ShortName() string

func (*VersionCheckReport) ShortNameWithConstraint

func (vr *VersionCheckReport) ShortNameWithConstraint() string

type VersionChecker

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

VersionChecker :: wrapper struct over the plugin version check utilities