Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 3.21 KB

SETUP.md

File metadata and controls

101 lines (65 loc) · 3.21 KB

Setup Guide

This guide walks you through the initial configuration and verification of your HTTP Ingestion with DB Configuration deployment.

Step 1: Configure Secrets

After syncing the project, you'll be prompted to configure the following secrets:

Secret Description
influxdb_admin_token Authentication token for InfluxDB. Also used as the Grafana admin password.
influxdb_admin_password Password for InfluxDB UI access.
http_auth_token Authentication token for the HTTP API Source endpoint.
postgresql_password Password for the PostgreSQL database.

Security Warning: Use strong, unique passwords for each secret. These services may be publicly accessible via the internet.

Step 2: Verify Deployment

After syncing and configuring secrets, verify that all services are running:

Core Pipeline (ungrouped):

  • HTTP API Source
  • HTTP Data Normalization
  • HTTP Config Enricher
  • InfluxDB2 Sink
  • Grafana
  • Machine Config UI

Mock Data Source group:

  • OPC UA Server
  • OPC UA Source
  • HTTP Sink

Aux services group:

  • InfluxDB2
  • postgreSQL

Note: It's normal for services to restart a few times during initial deployment while dependencies start up.

Step 3: Access Services

Grafana

  1. Click the public URL link on the Grafana deployment
  2. Log in with:
    • Username: admin
    • Password: The value you set for influxdb_admin_token

Machine Config UI

  1. Click the public URL link on the Machine Config UI deployment
  2. When embedded in the Quix portal, authentication is automatic via your Quix SDK token
  3. For standalone access, enter your Quix Personal Access Token (found in Quix Portal → Settings → Personal Access Token)

Step 4: Verify Data Flow

  1. Check mock data generation: The OPC UA Server generates simulated sensor data that flows through OPC UA Source → HTTP Sink → HTTP API Source

  2. Verify Kafka topics: In the Quix UI, check that messages are flowing through:

    • http_data (raw incoming data)
    • normalized_data (aggregated data)
    • config_enriched_data (data with configuration applied)

  3. View in Grafana: Navigate to Dashboards and select the printer dashboard to see live data visualization

Troubleshooting

Services keep restarting

This is normal during initial deployment. Wait 2-3 minutes for all dependencies to initialize. Services should stabilize after a few restart cycles.

No data in Grafana

  1. Verify all services are running (green status)
  2. Check that data is flowing through Kafka topics
  3. Ensure the InfluxDB2 Sink is connected and writing data
  4. Wait a few minutes for data to accumulate

Cannot access Grafana or Machine Config UI

  1. Verify the service is running
  2. Check that public access is enabled on the deployment
  3. Ensure you're using the correct credentials

HTTP API authentication errors

Verify that the http_auth_token secret matches between:

  • HTTP API Source (HTTP_AUTH_TOKEN)
  • HTTP Sink (RECEIVER_AUTH_TOKEN)

Database connection issues

  1. Verify PostgreSQL and InfluxDB2 services are running
  2. Check that the password secrets are configured correctly
  3. Services may need to restart after database initialization completes