generator

Documentation

Index

• func RenderOlmCatalog(c *Config, image, version string) error
• func RenderOperatorYaml(c *Config, image string) error
• type Config
• type Generator
  • func NewGenerator(apiVersion, kind, projectName, repoPath string) *Generator
  • func (g *Generator) Render() error

Functions

func RenderOlmCatalog

func RenderOlmCatalog(c *Config, image, version string) error

RenderOlmCatalog generates catalog manifests "deploy/olm-catalog/*" The current working directory must be the project repository root

func RenderOperatorYaml

func RenderOperatorYaml(c *Config, image string) error

RenderOperatorYaml generates "deploy/operator.yaml"

Types

type Config

type Config struct {
	// APIVersion is the kubernetes apiVersion that has the format of $GROUP_NAME/$VERSION.
	APIVersion string `yaml:"apiVersion"`
	// Kind is the kubernetes resource kind.
	Kind string `yaml:"kind"`
	// ProjectName is name of the new operator application
	// and is also the name of the base directory.
	ProjectName string `yaml:"projectName"`
}

type Generator

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

func NewGenerator

func NewGenerator(apiVersion, kind, projectName, repoPath string) *Generator

NewGenerator creates a new scaffold Generator.

func (*Generator) Render

func (g *Generator) Render() error

Render generates the default project structure:

├── <projectName> │ ├── cmd │ │ └── <projectName> │ ├── config │ ├── deploy │ ├── pkg │ │ ├── apis │ │ │ └── <api-dir-name> // computed from apiDirName(apiVersion). │ │ │ └── <version> // computed from version(apiVersion). │ │ └── stub │ ├── tmp │ | ├── build │ | └── codegen │ └── version