plugin

Documentation

Index

• Constants
• func BuildManifestMap(log *logrus.Logger, name string, repoName string) (map[string]map[string][]PluginVersion, error)
• func FilterPluginForOsArch(plugin *Plugin) bool
• func GetDefaultSource() string
• func GetFilteredPlugins(pluginDir string, skipPlugins []string, logger *logrus.Logger) ([]transform.Plugin, error)
• func GetPlugins(dir string, logger *logrus.Logger) ([]transform.Plugin, error)
• func IsExecAny(mode os.FileMode) bool
• func IsUrl(URL string) (bool, string)
• func LocateBinaryInPluginDir(pluginDir string, name string, files []os.FileInfo) ([]string, error)
• type Binary
• type Plugin
• type PluginIndex
  • func GetYamlFromUrl(URL string) (PluginIndex, error)
• type PluginLocation
• type PluginVersion
  • func YamlToManifest(URL string) ([]PluginVersion, error)
• type Version

Constants

const (
	DefaultLocalPluginDir = "/.local/share/crane/plugins"
	GlobalPluginDir       = "/usr/local/share/crane/plugins"
	PkgPluginDir          = "/usr/share/crane/plugins"
)

const (
	DEFAULT_REPO     = "default"
	DEFAULT_REPO_URL = "DEFAULT_REPO_URL"
	DEFAULT_URL      = "https://raw.githubusercontent.com/konveyor/crane-plugins/main/index.yaml"
)

Functions

func BuildManifestMap

func BuildManifestMap(log *logrus.Logger, name string, repoName string) (map[string]map[string][]PluginVersion, error)

returns map containing the manifests with the key as name-version. Takes name and repo as input to filter accordingly

func FilterPluginForOsArch

func FilterPluginForOsArch(plugin *Plugin) bool

takes manifest as input and filters manifest for current os/arch

func GetDefaultSource

func GetDefaultSource() string

overrides the default plugin dir url

func GetFilteredPlugins

func GetFilteredPlugins(pluginDir string, skipPlugins []string, logger *logrus.Logger) ([]transform.Plugin, error)

func GetPlugins

func GetPlugins(dir string, logger *logrus.Logger) ([]transform.Plugin, error)

func IsExecAny

func IsExecAny(mode os.FileMode) bool

func IsUrl

func IsUrl(URL string) (bool, string)

func LocateBinaryInPluginDir

func LocateBinaryInPluginDir(pluginDir string, name string, files []os.FileInfo) ([]string, error)

return array of string containing all the paths where a binary installed within plugin-dir

Types

type Binary

type Binary struct {
	OS   string `json:"os"`
	Arch string `json:"arch"`
	URI  string `json:"uri"`
	SHA  string `json:"sha,omitempty"`
}

type Plugin

type Plugin struct {
	Kind       string          `json:"kind"`
	ApiVersion string          `json:"apiVersion"`
	Versions   []PluginVersion `json:"versions"`
}

type PluginIndex

type PluginIndex struct {
	Kind       string           `json:"kind"`
	ApiVersion string           `json:"apiVersion"`
	Plugins    []PluginLocation `json:"plugins"`
}

func GetYamlFromUrl

func GetYamlFromUrl(URL string) (PluginIndex, error)

takes url as input and returns index.yml for plugin repository

type PluginLocation

type PluginLocation struct {
	Name string `json:"name"`
	Path string `json:"path"`
}

type PluginVersion

type PluginVersion struct {
	Name             string                     `json:"name"`
	ShortDescription string                     `json:"shortDescription"`
	Description      string                     `json:"description"`
	Version          Version                    `json:"version"`
	Binaries         []Binary                   `json:"binaries"`
	OptionalFields   []transform.OptionalFields `json:"optionalFields"`
}

func YamlToManifest

func YamlToManifest(URL string) ([]PluginVersion, error)

takes url as input and fetches the manifest of a plugin

type Version

type Version string