pluginmanager

Documentation

Overview

Package pluginmanager is responsible for plugin discovery and installation

Index

• Constants
• func AvailablePlugins() ([]discovery.Discovered, error)
• func AvailablePluginsFromLocalSource(localPath string) ([]discovery.Discovered, error)
• func Clean() error
• func DeletePlugin(options DeletePluginOptions) error
• func DescribePlugin(pluginName string, target configtypes.Target) (info *cli.PluginInfo, err error)
• func DiscoverPluginGroups(criteria *discovery.GroupDiscoveryCriteria) ([]*plugininventory.PluginGroup, error)
• func DiscoverPlugins() ([]discovery.Discovered, []discovery.Discovered)
• func DiscoverPluginsFromLocalSource(localPath string) ([]discovery.Discovered, error)
• func DiscoverServerPlugins() ([]discovery.Discovered, error)
• func DiscoverStandalonePlugins(criteria *discovery.PluginDiscoveryCriteria) ([]discovery.Discovered, error)
• func DiscoveredFromPlugininfo(p *cli.PluginInfo) discovery.Discovered
• func FindVersion(recommendedPluginVersion, requestedVersion string) string
• func GetRecommendedVersionOfPlugin(pluginName string, target configtypes.Target) (string, error)
• func InitializePlugin(plugin *cli.PluginInfo) error
• func InstallPluginFromContext(pluginName, version string, target configtypes.Target, contextName string) error
• func InstallPluginsFromGroup(pluginName, groupIDAndVersion string) (string, error)
• func InstallPluginsFromLocalSource(pluginName, version string, target configtypes.Target, localPath string, ...) error
• func InstallStandalonePlugin(pluginName, version string, target configtypes.Target) error
• func SyncPlugins() error
• func UpgradePlugin(pluginName, version string, target configtypes.Target) error
• func ValidatePlugin(p *cli.PluginInfo) (err error)
• type DeletePluginOptions

Constants

const (

	// ManifestFileName is the file name for the manifest.
	ManifestFileName = "manifest.yaml"
	// PluginManifestFileName is the file name for the manifest.
	PluginManifestFileName = "plugin_manifest.yaml"
	// PluginFileName is the file name for the plugin info.
	PluginFileName = "plugin.yaml"
)

const HTTP = "http"

const HTTPS = "https"

const True = "true"

Functions

func AvailablePlugins

func AvailablePlugins() ([]discovery.Discovered, error)

AvailablePlugins returns the list of available plugins including discovered and installed plugins. Plugin discovery happens for all active contexts

func AvailablePluginsFromLocalSource

func AvailablePluginsFromLocalSource(localPath string) ([]discovery.Discovered, error)

AvailablePluginsFromLocalSource returns the list of available plugins from local source

func Clean

func Clean() error

Clean deletes all plugins and tests.

func DeletePlugin

func DeletePlugin(options DeletePluginOptions) error

DeletePlugin deletes a plugin.

func DescribePlugin

func DescribePlugin(pluginName string, target configtypes.Target) (info *cli.PluginInfo, err error)

DescribePlugin describes a plugin.

func DiscoverPluginGroups

func DiscoverPluginGroups(criteria *discovery.GroupDiscoveryCriteria) ([]*plugininventory.PluginGroup, error)

DiscoverPluginGroups returns the available plugin groups

func DiscoverPlugins

func DiscoverPlugins() ([]discovery.Discovered, []discovery.Discovered)

DiscoverPlugins returns all the discovered plugins including standalone and context-scoped plugins Context scoped plugin discovery happens for all active contexts

func DiscoverPluginsFromLocalSource

func DiscoverPluginsFromLocalSource(localPath string) ([]discovery.Discovered, error)

DiscoverPluginsFromLocalSource returns the available plugins that are discovered from the provided local path

func DiscoverServerPlugins

func DiscoverServerPlugins() ([]discovery.Discovered, error)

DiscoverServerPlugins returns the available plugins associated all the active contexts

func DiscoverStandalonePlugins

func DiscoverStandalonePlugins(criteria *discovery.PluginDiscoveryCriteria) ([]discovery.Discovered, error)

DiscoverStandalonePlugins returns the available standalone plugins

func DiscoveredFromPlugininfo

func DiscoveredFromPlugininfo(p *cli.PluginInfo) discovery.Discovered

DiscoveredFromPlugininfo returns discovered plugin object from k8sV1alpha1

func FindVersion

func FindVersion(recommendedPluginVersion, requestedVersion string) string

func GetRecommendedVersionOfPlugin

func GetRecommendedVersionOfPlugin(pluginName string, target configtypes.Target) (string, error)

GetRecommendedVersionOfPlugin returns recommended version of the plugin

func InitializePlugin

func InitializePlugin(plugin *cli.PluginInfo) error

InitializePlugin initializes the plugin configuration

func InstallPluginFromContext

func InstallPluginFromContext(pluginName, version string, target configtypes.Target, contextName string) error

InstallPluginFromContext installs a plugin by name, version and target as a context-scope plugin.

func InstallPluginsFromGroup

func InstallPluginsFromGroup(pluginName, groupIDAndVersion string) (string, error)

InstallPluginsFromGroup installs either the specified plugin or all plugins from the specified group version. If the group version is not specified, the latest available version will be used. The group identifier including the version used is returned.

func InstallPluginsFromLocalSource

func InstallPluginsFromLocalSource(pluginName, version string, target configtypes.Target, localPath string, installTestPlugin bool) error

InstallPluginsFromLocalSource installs plugin from local source directory nolint: gocyclo

func InstallStandalonePlugin

func InstallStandalonePlugin(pluginName, version string, target configtypes.Target) error

InstallStandalonePlugin installs a plugin by name, version and target as a standalone plugin.

func SyncPlugins

func SyncPlugins() error

SyncPlugins will install the plugins required by the current contexts. If the central-repo is disabled, all discovered plugins will be installed.

func UpgradePlugin

func UpgradePlugin(pluginName, version string, target configtypes.Target) error

UpgradePlugin upgrades a plugin from the given repository.

func ValidatePlugin

func ValidatePlugin(p *cli.PluginInfo) (err error)

ValidatePlugin validates the plugin info.

Types

type DeletePluginOptions

type DeletePluginOptions struct {
	Target      configtypes.Target
	PluginName  string
	ForceDelete bool
}