examples

Documentation

Index

• type Generator
  • func NewGenerator(rootDir, modulePath, shortName string, ...) *Generator
  • func (eg *Generator) Generate(group, version string, r *config.Resource) error
  • func (eg *Generator) StoreExamples() error

Types

type Generator

type Generator struct {
	reference.Injector
	// contains filtered or unexported fields
}

Generator represents a pipeline for generating example manifests. Generates example manifests for Terraform resources under examples-generated.

func NewGenerator

func NewGenerator(rootDir, modulePath, shortName string, configResources map[string]*config.Resource) *Generator

NewGenerator returns a configured Generator

func (*Generator) Generate

func (eg *Generator) Generate(group, version string, r *config.Resource) error

Generate generates an example manifest for the specified Terraform resource.

func (*Generator) StoreExamples

func (eg *Generator) StoreExamples() error

StoreExamples stores the generated example manifests under examples-generated in their respective API groups.