FT Configs Service Backend

This documentation describes the backend design and operational behavior of ft-configs-service. It is intended for backend engineers, architects, DevOps, and SREs.

Scope

ft-configs-service is the system of record for configuration domains (stored in its database) and also publishes read-optimized snapshots into the shared Hazelcast cluster for runtime consumers.

This documentation covers:

  • Spring Boot application architecture and package boundaries

  • Database schema (Liquibase) and JPA/Hibernate access patterns

  • Hazelcast caching strategy and data flows to consuming services

  • Import/export and dry-run behavior

  • Security, error handling, auditing

  • Build, test, deployment, troubleshooting

Entry Points

  • Base path: /configs-service

  • OpenAPI: /configs-service/v3/api-docs

  • Swagger UI: /configs-service/swagger-ui/index.html

  • Actuator: /configs-service/actuator/*

Document Map

The recommended reading order depends on your goal. Use this map to start from installation and move towards daily operations and deep design references.

1) Install and run

  • Installation & Deployment – step-by-step guide from prerequisites to running service (start here)

  • Configuration – profiles, environment variables, secrets, and runtime flags

  • Docker & Deploy – advanced container topics, Kubernetes notes, Compose for developers

  • Runtime Behavior – boot sequence, request lifecycle, transactions, and threading model

2) Operate and troubleshoot

  • Monitoring & Logs – actuator, metrics, logging, and tracing conventions

  • Troubleshooting – common incidents and how to diagnose them

  • Performance – known hotspots, N+1 patterns, cache rebuild guidance, measurement

3) Understand core subsystems

  • Caching Strategy – Hazelcast maps/lists, refresh, consistency guarantees, consumers

  • Import/Export & Dry-Run – formats, modes, validation, diff model, idempotency

  • Security – auth model, roles/authorities, bootstrap admin, CSRF/cookies (as applicable)

  • Error Handling – error contract, localization, classification

  • Auditing – audit model, persistence, retention, export, redaction, entity type registry

4) Architecture and data reference

The links above describe what the service does and how it behaves. For API reference and live endpoints, see Entry Points.