status

type ControlPlaneUpdateResult ¶

type ControlPlaneUpdateResult struct {
	// Error is the error that occurred during the update.
	Error error
}

ControlPlaneUpdateResult describes the result of a control plane update.

type GroupUpdater ¶

type GroupUpdater interface {
	UpdateGroup(ctx context.Context, name string, reqs ...UpdateRequest)
}

GroupUpdater updates statuses of groups of resources.

Note: this interface is created so that it that we can create a fake from it and use it in controller/handler_test.go (to avoid import cycles).

type K8sUpdater ¶

type K8sUpdater interface {
	// Update is from client.StatusClient.SubResourceWriter.
	Update(ctx context.Context, obj client.Object, opts ...client.SubResourceUpdateOption) error
}

K8sUpdater updates a resource from the k8s API. It allows us to mock the client.Reader.Status.Update method.

type LeaderAwareGroupUpdater ¶

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

LeaderAwareGroupUpdater updates statuses of groups of resources. Before it is enabled, it saves all requests. When it is enabled, it updates status using the saved requests. Note: it can only be enabled once. After it is enabled, it will not save requests anymore and update statuses immediately.

func NewLeaderAwareGroupUpdater(updater *Updater) *LeaderAwareGroupUpdater

func (u *LeaderAwareGroupUpdater) Enable(ctx context.Context)

func (u *LeaderAwareGroupUpdater) UpdateGroup(ctx context.Context, name string, reqs ...UpdateRequest)

type Queue ¶

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

Queue represents a queue with unlimited size.

func NewQueue() *Queue

func (q *Queue) Dequeue(ctx context.Context) *QueueObject

func (q *Queue) Enqueue(item *QueueObject)

type QueueObject ¶

type QueueObject struct {
	// GatewayService is the Gateway Service that was updated. When set, UpdateType should be UpdateGateway.
	// Set by the provisioner
	GatewayService *corev1.Service
	Error          error
	Deployment     types.NamespacedName
	UpdateType     UpdateType
}

QueueObject is the object to be passed to the queue for status updates.

type Setter ¶

type Setter func(client.Object) (wasSet bool)

Setter is a function that sets the status of the passed resource. It returns true if the status was set, false otherwise. The status is not set when the status is already up-to-date.

type UpdateRequest ¶

type UpdateRequest struct {
	ResourceType ngftypes.ObjectType
	Setter       Setter
	NsName       types.NamespacedName
}

UpdateRequest is a request to update the status of a resource.

func PrepareBackendTLSPolicyRequests(
	policies map[types.NamespacedName]*graph.BackendTLSPolicy,
	transitionTime metav1.Time,
	gatewayCtlrName string,
) []UpdateRequest

func PrepareGatewayClassRequests(
	gc *graph.GatewayClass,
	ignoredGwClasses map[types.NamespacedName]*v1.GatewayClass,
	transitionTime metav1.Time,
) []UpdateRequest

func PrepareGatewayRequests(
	gateway *graph.Gateway,
	transitionTime metav1.Time,
	gwAddresses []v1.GatewayStatusAddress,
	nginxReloadRes graph.NginxReloadResult,
) []UpdateRequest

func PrepareNGFPolicyRequests(
	policies map[graph.PolicyKey]*graph.Policy,
	transitionTime metav1.Time,
	gatewayCtlrName string,
) []UpdateRequest

func PrepareNginxGatewayStatus(
	nginxGateway *ngfAPI.NginxGateway,
	transitionTime metav1.Time,
	cpUpdateRes ControlPlaneUpdateResult,
) *UpdateRequest

func PrepareRouteRequests(
	l4routes map[graph.L4RouteKey]*graph.L4Route,
	routes map[graph.RouteKey]*graph.L7Route,
	transitionTime metav1.Time,
	gatewayCtlrName string,
) []UpdateRequest

func PrepareSnippetsFilterRequests(
	snippetsFilters map[types.NamespacedName]*graph.SnippetsFilter,
	transitionTime metav1.Time,
	gatewayCtlrName string,
) []UpdateRequest

type UpdateType ¶

type UpdateType int

UpdateType is the type of status update to perform.

type Updater ¶

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

Updater updates the status of resources.

It has the following limitations:

(1) It is synchronous, which means the status reporter can slow down the event loop. Consider the following cases: (a) Sometimes the Gateway will need to update statuses of all resources it handles, which could be ~1000. Making 1000 status API calls sequentially will take time. (b) k8s API can become slow or even timeout. This will increase every update status API call. Making Updater asynchronous will prevent it from adding variable delays to the event loop. FIXME(pleshakov): https://github.com/nginx/nginx-gateway-fabric/issues/1014

(2) It doesn't clear the statuses of a resources that are no longer handled by the Gateway. For example, if an HTTPRoute resource no longer has the parentRef to the Gateway resources, the Gateway must update the status of the resource to remove the status about the removed parentRef. FIXME(pleshakov): https://github.com/nginx/nginx-gateway-fabric/issues/1015

(3) If another controllers changes the status of the Gateway/HTTPRoute resource so that the information set by our Gateway is removed, our Gateway will not restore the status until the EventLoop invokes the StatusUpdater as a result of processing some other new change to a resource(s). FIXME(pleshakov): https://github.com/nginx/nginx-gateway-fabric/issues/1813

func NewUpdater(c client.Client, logger logr.Logger) *Updater

func (u *Updater) Update(ctx context.Context, reqs ...UpdateRequest)