KubernetesIngressService

class gafaelfawr.services.kubernetes.KubernetesIngressService(config, storage, logger)

Bases: object

Manage Ingress resources with Gafaelfawr annotations.

The GafaelfawrIngress custom resource defines a template for an Ingress resource that will be created by this service, with the special annotations and configuration for Gafaelfawr added. It is intended to be driven by Kopf and a thin layer of Kopf event handlers.

Parameters:

• config (Config) – Gafaelfawr configuration.

• storage (KubernetesIngressStorage) – Storage layer for the Kubernetes cluster.

• logger (BoundLogger) – Logger to report issues.

Methods Summary

update(parent)

Handle a change to a GafaelfawrIngress.

Methods Documentation

async update(parent)

Handle a change to a GafaelfawrIngress.

Parameters:

parent (GafaelfawrIngress) – Contents of the GafaelfawrIngress Kubernetes object.

Returns:

Information to put into the status portion of the object, or None if no status update is required.

Return type:

KubernetesResourceStatus or None

Raises:

KubernetesError – Raised if some error occurred while trying to write to Kubernetes.