Integration with QA Data API and SDP System

Overview

The QA Display is designed to work in conjunction with the QA Data API backend and is typically deployed as part of the Science Data Processor (SDP Integration) subsystem . Integration and deployment are managed using Helm charts provided by the ska-sdp-integration repository.

System Architecture

  • QA Display: Front-end application for visualizing signal metrics in real time.

  • QA Data API: Backend service providing signal metrics via WebSockets and REST endpoints. See the QA Data API documentation.

  • SDP Integration: Provides Helm charts and deployment scripts to deploy the full SDP stack, including the QA Display and QA Data API, on Kubernetes. See the SDP Integration documentation.

Deployment

The recommended way to deploy the QA Display and its backend is via the Helm charts in the ska-sdp-integration repository. This ensures all services are configured correctly and can communicate as required.

  1. Clone the ska-sdp-integration repository.

  2. Follow the instructions in the documentation of SDP Integration to deploy the SDP stack.

  3. The QA Display and QA Data API will be deployed in the appropriate Kubernetes namespaces (e.g., dp-shared).

  4. Access the QA Display via the URL provided by the deployment (see Running the QA Display for example URLs).

Configuration

  • Environment variables for the QA Display are set via the env_scripts/env_config file or via Helm values.

  • The QA Display expects the QA Data API endpoint to be reachable; this is configured automatically when using the Helm charts.

  • For local development or testing, you can override the API endpoint and use mocked data as described in the Running the QA Display section.

Logs and Troubleshooting

  • Application logs for both the QA Display and QA Data API can be accessed via Kubernetes (kubectl logs …) or via the external dashboards linked in the UI (see external_links section).