types

Documentation

Index

• Constants
• type InstalledPlugin
• type LocalCache
• type LocalCacheSpec
• type MatchLabels
• type MetadataInfo
• type PluginMetadata
• type PluginMetadataSpec
• type PluginVersionForPlatform
• type PluginVersionMetadata
• type Selector

Constants

const (
	// VALID_PLUGIN_FILENAME_PREFIX is the prefix used for plugin filenames.
	VALID_PLUGIN_FILENAME_PREFIX = "konveyor-"
	// DEFAULT_FILE_PERMISSIONS is the default permissions to use when creaing a new file.
	DEFAULT_FILE_PERMISSIONS os.FileMode = 0644
	// DEFAULT_DIRECTORY_PERMISSIONS is the default permissions to use when creaing a new directory.
	DEFAULT_DIRECTORY_PERMISSIONS os.FileMode = 0755
	// STORAGE_DIR is where all the app specific data is stored.
	STORAGE_DIR = ".konveyor"
	// PLUGINS_DIR is where all the plugins are stored.
	PLUGINS_DIR = "plugins"
	// CACHE_FILE contains the list of installed plugins and other app specific metadata.
	CACHE_FILE = "cache.yaml"
	// API_VERSION is the apiVersion (similar to K8s) used by our app specific files.
	API_VERSION = "cli.konveyor.io/v1alpha1"
	// KIND is the kind (similar to K8s) used by our app's local cache.
	CACHE_FILE_KIND = "Cache"
)

Types

type InstalledPlugin

type InstalledPlugin struct {
	Name     string `yaml:"name"`
	Version  string `yaml:"version"`
	Platform string `yaml:"platform"`
	Bin      string `yaml:"bin"`
}

InstalledPlugin contains the metadata for an installed plugin.

type LocalCache

type LocalCache struct {
	ApiVersion string         `yaml:"apiVersion"`
	Kind       string         `yaml:"kind"`
	Metadata   MetadataInfo   `yaml:"metadata"`
	Spec       LocalCacheSpec `yaml:"spec"`
}

LocalCache contains the list of installed plugins and other app specific metadata.

type LocalCacheSpec

type LocalCacheSpec struct {
	Installed []InstalledPlugin `yaml:"installed"`
}

LocalCacheSpec contains the list of installed plugins and other app specific metadata.

type MatchLabels

type MatchLabels struct {
	Os   string `yaml:"os"`
	Arch string `yaml:"arch"`
}

MatchLabels contains the platform selector.

type MetadataInfo

type MetadataInfo struct {
	Name string `yaml:"name"`
}

MetadataInfo contains the name.

type PluginMetadata

type PluginMetadata struct {
	ApiVersion string             `yaml:"apiVersion"`
	Kind       string             `yaml:"kind"`
	Metadata   MetadataInfo       `yaml:"metadata"`
	Spec       PluginMetadataSpec `yaml:"spec"`
}

PluginMetadata stores the plugin metadata from the YAML.

type PluginMetadataSpec

type PluginMetadataSpec struct {
	Homepage         string                  `yaml:"homePage"`
	Docs             string                  `yaml:"docs"`
	Tutorials        string                  `yaml:"tutorials"`
	ShortDescription string                  `yaml:"shortDescription"`
	Description      string                  `yaml:"description"`
	Versions         []PluginVersionMetadata `yaml:"versions"`
}

PluginMetadataSpec stores the specification of the plugin metadata.

type PluginVersionForPlatform

type PluginVersionForPlatform struct {
	Selector Selector `yaml:"selector"`
	Uri      string   `yaml:"uri"`
	Sha256   string   `yaml:"sha256"`
	Bin      string   `yaml:"bin"`
}

PluginVersionForPlatform contains the version and platform specific metadata.

type PluginVersionMetadata

type PluginVersionMetadata struct {
	Version   string                     `yaml:"version"`
	Platforms []PluginVersionForPlatform `yaml:"platforms"`
}

PluginVersionMetadata stores the metadata of a specific version of the plugin.

type Selector

type Selector struct {
	MatchLabels MatchLabels `yaml:"matchLabels"`
}

Selector contains the platform selector.