Bahriya Tersane

Running Tersane without BKE

Tersane may be licensed on its own, for any conformant Kubernetes distribution. The charts ship with the defaults of the Bahriya Kubernetes Engine, so on another distribution some components must be supplied, or some defaults changed, before the charts install and behave as documented. This page lists each of them.

Running Tersane this way calls for experience with Kubernetes and with the components below. Organisations that prefer not to take that on can engage Mamluk for Kubernetes consulting or support.

What the charts expect

Calico is BKE’s network fabric and is always present. Kong, Longhorn and cert-manager are BKE components, each enabled per cluster; on a BKE cluster, enable the ones the charts you install depend on.

Expectation Provided by BKE Charts affected By default
Calico with its API server, for projectcalico.org/v3 NetworkPolicy Yes, always: it is BKE’s network fabric mysql, valkey, memcached On for mysql and valkey; off for memcached; each can be turned off
A StorageClass named longhorn Yes, when Longhorn is enabled mysql, valkey The default class for their volumes; any class can be set
A StorageClass named longhorn Yes, when Longhorn is enabled The persistent volumes khadim and safeena can attach to an application None are attached by default; when they are, the class is always longhorn and is not yet a setting
Longhorn itself Yes, when Longhorn is enabled mysql Only for volume encryption and volume snapshots, both off by default
An ingress controller, of IngressClass kong by default Yes, when Kong is enabled safeena; keycloak when its ingress is enabled The class is a setting in each chart’s values
The Kong ingress controller itself Yes, when Kong is enabled safeena’s Kong features; mysql’s web client; external access to mysql and valkey All off by default, except safeena’s redirection to HTTPS
cert-manager Yes, when cert-manager is enabled safeena; mysql when its web client is enabled Only when certificates are requested
Outbound access to ClamAV’s signature servers Not a cluster component clamav On; can be turned off
The image credential for 1x.ax Not a cluster component Every chart Always

Calico

The mysql, valkey and memcached charts render their NetworkPolicy as a Calico projectcalico.org/v3 resource, which is served by Calico’s API server. On a cluster without it, that resource type does not exist, and an installation with the policy enabled fails. Either install Calico with its API server, or turn the chart’s policy off and apply your own policy for the release:

networkPolicy:
  enabled: false

The policy is enabled by default in mysql and valkey, and disabled in memcached. These charts do not offer a standard Kubernetes NetworkPolicy in place of the Calico resource. Whether a cluster’s own network policy implementation serves Calico’s resources varies by distribution and configuration, so check it before installing.

The keycloak chart’s policy is a standard Kubernetes NetworkPolicy, enabled by default, and needs no Calico.

Storage

The mysql and valkey charts default to a StorageClass named longhorn. On a cluster without one, the volumes are never bound and the pods stay Pending. Name a ReadWriteOnce class your cluster provides:

# mysql
storage:
  data:
    storageClass: "<your class>"
  binlog:
    storageClass: "<your class>"
# valkey
storage:
  storageClass: "<your class>"

Two mysql features depend on Longhorn itself rather than on the class name: volume encryption (encryption.volume), which creates a Longhorn StorageClass with LUKS parameters, and volume snapshots (pitr.volumeSnapshots), which create Longhorn RecurringJobs. Both are off by default. Without Longhorn, leave them off and use your storage platform’s own encryption and snapshots.

The clamav chart keeps its signature database on a volume of your cluster’s default StorageClass, unless persistence.storageClass names another.

One exception is not yet a setting. The khadim and safeena charts can attach persistent volumes to an application, through persistentVolumes, which is empty by default. Those volumes always request the class longhorn. To use them on another distribution, provide a StorageClass with that name.

The storage class is fixed when a release is installed; see Upgrading a chart.

Kong

The safeena chart publishes your application through a standard Ingress of the class set in ingress.className, which is kong by default. Any ingress controller can serve it. Under another controller, the chart’s redirection from HTTP to HTTPS, which is on by default, is not applied, because it is set by Kong annotations that other controllers ignore.

The chart’s basic authentication, rate limiting, IP restriction, response caching and redirection from www, including those set per path, are Kong resources such as KongPlugin. On a cluster without Kong’s CustomResourceDefinitions, an installation that enables any of them fails. All are off by default. Install the Kong ingress controller to use them.

The mysql chart’s web client also needs Kong: the IP allowlist the chart requires for it is a KongPlugin. External access to mysql and to valkey (exposure.external) is a Kong TCPIngress. All three are off by default.

The keycloak chart’s ingress, also off by default, is a standard Ingress of the class set in ingress.ingressClassName, and uses no Kong resources.

cert-manager

The safeena chart issues certificates through cert-manager Certificate resources, one per entry in its certificates list, each naming a ClusterIssuer in your cluster. The list is empty by default. The mysql chart’s web client requests its certificate from cert-manager when it is enabled, from the ClusterIssuer named in client.ingress.certIssuer, which is letsencrypt-prod by default. Install cert-manager, with a ClusterIssuer of your choosing, before using either, and name that issuer in the chart’s values.

The certificates the mysql and valkey charts use for their own in-cluster TLS are generated by the charts and do not need cert-manager.

ClamAV signatures

The clamav chart runs ClamAV’s signature updater, which downloads new virus signatures from ClamAV’s publisher, so the cluster needs outbound access to it. On a network with no route to the internet, turn the updater off:

extraEnv:
  - name: CLAMAV_NO_FRESHCLAMD
    value: "true"

The chart has no setting for a signature mirror of your own, so the signatures are then not updated.

Images

Every image the charts supply is pulled from 1x.ax with your organisation’s image credential, whatever the distribution. That includes the upstream software the charts run, which Mamluk copies there unchanged. Your organisation may instead copy the images into a registry of its own, for its own licensed use, including on a network with no route to the internet. See Access and credentials.

Other distributions

Running Tersane on Amazon EKS, Azure AKS, Google GKE and other distributions is covered in the questions and answers.