examples

Documentation

Index

• type Generator
  • func NewGenerator(exampleDir, apisModulePath, shortName string, ...) *Generator
  • func (eg *Generator) Generate(group, version string, r *config.Resource) error
  • func (eg *Generator) StoreExamples() error
• type GeneratorOption
  • func WithCRDScope(scope tjtypes.CRDScope) GeneratorOption
  • func WithLocalSecretRefs() GeneratorOption
  • func WithNamespace(ns string) GeneratorOption

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(exampleDir, apisModulePath, shortName string, configResources map[string]*config.Resource, opts ...GeneratorOption) *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.

type GeneratorOption

type GeneratorOption func(*Generator)

func WithCRDScope

func WithCRDScope(scope tjtypes.CRDScope) GeneratorOption

WithCRDScope sets the CRD scope for the generator.

func WithLocalSecretRefs

func WithLocalSecretRefs() GeneratorOption

WithLocalSecretRefs configures the example generator to generate examples with local secret references, i.e. no namespace specified.

func WithNamespace

func WithNamespace(ns string) GeneratorOption

WithNamespace configures the example generator to generate example manifests with the specified namespace.