Skip to main content

Verify your Lumi Enterprise deployment

info

This information applies to Imply Lumi Enterprise deployments on OpenShift.
Lumi Enterprise on OpenShift is an early access feature.

After you deploy Lumi Enterprise on OpenShift, follow the instructions in this topic to confirm your deployment is healthy.

A first install takes several minutes. Wait a few minutes after helm install completes before verifying your deployment.

Check pod health​

Run the following script to check whether Lumi services are running. Replace NAMESPACE with your Lumi Enterprise namespace.

NAMESPACE=NAMESPACE
PODS="$(oc -n ${NAMESPACE} get pods --no-headers)"
echo "pending: $(printf '%s\n' "$PODS" | grep -c Pending)"
 
for SERVICE in lumi-gateway update-client manager ui-app iow-auth iow-event-collector argo-rollouts \
  data-plane-imply-data data-plane-imply-master-coordinator data-plane-imply-master-overlord \
  data-plane-imply-query-broker data-plane-imply-query-router; do
  printf '%s\n' "$PODS" | awk -v p="$SERVICE" '
    index($1,p) {
      f=1
      split($2,r,"/")
      if ($3!="Running" || r[1]!=r[2]) b=1
    }
    END { printf "%-38s %s\n", p, (!f?"MISSING":b?"NOT READY":"ok") }'
done

A healthy deployment shows pending: 0, and every service listed as ok. If a service doesn't show ok, use the following table to interpret the result.

ResultMeaningNext step
MISSINGThe service was never created.Check the bootstrap Job. See The bootstrap Job.
NOT READYThe service exists but isn't serving traffic.Run oc -n NAMESPACE describe pod POD_NAME and check the container logs.

Sign in to the UI​

Follow these steps to confirm that you can access the Lumi UI:

  1. Open https://YOUR_INGRESS_HOST in your browser.
  2. Sign in with the admin username and password you set in auth.username and auth.password.
  3. Confirm you can reach the following pages: Explore, Integrations, Managed data, and Keys.

Create an IAM key​

Create an IAM key so you can send a test event to Lumi:

  1. From the Lumi navigation menu, click Integrations > OpenTelemetry Protocol (OTLP).
  2. In the key selector, select + Create key. See Create an IAM key for details.
  3. Copy the token and key ID. You will use them in the next step.

Send a test event​

Use the following script to send a test event to Lumi and confirm that ingestion works. Replace KEY_TOKEN with the token you copied in the previous step and YOUR_INGRESS_HOST with your Lumi hostname.

TOKEN='KEY_TOKEN'
OTEL='https://otel.YOUR_INGRESS_HOST/v1/logs'
NOW_NS="$(date +%s)000000000"
 
curl -i -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "resourceLogs": [{
      "resource": {
        "attributes": [{
          "key": "service.name",
          "value": { "stringValue": "curl-test" }
        }]
      },
      "scopeLogs": [{
        "logRecords": [{
          "timeUnixNano": "'"$NOW_NS"'",
          "severityText": "INFO",
          "body": { "stringValue": "Test log message from curl" }
        }]
      }]
    }]
  }' \
  "$OTEL"

A successful request returns a 200 response.

Query the test event​

After you send the test event, it can take a few minutes to appear in Lumi.

Follow these steps to query the test event:

  1. From the Lumi navigation menu, click Explore.
  2. Set the time filter to Last 15 minutes.
  3. Search for #iamKeyId=KEY_ID, replacing KEY_ID with the IAM key ID you created in Create an IAM key. You should see one row with a body of Test log message from curl.
  4. Open the row and confirm its attributes include service.name = curl-test and severityText = INFO.
  5. To confirm full-text search works, search for the message text as free text. It should return the same row.

Learn more​

See the following topics for more information: