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-15T15:19:48+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 RESTful 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 critical role in the demo-apps domain, serving as a foundational component for item management workflows. It is deployed via Humanitec and runs on Azure Kubernetes Service (AKS), leveraging Azure Container Registry for image storage. The CI/CD pipeline is managed through Gitea Actions, ensuring automated builds, tests, and deployments across environments (dev, staging, prod).
Repository
| Field | Value |
|---|---|
| Source Repo | validate/sonar-test-nest4 |
| Branch | dev |
| ArgoCD App | — |
| Namespace | dev |
Architecture
sonar-test-nest4 follows a stateless architecture and is deployed as a containerized service. Key components include:
- Runtime:
typescript-nestjs - Container Port:
3000 - Health Check:
/health - Metrics Endpoint:
/metrics(Prometheus format) - Image Registry: Azure Container Registry (
bstagecjotdevacr)
The deployment flow is managed through Gitea Actions workflows:
- build-push.yml: Builds and tests the application, then pushes the container image to Azure Container Registry.
- deploy-humanitec.yml: Deploys the service to AKS via Humanitec using Score files.
Promotions between environments (dev, staging, prod) are triggered through Backstage's CI/CD tab, ensuring controlled and gated deployments.
Configuration
| Config Key | Value |
|---|---|
runtime |
typescript-nestjs |
health_path |
/health |
container_port |
3000 |
Environment-specific configurations are managed via Humanitec and Score files. Additional configuration details can be found in .platform/config.yaml.
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 before merging. - Use Backstage's CI/CD tab to trigger environment promotions.
Runbook Notes
- Monitor the
/healthendpoint for service health. - Use
/metricsfor Prometheus-based observability. - Refer to
.gitea/workflows/for CI/CD pipeline configurations.
Observability
- Grafana Dashboard: Opentelemetry Application Observability
- Prometheus Metrics: Enabled (
/metricsendpoint) - Alerting: Configured via Grafana with label selector
app=sonar-test-nest4
Dependencies
api:default/sonar-test-nest4-api