title, generated_by, generated_at, human_edited, source_entity, source_repo
| title | generated_by | generated_at | human_edited | source_entity | source_repo |
|---|---|---|---|---|---|
| sonar-test-nest4 | documentor-agent | 2026-05-18T09:44:21+00:00 | false | Component/default/sonar-test-nest4 | https://gitea.kyndemo.live/validate/sonar-test-nest4 |
Overview
sonar-test-nest4 is a stateless microservice built using the typescript-nestjs runtime. It was scaffolded from the Create Microservice golden-path template on the Kyndryl Platform. The service provides a REST API for managing items, including endpoints for CRUD operations. It is designed to be lightweight, scalable, and observable, with integrated OpenTelemetry instrumentation and Prometheus metrics.
This service plays a key role in the demo-apps domain, serving as a foundational component for item management workflows. It is deployed via Humanitec to an AKS cluster, with CI/CD pipelines managed through Gitea Actions. Observability is enabled through Grafana dashboards and Prometheus metrics, ensuring operational insights and performance monitoring.
Repository
| Field | Value |
|---|---|
| Source Repo | sonar-test-nest4 |
| Branch | dev |
| ArgoCD App | — |
| Namespace | dev |
Architecture
sonar-test-nest4 follows a modern microservice architecture:
- Runtime:
typescript-nestjs - Container Port:
3000 - Endpoints:
/api/itemsfor CRUD operations/healthfor health checks/metricsfor Prometheus metrics
- Deployment:
- Images are built and pushed to Azure Container Registry (ACR).
- Humanitec manages deployments to AKS using Score files.
- CI/CD:
- Gitea Actions workflows (
build-push.ymlanddeploy-humanitec.yml) automate build, test, and deployment processes.
- Gitea Actions workflows (
- Branch Model:
dev→staging→prod→main(system of record).
Configuration
| Config Key | Value |
|---|---|
runtime |
typescript-nestjs |
health_path |
/health |
container_port |
3000 |
Operations
Deployment Flow
- Push changes to the
devbranch to trigger automatic builds and deployments to the dev environment. - Promote changes to
stagingorprodvia PRs, requiring CI gate and approval. - Merge production-ready code to the
mainbranch as the system of record.
Observability
- Health Check:
/healthendpoint returns{"status":"UP"}. - Metrics:
/metricsendpoint exposes Prometheus metrics. - Grafana Dashboard: Opentelemetry Application Observability.
Observability
- Grafana Dashboard
- Prometheus metrics enabled (
/metrics). - OpenTelemetry instrumentation integrated.
Dependencies
api:default/sonar-test-nest4-api