Deploying on Kubernetes

Kubernetes(opens in a new tab) “is an open source container orchestration engine for automating deployment, scaling, and management of containerized applications.”

Our recommended way to install Document Engine is via a Helm(opens in a new tab) chart.

For more information, refer to our dedicated guides for setting up Document Engine using Helm and setting up Ingress to make it available.

For guidance on moving from Docker Compose to Helm, refer to the migrating from Docker Compose section of our Helm deployment guide.

We also have public examples(opens in a new tab) for setting up a Kubernetes cluster and installing Document Engine.

Getting Kubernetes

There are many ways to set up Kubernetes, both locally and in the cloud. The following sections outline some of them.

Local Kubernetes

For development and testing, you can run Kubernetes locally on your machine using the tools below.

Docker Desktop

Docker Desktop(opens in a new tab) on macOS, Windows, and Linux includes Kubernetes(opens in a new tab).

OrbStack

OrbStack(opens in a new tab) is a fast, lightweight alternative to Docker Desktop for macOS and Linux that includes native Kubernetes support with minimal resource usage.

MicroK8s

MicroK8s(opens in a new tab) is a lightweight way to run Kubernetes in Linux, even on a single node.

We have an example(opens in a new tab) showing how to deploy a virtual machine with Ubuntu Linux to AWS, set up microk8s on it, and install Document Engine.

Managed Kubernetes services

Many public cloud vendors offer Kubernetes services: