examples

package

v2.2.0 Latest Latest Go to latest Published: Nov 5, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

NewGenerator returns a configured Generator

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

Generate generates an example manifest for the specified Terraform resource.

func (eg *Generator) StoreExamples() error

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

type GeneratorOption func(*Generator)

func WithCRDScope(scope tjtypes.CRDScope) GeneratorOption

WithCRDScope sets the CRD scope for the generator.

func WithLocalSecretRefs() GeneratorOption

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

func WithNamespace(ns string) GeneratorOption

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

Path	Synopsis
conversion