status

Documentation

Index

• Constants
• type Clock
• type RealClock
  • func NewRealClock() *RealClock
  • func (c *RealClock) Now() metav1.Time
• type Updater
  • func NewUpdater(cfg UpdaterConfig) Updater
• type UpdaterConfig

Constants

const (
	// GetawayReasonGatewayConflict indicates there are multiple Gateway resources for NGINX Gateway to choose from,
	// and NGINX Gateway ignored the resource in question and picked another Gateway as the winner.
	// NGINX Gateway will use this reason with GatewayConditionReady (false).
	GetawayReasonGatewayConflict v1beta1.GatewayConditionReason = "GatewayConflict"

	// GatewayMessageGatewayConflict is message that describes GetawayReasonGatewayConflict.
	GatewayMessageGatewayConflict = "The resource is ignored due to a conflicting Gateway resource"
)

Types

type Clock

type Clock interface {
	Now() metav1.Time
}

Clock returns the current local time.

type RealClock

type RealClock struct{}

Real clock returns the current local time.

func NewRealClock

func NewRealClock() *RealClock

NewRealClock creates a new RealClock.

func (*RealClock) Now

func (c *RealClock) Now() metav1.Time

Now returns the current local time.

type Updater

type Updater interface {
	// Update updates the statuses of the resources.
	Update(context.Context, state.Statuses)
}

Updater updates statuses of the Gateway API resources.

func NewUpdater

func NewUpdater(cfg UpdaterConfig) Updater

NewUpdater creates a new Updater.

type UpdaterConfig

type UpdaterConfig struct {
	// Client is a Kubernetes API client.
	Client client.Client
	// Clock is used as a source of time for the LastTransitionTime field in Conditions in resource statuses.
	Clock Clock
	// Logger holds a logger to be used.
	Logger logr.Logger
	// GatewayCtlrName is the name of the Gateway controller.
	GatewayCtlrName string
	// GatewayClassName is the name of the GatewayClass resource.
	GatewayClassName string
}

UpdaterConfig holds configuration parameters for Updater.