Installation, step by step

To install OpenLM Platform, do the steps in order. Each step ends with a Check box: don't go on until the check passes. If a check fails, the step's page tells you what to look at, and Troubleshooting covers the rest.

Before step 1, fill in the installation worksheet. Every command in the steps expects its variables to be loaded:

source ./openlm-install.env

The following table shows what you do in each step and what you end up with:

Step	You do	You end up with
1. Prepare the cluster	Create the namespace, check storage and ingress, create the DNS name	A namespace openlm, a DNS name that points at your ingress
2. Prepare data services	Create 4 SQL databases, check MongoDB, Kafka, and Redis	Empty databases and reachable services
3. Create the secrets	Run one script	About 20 Kubernetes Secrets with your connection details, plus the TLS secret
4. Write your values file	Fill in one template	openlm-values.yaml
5. Install the API gateway	One helm install	The openlm-gateway release
6. Install the platform	One helm install	The openlm-platform release, about 85 pods
7. Verify	Run the checks	Proof that sign-in, the API, and the UIs work
8. First sign-in	Sign in, upload the license, activate products	OpenLM Platform ready for your users

Cluster type

Certain steps differ slightly between EKS, AKS, OpenShift, and K3s. Where they do, the step tells you, and the page for your platform has the details: EKS, AKS, OpenShift, K3s. Read your platform page before step 1.