crate.operator.exposure module

class crate.operator.exposure.ChangeExposureSubHandler(namespace, name, ref, context, depends_on=None, run_on_dep_failures=False, operation=None)

Bases: StateBasedSubHandler

Handles changes to spec.cluster.exposure between ‘loadbalancer’ and ‘traefik’. Deletes old resources and creates new ones accordingly.

Parameters:

• namespace (str)

• name (str)

• ref (str)

• context (dict)

• operation (Optional[OperationType])

async handle(namespace, name, body, old, logger, **kwargs)

Parameters:

• namespace (str)

• name (str)

• body (Body)

• old (Body)

• logger (Logger)

• kwargs (Any)

class crate.operator.exposure.CreateTraefikResourcesSubHandler(namespace, name, ref, context, depends_on=None, run_on_dep_failures=False, operation=None)

Bases: StateBasedSubHandler

Creates Traefik resources during cluster creation.

Parameters:

• namespace (str)

• name (str)

• ref (str)

• context (dict)

• operation (Optional[OperationType])

async handle(namespace, name, owner_references, dns_record, source_ranges, http_port, postgres_port, logger, **kwargs)

Parameters:

• namespace (str)

• name (str)

• owner_references (Optional[List[V1OwnerReference]])

• dns_record (Optional[str])

• source_ranges (Optional[List[str]])

• http_port (int)

• postgres_port (int)

• logger (Logger)

• kwargs (Any)

async crate.operator.exposure.create_traefik_resources(owner_references, namespace, name, dns_record, source_ranges, http_port, postgres_port, logger)

Create MiddlewareTCP and IngressRouteTCP resources for Traefik exposure.

If source_ranges is non‑empty, a MiddlewareTCP with IP allowlist is created and referenced in the IngressRouteTCP routes. Otherwise, the IngressRouteTCP routes are created without any middleware (no IP restriction).

Parameters:

• owner_references (Optional[List[V1OwnerReference]]) – Owner references to set on the created resources.

• namespace (str) – Kubernetes namespace where the resources will be created.

• name (str) – Name of the CrateDB cluster (used in resource names).

• dns_record (Optional[str]) – External DNS hostname.

• source_ranges (Optional[List[str]]) – List of CIDR ranges for IP allowlist.

• http_port (int) – Port number for HTTP traffic (default 4200).

• postgres_port (int) – Port number for PostgreSQL traffic (default 5432).

• logger (Logger) – Logger for operation tracking.

Return type:

None

async crate.operator.exposure.delete_ingress_route_tcps(namespace, name, logger)

Delete only the IngressRouteTCP resources (keep middleware if any).

This is used when updating CIDRs from empty to non‑empty, to recreate the ingress routes with the new middleware reference.

Parameters:

• namespace (str) – Kubernetes namespace where the resources reside.

• name (str) – Name of the CrateDB cluster.

• logger (Logger) – Logger for operation tracking.

Return type:

None

async crate.operator.exposure.delete_middleware_tcp(namespace, name, logger)

Delete only the MiddlewareTCP resource.

Parameters:

• namespace (str) – Kubernetes namespace where the resource resides.

• name (str) – Name of the CrateDB cluster.

• logger (Logger) – Logger for operation tracking.

Return type:

None

async crate.operator.exposure.delete_service(core, namespace, name)

Delete the main data service (crate-<name>).

Parameters:

• core (CoreV1Api) – Kubernetes CoreV1Api client.

• namespace (str) – Kubernetes namespace where the service resides.

• name (str) – Name of the CrateDB cluster.

• logger – Logger for operation tracking.

Return type:

None

async crate.operator.exposure.delete_traefik_resources(namespace, name)

Delete all Traefik resources owned by this CrateDB cluster.

Deletes the MiddlewareTCP and both IngressRouteTCP resources.

Parameters:

• namespace (str) – Kubernetes namespace where the resources reside.

• name (str) – Name of the CrateDB cluster.

• logger – Logger for operation tracking.

Return type:

None

async crate.operator.exposure.patch_service_exposure(core, namespace, name, new_exposure, source_ranges, dns_record, additional_annotations, logger)

Patch the existing crate-<name> service in-place to switch between LoadBalancer and ClusterIP.

Parameters:

• core (CoreV1Api)

• namespace (str)

• name (str)

• new_exposure (str)

• source_ranges (Optional[List[str]])

• dns_record (Optional[str])

• additional_annotations (Optional[dict])

• logger (Logger)

Return type:

None

async crate.operator.exposure.update_traefik_ip_restriction(namespace, name, new_cidrs, logger)

Create, patch, or delete Traefik MiddlewareTCP based on new CIDRs. Also ensures IngressRouteTCPs reference the middleware if it exists.

Handles four cases: - non‑empty -> non‑empty: patch existing middleware. - non‑empty -> empty: delete middleware and remove reference from ingress routes. - empty -> non‑empty: create middleware and recreate ingress routes to reference it. - empty -> empty: do nothing.

Parameters:

• namespace (str) – Kubernetes namespace where the resources reside.

• name (str) – Name of the CrateDB cluster.

• new_cidrs (List[str]) – New list of CIDR ranges (may be empty).

• logger (Logger) – Logger for operation tracking.

Return type:

None