v1

Documentation

Overview

Deprecated: The declarative plugin has been deprecated. The Declarative plugin is an implementation derived from the kubebuilder-declarative-pattern project. As the project maintainers possess the most comprehensive knowledge about its changes and Kubebuilder allows the creation of custom plugins using its library, it has been decided that this plugin will be better maintained within the kubebuilder-declarative-pattern project itself, which falls under its domain of responsibility. This decision aims to improve the maintainability of both the plugin and Kubebuilder, ultimately providing an enhanced user experience. To follow up on this work, please refer to the Issue #293: https://github.com/kubernetes-sigs/kubebuilder-declarative-pattern/issues/293.

Index

• type Plugin
  • func (p Plugin) DeprecationWarning() string
  • func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand
  • func (p Plugin) GetInitSubcommand() plugin.InitSubcommand
  • func (p *Plugin) InjectResource(res *resource.Resource) error
  • func (Plugin) Name() string
  • func (Plugin) SupportedProjectVersions() []config.Version
  • func (p *Plugin) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata)
  • func (Plugin) Version() plugin.Version

Types

type Plugin

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

Plugin implements the plugin.Full interface

func (Plugin) DeprecationWarning

func (p Plugin) DeprecationWarning() string

func (Plugin) GetCreateAPISubcommand

func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand

GetCreateAPISubcommand will return the subcommand which is responsible for scaffolding apis

func (Plugin) GetInitSubcommand

func (p Plugin) GetInitSubcommand() plugin.InitSubcommand

GetInitSubcommand will return the subcommand which is responsible for initializing and common scaffolding

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) 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