reconciler

Documentation

Overview

Package reconciler describes a Reconciler for working with Viewer CRDs. The reconciler takes care of the main logic for ensuring every Viewer CRD corresponds to a unique deployment and backing service. The service is annotated such that it is compatible with Ambassador managed routing. Currently, only supports Tensorboard viewers. Adding a new viewer CRD for tensorboard with the name 'abc123' will result in the tensorboard instance serving under the path '/tensorboard/abc123'.

Index

• type Options
• type Reconciler
  • func New(cli client.Client, scheme *runtime.Scheme, opts *Options) (*Reconciler, error)
  • func (r *Reconciler) Reconcile(req reconcile.Request) (reconcile.Result, error)

Types

type Options

type Options struct {
	// MaxNumViewers sets an upper bound on the number of viewer instances allowed.
	// When a user attempts to create one more viewer than this number, the oldest
	// existing viewer will be deleted.
	MaxNumViewers int
}

Options are the set of options to configure the behaviour of Reconciler.

type Reconciler

type Reconciler struct {
	client.Client
	// contains filtered or unexported fields
}

Reconciler implements reconcile.Reconciler for the Viewer CRD.

func New

func New(cli client.Client, scheme *runtime.Scheme, opts *Options) (*Reconciler, error)

New returns a new Reconciler.

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(req reconcile.Request) (reconcile.Result, error)

Reconcile runs the main logic for reconciling the state of a viewer with a corresponding deployment and service allowing users to access the view under a specific path.