Skip to main content

Prerequisites

Before deploying the OpenLM Platform, verify that the environment prepared in Environment setup meets the requirements below.

Infrastructure checklist

Confirm the following services are running and accessible from the Kubernetes cluster:

ServiceStatus to verify
SQL DatabaseServer reachable, connection string available. Supported engines: SQL Server, MariaDB, or PostgreSQL (MariaDB for operational, PostgreSQL for reporting).
MongoDBReachable, connection string available. Running in-cluster on the infrastructure node.
KafkaCluster reachable, authentication credentials available. All required topics must be created before deployment.
RedisReachable, connection string and credentials available.
Storage classAt least one Kubernetes storage class available. Verify with kubectl get storageclass.

Database preparation

Create databases

Create the following databases on your SQL server before deployment:

  1. Identity database – stores user and authentication data
  2. Operational database – stores license server and usage data. The database name in the server must end with _none (for example, openlm_operational_none). In the Helm values we configure the prefix without _none.
  3. DSS database – stores Directory Synchronization Service data
  4. Reporting database – stores reporting data (PostgreSQL or SQL Server)

Prepare reporting database

After creating the reporting database, apply the provided SQL scripts in this order:

  1. Table creation script
  2. View creation script

These scripts are included in the deployment package.

Prepare Kafka topics

Create all required Kafka topics before deployment. A topic creation script is included in the deployment package.

Kubernetes namespace

Create the namespace for the OpenLM platform:

kubectl create namespace openlm

TLS certificate

Prepare your TLS certificate and create a Kubernetes secret:

kubectl create secret tls openlm-lb-cert \
--key your-domain.key \
--cert your-domain.crt \
-n openlm

Custom CA certificate

If your organization uses internal certificate authorities, create a ConfigMap with the full certificate chain:

kubectl apply -f custom-ca-configmap.yaml -n openlm

The ConfigMap should contain the full chain of certificates used by your organization. If you are unsure, use the same certificate from the TLS secret above.

Validation

Run these checks before proceeding to Platform installation:

# Verify namespace exists
kubectl get namespace openlm

# Verify TLS secret
kubectl get secret openlm-lb-cert -n openlm

# Verify storage class
kubectl get storageclass

# Verify nodes are ready
kubectl get nodes

# Verify infrastructure services are running
kubectl get pods -n openlm-infrastructure