Skip to content
Halász Dávid edited this page Mar 9, 2024 · 2 revisions

Welcome to the compliance-backend wiki! Here you will find developer documentation for working with the codebase.

Models

The microservice uses ActiveRecord for Object-Relational Mapping on top of a PostgreSQL database. The defined models are being used by all the other services across the codebase. Data about systems together with its table structure is provided by an external service.

API

The REST API exposes the database for clients, including the insights-client command-line utility and our frontend application. It uses ActionController::API and relies on an external RBAC service and has to run behind an API gateway that provides among others authentication.

Content

The content required for security compliance is provided by a static web server running next to this service and an import job is responsible for periodically synchronizing it with our database. Without this content, the application is not functional.

Reports

The heart of the application is the background workers responsible for parsing OpenSCAP reports uploaded by insights-client.

Clone this wiki locally