Skip to main content

Kubernetes and OpenShift (Helm)

To install OpenLM Platform with Helm on a Kubernetes or Red Hat OpenShift cluster that you run, in your cloud account or in your own data center, follow the pages of this guide in order.

Preview: not final yet

This guide covers the openlm-platform chart while it's a release candidate (1.0.0-rc.x), before the final 1.0.0 release. What that means for you:

  • Content can change: commands, values, the component list, and the sizing figures can change from one release candidate to the next. Check the release notes of the version you install.
  • Tested, but not yet in production: OpenLM tests the guide on test clusters for each release candidate. The guide doesn't have the field experience of a final release yet.
  • Use it for evaluation and test installations: for a production installation, contact OpenLM before you start. If you run OpenLM Platform on the current openlm_mono chart, keep following Platform installation.

You don't need to know how OpenLM Platform works inside. Each step tells you what to run, what you see afterward, and what to do if you see something else. If you have worked with Kubernetes and Helm before, the steps are familiar. If you haven't, follow the pages in order and don't skip the checks.

What you get​

When you finish, you have:

  • OpenLM Platform running in one namespace, openlm, on your cluster.
  • One web address, for example https://openlm.example.com, where your users sign in.
  • OpenLM Platform connected to the databases and data services that you provide: SQL Server, MongoDB, Kafka, and Redis.

Choose where to start​

Find what you want to do in the following table, and open the page next to it:

You want to…Start here
Understand what gets installed before you plan anythingHow the platform fits together
Check that your cluster and services meet the requirementsRequirements
Collect the values you need (names, addresses, passwords)Installation worksheet
Install OpenLM PlatformInstallation, step by step
Read what's different on your cluster typeEKS, AKS, OpenShift, K3s
Understand a topic in depthNode placement, Ingress, Networking, TLS certificates, Sign-in and identity
See what changed in a releaseRelease notes
Fix something that isn't workingTroubleshooting

The installation at a glance​

The installation has eight steps:

1. Prepare the cluster namespace, storage, ingress controller, DNS name
2. Prepare data services SQL Server (4 databases), MongoDB, Kafka, Redis
3. Create the secrets connection details, kept out of Helm
4. Write your values file one file that describes your installation
5. Install the API gateway a small separate Helm release
6. Install the platform one helm install
7. Verify a short list of checks
8. First sign-in license, then products

Plan about half a day for the first installation, most of it for step 2. The helm install itself takes 20 to 40 minutes.

Versions

Each release of OpenLM Platform is one Helm chart version, for example 1.0.0. The chart fixes the version of every service inside it, so you never pick image versions yourself. The release notes list what changed in each version.

The documentation team might draft this page using a large language model. A technical writer reviews every page and verifies it against the product before publishing it. A human makes the final decision.