v1alpha1

Documentation

Index

• type Plugin
  • func (p *Plugin) BindFlags(fs *pflag.FlagSet)
  • func (p Plugin) DeprecationWarning() string
  • func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand
  • func (p *Plugin) InjectConfig(c config.Config) error
  • func (p *Plugin) InjectResource(res *resource.Resource) error
  • func (Plugin) Name() string
  • func (p *Plugin) PostScaffold() error
  • func (p *Plugin) PreScaffold(machinery.Filesystem) error
  • func (p *Plugin) Scaffold(fs machinery.Filesystem) error
  • func (Plugin) SupportedProjectVersions() []config.Version
  • func (p *Plugin) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata)
  • func (Plugin) Version() plugin.Version
• type PluginConfig
• type ResourceData

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin implements the plugin.Full interface

func (*Plugin) BindFlags

func (p *Plugin) BindFlags(fs *pflag.FlagSet)

func (Plugin) DeprecationWarning

func (p Plugin) DeprecationWarning() string

DeprecationWarning define the deprecation message or return empty when plugin is not deprecated

func (Plugin) GetCreateAPISubcommand

func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand

GetCreateAPISubcommand will return the subcommand which is responsible for scaffolding apis

func (*Plugin) InjectConfig

func (p *Plugin) InjectConfig(c config.Config) error

func (*Plugin) InjectResource

func (p *Plugin) InjectResource(res *resource.Resource) error

func (Plugin) Name

func (Plugin) Name() string

Name returns the name of the plugin

func (*Plugin) PostScaffold

func (p *Plugin) PostScaffold() error

func (*Plugin) PreScaffold

func (p *Plugin) PreScaffold(machinery.Filesystem) error

func (*Plugin) Scaffold

func (p *Plugin) Scaffold(fs machinery.Filesystem) error

func (Plugin) SupportedProjectVersions

func (Plugin) SupportedProjectVersions() []config.Version

SupportedProjectVersions returns an array with all project versions supported by the plugin

func (*Plugin) UpdateMetadata

func (p *Plugin) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata)

func (Plugin) Version

func (Plugin) Version() plugin.Version

Version returns the version of the plugin

type PluginConfig

type PluginConfig struct {
	Resources []ResourceData `json:"resources,omitempty"`
}

PluginConfig defines the structure that will be used to track the data

type ResourceData

type ResourceData struct {
	Group   string  `json:"group,omitempty"`
	Domain  string  `json:"domain,omitempty"`
	Version string  `json:"version"`
	Kind    string  `json:"kind"`
	Options options `json:"options,omitempty"`
}

ResourceData store the resource data used in the plugin