controller

Documentation

Index

• type ControllerConfig
  • func (cc *ControllerConfig) CheckStructTagMap(object, field, tagKey, expectedTagValue string) bool
  • func (cc *ControllerConfig) ConfigurePullSubscription(g *jen.Group, durable bool, moduleOverride *string)
  • func (cc *ControllerConfig) ExtensionMainPackage(modulePath string) error
  • func (cc *ControllerConfig) ExtensionReconcilers(modulePath string) error
  • func (cc *ControllerConfig) GetLatestObject(g *jen.Group, obj string, moduleOverride *string)
  • func (cc *ControllerConfig) InternalPackage() error
  • func (cc *ControllerConfig) MainPackage() error
  • func (cc *ControllerConfig) ReconcilerFunctions() error
  • func (cc *ControllerConfig) Reconcilers() error
• type ReconciledObject

Types

type ControllerConfig

type ControllerConfig struct {
	// The name of the controller in kebab case, e.g.
	// kubernetes-runtime-controller
	Name string

	// The name of the controller in kebab case sans "-controler", e.g
	// kubernetes-runtime
	ShortName string

	// The name of the controller in lower case, no spaces, e.g.
	// kubernetesruntime
	PackageName string

	// The name of a NATS Jetstream stream for a controller, e.g.
	// KubernetesRuntimeStreamName
	StreamName string

	// The objects for which reconcilers should be generated.
	ReconciledObjects []ReconciledObject

	// The struct values parsed from the controller's model file.
	// The data model can be interpreted as:
	// map[objectName]map[fieldName]map[tagKey]tagValue
	// An example of this data model with a WorkloadDefinition is:
	// map["WorkloadDefinition"]map["YAMLDocument"]map["validate"]"required"
	StructTags map[string]map[string]map[string]string
}

func (*ControllerConfig) CheckStructTagMap

func (cc *ControllerConfig) CheckStructTagMap(
	object,
	field,
	tagKey,
	expectedTagValue string,
) bool

CheckStructTagMap checks if a struct tag map contains a specific value.

func (*ControllerConfig) ConfigurePullSubscription

func (cc *ControllerConfig) ConfigurePullSubscription(g *jen.Group, durable bool, moduleOverride *string)

ConfigurePullSubscription adds a durable consumer to a controller's main package.

func (*ControllerConfig) ExtensionMainPackage

func (cc *ControllerConfig) ExtensionMainPackage(modulePath string) error

ExtensionMainPackage generates the source code for a controller's main package in an extension.

func (*ControllerConfig) ExtensionReconcilers

func (cc *ControllerConfig) ExtensionReconcilers(modulePath string) error

Reconcilers generates the source code for a controller's reconcile functions in an extension.

func (*ControllerConfig) GetLatestObject

func (cc *ControllerConfig) GetLatestObject(g *jen.Group, obj string, moduleOverride *string)

GetLatestObject generates the source code for a controller's reconcile functions to get the latest object if the "persist" field is not present or set to true.

func (*ControllerConfig) InternalPackage

func (cc *ControllerConfig) InternalPackage() error

InternalPackage generates the controller's general internal package source code.

func (*ControllerConfig) MainPackage

func (cc *ControllerConfig) MainPackage() error

MainPackage generates the source code for a controller's main package.

func (*ControllerConfig) ReconcilerFunctions

func (cc *ControllerConfig) ReconcilerFunctions() error

func (*ControllerConfig) Reconcilers

func (cc *ControllerConfig) Reconcilers() error

Reconcilers generates the source code for a controller's reconcile functions.

type ReconciledObject

type ReconciledObject struct {
	Name                           string
	Version                        string
	DisableNotificationPersistence bool
}

ReconciledObject is a struct that contains the name and version of a reconciled object.