4.2 KiB
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-21T07:55:31+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 CRUD operations, and is instrumented with OpenTelemetry for observability. It is designed to integrate seamlessly into the platform's CI/CD pipeline, leveraging Humanitec for deployment orchestration and Azure Container Registry for image storage.
The service plays a critical role in the demo-apps domain, showcasing best practices for microservice development, deployment, and observability. It is managed by the platform engineering team and adheres to a strict branch promotion model to ensure quality and stability across environments.
Repository
| Field | Value |
|---|---|
| Source Repo | validate/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 on items./healthfor health checks./metricsfor Prometheus-compatible metrics.
- Deployment Flow:
- CI/CD pipelines in Gitea Actions handle build, test, and deployment.
- Images are pushed to Azure Container Registry (
bstagecjotdevacr). - Humanitec orchestrates deployments to AKS using Score files.
The service is designed for scalability and observability, with OpenTelemetry instrumentation and Prometheus metrics exposed at /metrics.
Configuration
| Config Key | Value |
|---|---|
runtime |
typescript-nestjs |
health_path |
/health |
container_port |
3000 |
Additional configuration details are managed via .platform/config.yaml and Humanitec Score files.
Operations
Deployment Steps
- Push changes to the
devbranch for automatic deployment to the development environment. - Open a PR for promotion to
stagingorprod. Ensure CI tests pass and obtain one approval. - Merge PR to trigger deployment to the target environment.
Runbook Notes
- Health Check: Verify service health at
/health. - Metrics: Monitor Prometheus metrics at
/metrics. - Promotion Flow:
dev → staging: Requires CI gate and approval.staging → prod: Requires CI gate and approval.prod → main: Merge via PR after release.
Observability
- Grafana Dashboard: OpenTelemetry Application Observability
- Prometheus Metrics: Exposed at
/metrics.
Chaos Mesh and K6 load testing are enabled for this service.
Dependencies
api:default/sonar-test-nest4-api