configset_controller

Documentation

Index

• Constants
• Variables
• type Config
  • func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
  • func (m *Config) CloneVT() *Config
  • func (this *Config) EqualMessageVT(thatMsg any) bool
  • func (this *Config) EqualVT(that *Config) bool
  • func (c *Config) EqualsConfig(oc config.Config) bool
  • func (c *Config) GetConfigID() string
  • func (x *Config) MarshalJSON() ([]byte, error)
  • func (x *Config) MarshalProtoJSON(s *json.MarshalState)
  • func (x *Config) MarshalProtoText() string
  • func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Config) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Config) MarshalVT() (dAtA []byte, err error)
  • func (*Config) ProtoMessage()
  • func (x *Config) Reset()
  • func (m *Config) SizeVT() (n int)
  • func (x *Config) String() string
  • func (x *Config) UnmarshalJSON(b []byte) error
  • func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
  • func (m *Config) UnmarshalVT(dAtA []byte) error
  • func (c *Config) Validate() error
• type Controller
  • func NewController(le *logrus.Entry, bus bus.Bus) (*Controller, error)
  • func (c *Controller) AddConfigSetReference(ctx context.Context, key string) (configset.Reference, error)
  • func (c *Controller) Close() error
  • func (c *Controller) Execute(ctx context.Context) error
  • func (c *Controller) GetControllerInfo() *controller.Info
  • func (c *Controller) HandleDirective(ctx context.Context, di directive.Instance) ([]directive.Resolver, error)
  • func (c *Controller) PushControllerConfig(ctx context.Context, key string, conf configset.ControllerConfig) (configset.Reference, error)
• type Factory
  • func NewFactory(bus bus.Bus) *Factory
  • func (t *Factory) Construct(ctx context.Context, conf config.Config, opts controller.ConstructOpts) (controller.Controller, error)
  • func (t *Factory) ConstructConfig() config.Config
  • func (t *Factory) GetConfigID() string
  • func (t *Factory) GetControllerID() string
  • func (t *Factory) GetVersion() semver.Version

Constants

const ConfigID = ControllerID

ConfigID is the identifier for the config type.

const ControllerID = "controllerbus/configset"

ControllerID is the ID of the controller.

Variables

var Version = semver.MustParse("0.0.1")

Version is the version of the controller implementation.

Types

type Config

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

Config is the configset controller configuration.

func (*Config) CloneMessageVT

func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage

func (*Config) CloneVT

func (m *Config) CloneVT() *Config

func (*Config) EqualMessageVT

func (this *Config) EqualMessageVT(thatMsg any) bool

func (*Config) EqualVT

func (this *Config) EqualVT(that *Config) bool

func (*Config) EqualsConfig

func (c *Config) EqualsConfig(oc config.Config) bool

EqualsConfig checks equality between two configs.

func (*Config) GetConfigID

func (c *Config) GetConfigID() string

GetConfigID returns the config identifier.

func (*Config) MarshalJSON

func (x *Config) MarshalJSON() ([]byte, error)

MarshalJSON marshals the Config to JSON.

func (*Config) MarshalProtoJSON

func (x *Config) MarshalProtoJSON(s *json.MarshalState)

MarshalProtoJSON marshals the Config message to JSON.

func (*Config) MarshalProtoText

func (x *Config) MarshalProtoText() string

func (*Config) MarshalToSizedBufferVT

func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Config) MarshalToVT

func (m *Config) MarshalToVT(dAtA []byte) (int, error)

func (*Config) MarshalVT

func (m *Config) MarshalVT() (dAtA []byte, err error)

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (x *Config) Reset()

func (*Config) SizeVT

func (m *Config) SizeVT() (n int)

func (*Config) String

func (x *Config) String() string

func (*Config) UnmarshalJSON

func (x *Config) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals the Config from JSON.

func (*Config) UnmarshalProtoJSON

func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)

UnmarshalProtoJSON unmarshals the Config message from JSON.

func (*Config) UnmarshalVT

func (m *Config) UnmarshalVT(dAtA []byte) error

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type Controller

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

Controller is the ConfigSet controller.

func NewController

func NewController(le *logrus.Entry, bus bus.Bus) (*Controller, error)

NewController constructs a new peer controller. If privKey is nil, one will be generated.

func (*Controller) AddConfigSetReference

func (c *Controller) AddConfigSetReference(
	ctx context.Context,
	key string,
) (configset.Reference, error)

AddConfigSetReference adds a persistent reference to a config set which will be re-applied across iterations. This reference type will wait until a ApplyConfigSet specifies the configuration for the controller, and will add to the reference count for the controller such that the controller will continue to execute after the ApplyConfigSet call exits.

func (*Controller) Close

func (c *Controller) Close() error

Close releases any resources used by the controller. Error indicates any issue encountered releasing.

func (*Controller) Execute

func (c *Controller) Execute(ctx context.Context) error

Execute executes the given controller. Returning nil ends execution. Returning an error triggers a retry with backoff.

func (*Controller) GetControllerInfo

func (c *Controller) GetControllerInfo() *controller.Info

GetControllerInfo returns information about the controller.

func (*Controller) HandleDirective

func (c *Controller) HandleDirective(
	ctx context.Context,
	di directive.Instance,
) ([]directive.Resolver, error)

HandleDirective asks if the handler can resolve the directive. If it can, it returns a resolver. If not, returns nil. Any unexpected errors are returned for logging. It is safe to add a reference to the directive during this call.

func (*Controller) PushControllerConfig

func (c *Controller) PushControllerConfig(
	ctx context.Context,
	key string,
	conf configset.ControllerConfig,
) (configset.Reference, error)

PushControllerConfig pushes a controller configuration for a given key, if the version is newer. Returns a reference to the configset, or an error.

type Factory

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

Factory constructs a configset controller.

func NewFactory

func NewFactory(bus bus.Bus) *Factory

NewFactory builds a configset controller factory.

func (*Factory) Construct

func (t *Factory) Construct(
	ctx context.Context,
	conf config.Config,
	opts controller.ConstructOpts,
) (controller.Controller, error)

Construct constructs the associated controller given configuration.

func (*Factory) ConstructConfig

func (t *Factory) ConstructConfig() config.Config

ConstructConfig constructs an instance of the controller configuration.

func (*Factory) GetConfigID

func (t *Factory) GetConfigID() string

GetConfigID returns the configuration ID for the controller.

func (*Factory) GetControllerID

func (t *Factory) GetControllerID() string

GetControllerID returns the unique ID for the controller.

func (*Factory) GetVersion

func (t *Factory) GetVersion() semver.Version

GetVersion returns the version of this controller.