docs

Documentation

Index

• func AddDocs(cmd *cobra.Command)
• func GetDocs() *cobra.Command
• func RunCleanDocs(cmd *cobra.Command, args []string)
• func RunDocs(cmd *cobra.Command, args []string)
• type Category
• type CodeGenerator
  • func (g CodeGenerator) Execute(dir string) error
• type ConfigArgs
• type Resource

Functions

func AddDocs

func AddDocs(cmd *cobra.Command)

func GetDocs

func GetDocs() *cobra.Command

func RunCleanDocs

func RunCleanDocs(cmd *cobra.Command, args []string)

func RunDocs

func RunDocs(cmd *cobra.Command, args []string)

Types

type Category

type Category struct {
	Name      string
	Include   string
	Resources []Resource
}

type CodeGenerator

type CodeGenerator struct{}

CodeGenerator generates code for Kubernetes resources and controllers

func (CodeGenerator) Execute

func (g CodeGenerator) Execute(dir string) error

Execute parses packages and executes the code generators against the resource and controller packages

type ConfigArgs

type ConfigArgs struct {
	Groups     []string
	Categories []Category
}

type Resource

type Resource struct {
	Kind, Version, Group, Warning, Note string
}