pluginmanager

Documentation

Overview

Package pluginmanager is resposible for plugin discovery and installation

Index

• Constants
• func AvailablePlugins(serverName string) ([]plugin.Discovered, error)
• func AvailablePluginsFromLocalSource(localPath string) ([]plugin.Discovered, error)
• func Clean() error
• func DeletePlugin(serverName, pluginName string) error
• func DescribePlugin(serverName, pluginName string) (desc *cliv1alpha1.PluginDescriptor, err error)
• func DiscoverPlugins(serverName string) ([]plugin.Discovered, []plugin.Discovered)
• func DiscoverPluginsFromLocalSource(localPath string) ([]plugin.Discovered, error)
• func DiscoverServerPlugins(serverName string) ([]plugin.Discovered, error)
• func DiscoverStandalonePlugins() (plugins []plugin.Discovered, err error)
• func DiscoveredFromPluginDescriptor(p *cliv1alpha1.PluginDescriptor) plugin.Discovered
• func GetRecommendedVersionOfPlugin(serverName, pluginName string) (string, error)
• func InitializePlugin(serverName, pluginName string) error
• func InstallPlugin(serverName, pluginName, version string) error
• func InstallPluginsFromLocalSource(pluginName, version, localPath string) error
• func InstalledPlugins(serverName string, exclude ...string) (serverPlugins, standalonePlugins []cliv1alpha1.PluginDescriptor, err error)
• func SyncPlugins(serverName string) error
• func UpgradePlugin(serverName, pluginName, version string) error
• func ValidatePlugin(p *cliv1alpha1.PluginDescriptor) (err error)

Constants

const (

	// ManifestFileName is the file name for the manifest.
	ManifestFileName = "manifest.yaml"
	// PluginFileName is the file name for the plugin descriptor.
	PluginFileName = "plugin.yaml"
)

Functions

func AvailablePlugins

func AvailablePlugins(serverName string) ([]plugin.Discovered, error)

AvailablePlugins returns the list of available plugins including discovered and installed plugins If serverName is empty(""), return only available standalone plugins

func AvailablePluginsFromLocalSource

func AvailablePluginsFromLocalSource(localPath string) ([]plugin.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(serverName, pluginName string) error

DeletePlugin deletes a plugin. If serverName is empty(""), only consider standalone plugins

func DescribePlugin

func DescribePlugin(serverName, pluginName string) (desc *cliv1alpha1.PluginDescriptor, err error)

DescribePlugin describes a plugin. If serverName is empty(""), only consider standalone plugins

func DiscoverPlugins

func DiscoverPlugins(serverName string) ([]plugin.Discovered, []plugin.Discovered)

DiscoverPlugins returns the available plugins that can be used with the given server If serverName is empty(""), return only standalone plugins

func DiscoverPluginsFromLocalSource

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

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

func DiscoverServerPlugins

func DiscoverServerPlugins(serverName string) ([]plugin.Discovered, error)

DiscoverServerPlugins returns the available plugins associated with the given server

func DiscoverStandalonePlugins

func DiscoverStandalonePlugins() (plugins []plugin.Discovered, err error)

DiscoverStandalonePlugins returns the available standalone plugins

func DiscoveredFromPluginDescriptor

func DiscoveredFromPluginDescriptor(p *cliv1alpha1.PluginDescriptor) plugin.Discovered

DiscoveredFromPluginDescriptor returns discovered plugin object from k8sV1alpha1

func GetRecommendedVersionOfPlugin

func GetRecommendedVersionOfPlugin(serverName, pluginName string) (string, error)

GetRecommendedVersionOfPlugin returns recommended version of the plugin If serverName is empty(""), only consider standalone plugins

func InitializePlugin

func InitializePlugin(serverName, pluginName string) error

InitializePlugin initializes the plugin configuration If serverName is empty(""), only consider standalone plugins

func InstallPlugin

func InstallPlugin(serverName, pluginName, version string) error

InstallPlugin installs a plugin from the given repository. If serverName is empty(""), only consider standalone plugins

func InstallPluginsFromLocalSource

func InstallPluginsFromLocalSource(pluginName, version, localPath string) error

InstallPluginsFromLocalSource installs plugin from local source directory

func InstalledPlugins

func InstalledPlugins(serverName string, exclude ...string) (serverPlugins, standalonePlugins []cliv1alpha1.PluginDescriptor, err error)

InstalledPlugins returns the installed plugins. If serverName is empty(""), return only installed standalone plugins

func SyncPlugins

func SyncPlugins(serverName string) error

SyncPlugins automatically downloads all available plugins to users machine If serverName is empty(""), only sync standalone plugins

func UpgradePlugin

func UpgradePlugin(serverName, pluginName, version string) error

UpgradePlugin upgrades a plugin from the given repository. If serverName is empty(""), only consider standalone plugins

func ValidatePlugin

func ValidatePlugin(p *cliv1alpha1.PluginDescriptor) (err error)

ValidatePlugin validates the plugin descriptor.