operator

Documentation

Index

• Constants
• func NewInformer(c *Controller, resourceFuncs k8scache.ResourceEventHandlerFuncs, ...) (k8scache.Indexer, k8scache.Controller)
• type Controller
  • func NewController(opts *Options) *Controller
  • func (c *Controller) Run(ctx context.Context) error
  • func (c *Controller) SetupClients(cfg *k8srestapi.Config) error
  • func (c *Controller) SetupSignalHandler(ctx context.Context)
  • func (c *Controller) Shutdown()
• type Options

Constants

const (
	// Version is the version of the NATS Streaming Operator.
	Version = "0.4.0"

	// DefaultNATSStreamingImage is the default image
	// of NATS Streaming that will be used, meant to be
	// the latest release available.
	DefaultNATSStreamingImage = "nats-streaming:0.18.0"

	// DefaultNATSStreamingClusterSize is the default size
	// for the cluster.  Clustering is done via Raft so
	// an odd number of pods is recommended.
	DefaultNATSStreamingClusterSize = 3

	// ResyncPeriod is how often the operator will be checking the resources.
	ResyncPeriod = 5 * time.Second

	// MonitoringPort is the port for the server monitoring endpoint.
	MonitoringPort = 8222
)

Functions

func NewInformer

func NewInformer(
	c *Controller,
	resourceFuncs k8scache.ResourceEventHandlerFuncs,
	interval time.Duration,
) (k8scache.Indexer, k8scache.Controller)

NewInformer takes a controller and a set of resource handlers and returns an indexer and a controller that are subscribed to changes to the state of a NATS cluster resource.

Types

type Controller

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

Controller manages NATS Clusters running in Kubernetes.

func NewController

func NewController(opts *Options) *Controller

func (*Controller) Run

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

Run starts the NATS Streaming operator controller loop.

func (*Controller) SetupClients

func (c *Controller) SetupClients(cfg *k8srestapi.Config) error

SetupClients takes the configuration and prepares the rest clients that will be used to interact with the cluster objects.

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 {
	// Namespace where the NATS Streaming Operator will
	// be managing the clusters.
	Namespace string

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

Options for the operator.