Skip to main content

Install Lumi Enterprise on OpenShift

info

Imply Lumi Enterprise on OpenShift is an early access feature.

This topic walks you through installing Lumi Enterprise on bare-metal OpenShift using a Helm chart. Placeholder values are shown in uppercase—for example, DATABASE_HOST. Replace these with values for your own environment.

Before you install Lumi Enterprise, make sure you've completed the setup topics listed in Deploy Lumi Enterprise. These cover your credentials, permissions, dependencies, networking, and nodes.

Installation steps​

Follow these steps to install Lumi Enterprise on OpenShift:

  1. Authenticate to the OCI registry:

    helm registry login registry-1.docker.io \
      --username DOCKERHUB_USERNAME \
      --password DOCKERHUB_PAT

  2. Pull the default values.yaml file:

    helm show values oci://registry-1.docker.io/imply/lumi --version 0.1.4 > values.yaml

  3. Edit the values.yaml file with your configuration. Set the following fields:

    • tenantId, apiKey, and customerId
    • database, kafka, and objectStore
    • ingress.host
    • gateway.ingress.enabled and gateway.ingress.className, or gateway.service.type if you expose the gateway with a load balancer
    • auth
    • registry.pullSecret, or registry.dockerhub.username and registry.dockerhub.password
    • The resources and storage volumes for the data, broker, coordinator, and ingestion nodes. For recommended starting sizes, see Size and prepare nodes.

    For the full list of available fields, see the Helm chart reference.

    To see a complete example, download openshift-bare-metal-values.yaml, a sample values.yaml file for deploying Lumi Enterprise on OpenShift bare metal.

  4. Install the Helm chart:

    helm install lumi oci://registry-1.docker.io/imply/lumi \
       --version 0.1.4 \
       -f values.yaml \
       --namespace NAMESPACE

    Your output should be similar to the following:

    NAME: lumi
    LAST DEPLOYED: Wed Sep  9 11:15:19 2026
    NAMESPACE: lumi-enterprise
    STATUS: deployed
    REVISION: 1
    DESCRIPTION: Install complete
    TEST SUITE: None

  5. Check the status:

    helm status lumi -n NAMESPACE

  6. Check if pods are starting, run the following command. It may take several minutes for all pods to come up.

    oc get pods -n NAMESPACE

    The update-client service starts running and connects to the Imply update server to pull the latest Bill of Materials (BOM) and deploy the remaining Lumi services.

  7. Verify that you can reach the UI by opening https://YOUR_INGRESS_HOST in a browser and confirming the Lumi login page loads. Sign in with the admin username and password you set in auth.username and auth.password.

For a more thorough check of your deployment, including pod health, ingestion, and search, see Verify your Lumi Enterprise deployment.

The bootstrap Job​

Installing the Lumi Helm chart creates a one-time bootstrap Job in your release namespace. This Job installs the update-client service, which manages the rest of the Lumi deployment and keeps itself up to date.

The bootstrap Job is a seed step, not an ongoing component. It checks whether the update-client is already installed, and exits without making changes if it is. Re-running helm upgrade doesn't repeat the bootstrap process.

The Job pod exits once it completes.

If a service is missing after installation, check the bootstrap Job first:

oc -n NAMESPACE get jobs

A healthy bootstrap Job shows 1/1 under COMPLETIONS.
Check its logs for a line ending in Bootstrap successful!:

oc -n NAMESPACE logs job/BOOTSTRAP_JOB_NAME

Upgrade Lumi Enterprise​

Lumi Enterprise on OpenShift supports both automatic and custom upgrade paths.

Once installed, the update-client service periodically checks the Imply update server for a new BOM and automatically upgrades Lumi internal components to match. You don't need to run Helm commands for these component-level updates.

To upgrade the top-level Lumi Helm chart itself, run the following command:

helm upgrade lumi oci://registry-1.docker.io/imply/lumi \
  --version CHART_VERSION \
  -f values.yaml \
  --namespace NAMESPACE

Replace CHART_VERSION with the chart version you want to upgrade to, and NAMESPACE with your Lumi Enterprise namespace.

Uninstall Lumi Enterprise​

warning

Uninstalling Lumi Enterprise deletes all Kubernetes resources associated with the deployment. Deleting the namespace permanently removes any data or configuration stored within it. This doesn't affect data in your external database, Kafka cluster, or object store.

To uninstall Lumi Enterprise and its associated services, run the following commands:

helm uninstall lumi -n NAMESPACE
oc delete namespace NAMESPACE

Learn more​

See the following topics for more information: