license

Documentation

Index

• Constants
• type Agent
  • func NewAgent(konnectLicenseClient KonnectLicenseClient, logger logr.Logger, ...) *Agent
  • func (a *Agent) GetLicense() mo.Option[kong.License]
  • func (a *Agent) NeedLeaderElection() bool
  • func (a *Agent) Start(ctx context.Context) error
  • func (a *Agent) Started() <-chan struct{}
• type AgentOpt
  • func WithInitialPollingPeriod(initialPollingPeriod time.Duration) AgentOpt
  • func WithPollingPeriod(regularPollingPeriod time.Duration) AgentOpt
  • func WithTicker(t Ticker) AgentOpt
• type KonnectLicense
• type KonnectLicenseClient
• type Ticker

Constants

const (
	// DefaultPollingPeriod is the period at which the license agent will poll for license updates by default.
	DefaultPollingPeriod = time.Hour * 12

	// DefaultInitialPollingPeriod is the period at which the license agent will poll for a license until it retrieves
	// one.
	DefaultInitialPollingPeriod = time.Minute

	// PollingTimeout is the timeout for retrieving a license from upstream.
	PollingTimeout = time.Minute * 5
)

Types

type Agent

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

Agent handles retrieving a Kong license and providing it to other KIC subsystems.

func NewAgent

func NewAgent(
	konnectLicenseClient KonnectLicenseClient,
	logger logr.Logger,
	opts ...AgentOpt,
) *Agent

NewAgent creates a new license agent that retrieves a license from the given url once every given period.

func (*Agent) GetLicense

func (a *Agent) GetLicense() mo.Option[kong.License]

GetLicense returns the agent's current license as a go-kong License struct. It omits the origin timestamps, as Kong will auto-populate these when adding the license to its config database. It's optional because we may not have retrieved a license yet.

func (*Agent) NeedLeaderElection

func (a *Agent) NeedLeaderElection() bool

NeedLeaderElection indicates if the Agent requires leadership to run. It always returns true.

func (*Agent) Start

func (a *Agent) Start(ctx context.Context) error

Start starts the Agent. It attempts to pull an initial license from upstream, and then polls for updates on a regular period, either the agent's initialPollingPeriod if it has not yet obtained a license or regularPollingPeriod if it has.

func (*Agent) Started

func (a *Agent) Started() <-chan struct{}

Started returns a channel which will be closed when the Agent has started.

type AgentOpt

type AgentOpt func(*Agent)

func WithInitialPollingPeriod

func WithInitialPollingPeriod(initialPollingPeriod time.Duration) AgentOpt

WithInitialPollingPeriod sets the initial polling period for the license agent.

func WithPollingPeriod

func WithPollingPeriod(regularPollingPeriod time.Duration) AgentOpt

WithPollingPeriod sets the regular polling period for the license agent.

func WithTicker

func WithTicker(t Ticker) AgentOpt

WithTicker sets the ticker in Agent. This is useful for testing. Ticker doesn't define the period, it defines the implementation of ticking.

type KonnectLicense

type KonnectLicense struct {
	ID        string
	Payload   string
	UpdatedAt time.Time
}

KonnectLicense is a license retrieved from Konnect.

type KonnectLicenseClient

type KonnectLicenseClient interface {
	Get(ctx context.Context) (mo.Option[KonnectLicense], error)
}

type Ticker

type Ticker interface {
	Stop()
	Channel() <-chan time.Time
	Reset(d time.Duration)
}