plugin

Documentation

Index

• func NewGenerateCmd() *cobra.Command
• type Flag
• type Plugin

Functions

func NewGenerateCmd

func NewGenerateCmd() *cobra.Command

NewGenerateCmd builds a command that generates plugin.yaml files.

Types

type Flag

type Flag struct {
	Name      string `yaml:"name"`
	Shorthand string `yaml:"shorthand,omitempty"`
	Desc      string `yaml:"desc"`
	DefValue  string `yaml:"defValue,omitempty"`
}

Flag describes a single flag supported by a given plugin. From https://github.com/kubernetes/kubernetes/blob/23cd1434e69c1a984e8c24c875c19ccbdd0ba2fe/pkg/kubectl/plugins/plugins.go#L93

type Plugin

type Plugin struct {
	Name      string   `yaml:"name"`
	Use       string   `yaml:"use"`
	ShortDesc string   `yaml:"shortDesc"`
	LongDesc  string   `yaml:"longDesc,omitempty"`
	Example   string   `yaml:"example,omitempty"`
	Command   string   `yaml:"command"`
	Flags     []Flag   `yaml:"flags,omitempty"`
	Tree      []Plugin `yaml:"tree,omitempty"`
}

Plugin holds everything needed to register a plugin as a command. Usually comes from a descriptor file. From https://github.com/kubernetes/kubernetes/blob/23cd1434e69c1a984e8c24c875c19ccbdd0ba2fe/pkg/kubectl/plugins/plugins.go#L47