v2

Documentation

Index

• type Options
  • func (opts Options) GVK() resource.GVK
  • func (opts Options) NewResource(c newconfig.Config) resource.Resource
  • func (opts Options) Validate() error
• type Plugin
  • func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand
  • func (p Plugin) GetCreateWebhookSubcommand() plugin.CreateWebhookSubcommand
  • func (p Plugin) GetEditSubcommand() plugin.EditSubcommand
  • func (p Plugin) GetInitSubcommand() plugin.InitSubcommand
  • func (Plugin) Name() string
  • func (Plugin) SupportedProjectVersions() []config.Version
  • func (Plugin) Version() plugin.Version

Types

type Options

type Options struct {
	// Group is the resource's group. Does not contain the domain.
	Group string
	// Domain is the resource's domain.
	Domain string
	// Version is the resource's version.
	Version string
	// Kind is the resource's kind.
	Kind string

	// Plural is the resource's kind plural form.
	// Optional
	Plural string

	// CRDVersion is the CustomResourceDefinition API version that will be used for the resource.
	CRDVersion string
	// WebhookVersion is the {Validating,Mutating}WebhookConfiguration API version that will be used for the resource.
	WebhookVersion string

	// Namespaced is true if the resource should be namespaced.
	Namespaced bool

	// Flags that define which parts should be scaffolded
	DoAPI        bool
	DoController bool
	DoDefaulting bool
	DoValidation bool
	DoConversion bool
}

Options contains the information required to build a new resource.Resource.

func (Options) GVK

func (opts Options) GVK() resource.GVK

GVK returns the GVK identifier of a resource.

func (Options) NewResource

func (opts Options) NewResource(c newconfig.Config) resource.Resource

NewResource creates a new resource from the options

func (Options) Validate

func (opts Options) Validate() error

Validate verifies that all the fields have valid values

type Plugin

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

Plugin implements the plugin.Full interface

func (Plugin) GetCreateAPISubcommand

func (p Plugin) GetCreateAPISubcommand() plugin.CreateAPISubcommand

GetCreateAPISubcommand will return the subcommand which is responsible for scaffolding apis

func (Plugin) GetCreateWebhookSubcommand

func (p Plugin) GetCreateWebhookSubcommand() plugin.CreateWebhookSubcommand

GetCreateWebhookSubcommand will return the subcommand which is responsible for scaffolding webhooks

func (Plugin) GetEditSubcommand

func (p Plugin) GetEditSubcommand() plugin.EditSubcommand

GetEditSubcommand will return the subcommand which is responsible for editing the scaffold of the project

func (Plugin) GetInitSubcommand

func (p Plugin) GetInitSubcommand() plugin.InitSubcommand

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

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

func (Plugin) Version() plugin.Version

Version returns the version of the plugin