Bahriya Tersane

Sipar, the gateway and the mesh

Sipar is Mamluk’s traffic layer for Kubernetes. It has two parts:

  • Sipar Gateway receives traffic from outside the cluster and routes it to applications. It handles HTTP, TCP and TLS, and applies rate limits, a response cache, access control by client address for TCP services, a request identifier on every response and a JSON access log line for every request.
  • Sipar Mesh secures traffic between services inside the cluster. Every workload receives a cryptographic identity, and traffic between services in an enrolled namespace is encrypted with mutual TLS.

Both are built on projects of the Cloud Native Computing Foundation, which are used unmodified: Envoy Gateway and the Kubernetes Gateway API for the gateway, and Istio’s ambient mode for the mesh. Sipar’s own code runs only at the extension points those projects publish.

Obtaining Sipar

Sipar is included with every Bahriya Kubernetes Engine licence, and is installed and upgraded with the cluster as one of its components. On any other conformant Kubernetes distribution, Sipar Gateway is installed from the Tersane chart repository, and is part of the Tersane licence at no extra price.

Sipar’s container images are private. They are pulled from 1x.ax with the image token your licence provides, held in the cluster as an image pull Secret, as described in Gaining access.

Sipar Gateway

Sipar Gateway is two charts, one for the cluster and one for each application.

Chart Installed What it does
sipar-gateway Once per cluster, by the platform team Installs Envoy Gateway and Sipar’s extensions: access control by address for TCP, the response cache, and the proxy defaults (two replicas on separate nodes, the filter order, the access log). Optionally creates the GatewayClass and the Gateway’s client traffic policy.
sipar-route Inside each application’s own chart, as a dependency A library chart. It writes the application’s routes and policies into the application’s namespace: HTTP routes, TLS passthrough by hostname, cached routes, rate limits and TCP address rules. It installs nothing by itself.

The division keeps each team within its own scope. The platform team owns the gateway and its defaults; an application’s chart declares only the routes and policies for that application, in its own namespace, and is refused at install if a setting is misspelt or invalid. Any chart, including one your own team writes, can add sipar-route as a dependency.

The order of installation

  1. Apply the Gateway API and Envoy Gateway CRDs with the script that sipar-gateway carries. Kubernetes cannot hold these CRDs in a Helm release, so the chart does not install them. Run the script again before every upgrade.
  2. Install sipar-gateway once, in envoy-gateway-system.
  3. Create the Gateway, or let BKE create it.
  4. Install or upgrade each application with its sipar-route settings.

On the Bahriya Kubernetes Engine, steps 1 to 3 are part of the cluster’s installation and upgrade, and only step 4 is yours.

The sipar-gateway chart’s own documentation, with its requirements, every setting and the stores the cache and rate limits use, is published here with the chart.

Sipar Mesh

Sipar Mesh is available with the Bahriya Kubernetes Engine. It is off unless the cluster’s configuration enables it, and enabling it changes nothing until a namespace is enrolled.

  • Enrolment is per namespace. Workloads in an enrolled namespace receive an identity and communicate over mutual TLS. No proxy runs beside each application, and applications need no change.
  • Sipar Gateway is the mesh’s default entry point. Traffic from the gateway reaches enrolled workloads over the mesh’s encrypted transport.
  • Rules based on the calling service are enforced by a mesh proxy that a Service opts into, so the services that need such rules carry that cost and others do not.
  • Removal is supported. A namespace can be withdrawn from the mesh, and the mesh can be disabled, without reinstalling the applications.

How to enable the mesh, enrol a namespace and remove it is documented with the Bahriya Kubernetes Engine, at bke.bahriya.cloud, because the mesh is installed and upgraded with the cluster.

Support

Sipar is supported by Mamluk under the licence that provides it: the Bahriya Kubernetes Engine licence, or the Tersane licence. To raise a ticket, use the Mamluk console.