plugin

Documentation

Index

• Constants
• func Exists(plugin string) (bool, error)
• func GetInstalledPlugins() (map[string]*modconfig.PluginVersionString, error)
• func Install(ctx context.Context, plugin string, sub chan struct{}, ...) (*ociinstaller.SteampipeImage, error)
• func Remove(ctx context.Context, image string, ...) (*pipeparser.PluginRemoveReport, error)
• type PluginListItem
  • func List(pluginConnectionMap map[string][]*modconfig.Connection) ([]PluginListItem, error)

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 GetInstalledPlugins

func GetInstalledPlugins() (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 Install

func Install(ctx context.Context, plugin string, 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) (*pipeparser.PluginRemoveReport, error)

Remove removes an installed plugin

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(pluginConnectionMap map[string][]*modconfig.Connection) ([]PluginListItem, error)

List returns all installed plugins