Skip to main content

Requirements

Kubernetes or Openshift​

It is recommended to have a maintained version that is either actively supported or has maintenance support. Older versions may work but it is not safe operating Kubernetes versions that are unsupported.

You can check active releases here.

Similar to Kubernetes an actively supported version of Openshift or OKD is acceptable.

Harbor and Shipwright​

Renku can host and build images for users. This is an optional but incredibly useful feature therefore it is strongly recommended that you install both of these projects in your cluster before installing Renku.

Links to each project:

We recommend installing both via their respective Helm charts.

Storage​

You should have a container storage interface (CSI) driver which supports dynamic volume provisioning. If you use managed Kubernetes on any public cloud you will most likely get this out of the box. Dynamic volume provisioning allows the storage driver to create volumes from persistent volume claims (PVC).

To find out if you have dynamic volume provisioning you can run the following command:

kubectl get storageclass

This should return at least one storage class, if nothing is returned it means that you do not have a storage driver in your cluster that supports dynamic volume provisioning.

note

The csi-rclone storage class should not be used for provisioning storage for sessions. It is used by Renku to mount data connectors with data hosted on cloud storage. But its performance is not sufficient to host the local filesystem for a session.

Ingress​

You should have a functioning ingress controller in your cluster. If you use managed Kubernetes on public cloud then your cloud provider can provide more information on whether one is there "out-of-the-box" or you have to install one. On managed Kubernetes the specific cloud provider will likely have documentation on which ingress controller you should use and how to install it.

If you are free to choose then we have used ingress-nginx in production without any problems. But there are many others in addition to ingress-nginx.

TLS certificates​

We use cert-manager in production combined with Let's Encrypt/ACME which allows us to get TLS certificates provisioned and renewed automatically.

However, there are many alternatives to Let's Encrypt and ACME (some requiring more manual intervention than others) which are also acceptable.

Local CLI and similar useful tools​

In addition to this we strongly recommend a Gitops approach to managing Renku in production. We use flux in production for this purpose but there are several other alternatives.

Other tools for operation and monitoring that are not mandatory but really useful: