leafcontroller

Documentation

Index

• Constants
• type Controller
  • func NewController(opts *Options) *Controller
  • func (c *Controller) Run(ctx context.Context) error
  • func (c *Controller) SetupSignalHandler(ctx context.Context)
  • func (c *Controller) Shutdown()
• type Options

Constants

const (
	DiscoverSubject       = "_SAT.discover"
	StatusSubject         = "_SAT.%s.status"
	ConfigGetSubject      = "_SAT.%s.config.get"
	ConfigUpdateSubject   = "_SAT.%s.config.put"
	DefaultQueueGroupName = "controllers"
)

const Version = "0.1.0"

Types

type Controller

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

Controller manages NATS Leaf node clusters running in Kubernetes.

func NewController

func NewController(opts *Options) *Controller

NewController creats a new Controller.

func (*Controller) Run

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

Run starts the controller.

func (*Controller) SetupSignalHandler

func (c *Controller) SetupSignalHandler(ctx context.Context)

SetupSignalHandler enables handling process signals.

func (*Controller) Shutdown

func (c *Controller) Shutdown()

Shutdown stops the operator controller.

type Options

type Options struct {
	// ClusterName is the NATS cluster name.
	ClusterName string

	// NoSignals marks whether to enable the signal handler.
	NoSignals bool

	// NatsServerURL is the address of the ground NATS Server.
	NatsServerURL string

	// LeafRemoteCredentials are the auth keys for the NATS Leaf Server.
	NatsCredentials string

	// ConfigMapName is the config for this NATS Cluster that will be managed.
	ConfigMapName string

	// PodNamespace is the namespace where this controller is running.
	PodNamespace string
}

Options are the options for the controller.