---
title: "sonar-test-nest4"
generated_by: documentor-agent
generated_at: "2026-05-15T15:19:14+00:00"
human_edited: false
source_entity: "Component/default/sonar-test-nest4"
source_repo: "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 key role in the demo-apps domain, serving as a foundational component for item management. It is deployed on Azure Kubernetes Service (AKS) via Humanitec, with container images stored in Azure Container Registry (ACR). 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](https://gitea.kyndemo.live/validate/sonar-test-nest4)                               |
| Branch         | `dev` → `staging` → `prod` (→ `main` SoR)                                                                      |
| ArgoCD App     | —                                                                                                              |
| Namespace      | `dev`                                                                                                          |

## Architecture

`sonar-test-nest4` follows a stateless architecture, leveraging the `typescript-nestjs` framework. 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 CI/CD workflows:
1. **build-push.yml**: Builds and tests the application, then pushes the container image to ACR.
2. **deploy-humanitec.yml**: Deploys the service to AKS using Humanitec's API and Score configuration.

Promotions between environments (`dev`, `staging`, `prod`) are triggered via PRs, with CI gates and approval requirements ensuring quality control.

## Configuration

| Config Key       | Value              |
|------------------|--------------------|
| `runtime`        | `typescript-nestjs` |
| `health_path`    | `/health`          |
| `container_port` | `3000`             |

## Operations

### Deployment Steps
1. Push changes to the `dev` branch for automatic deployment to the development environment.
2. Open a PR for promotion to `staging` or `prod`. Ensure CI tests pass and obtain one approval before merging.
3. Use the Backstage CI/CD tab to trigger promotions between environments.

### Runbook Notes
- Monitor `/health` for service health status.
- Use `/metrics` for Prometheus-based observability.
- Refer to `.platform/config.yaml` for runtime-specific configurations.

## Observability

- **Grafana Dashboard**: [Opentelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
- **Prometheus Metrics**: Enabled (`/metrics` endpoint).
- **Chaos Mesh**: Enabled for resilience testing.
- **K6 Load Testing**: Configured via `k6-test-sonar-test-nest4` in the `dev` namespace.

## Dependencies

- `api:default/sonar-test-nest4-api`

## Links

- [Humanitec Console](https://console.humanitec.dev/orgs/skillful-wild-chicken-2617/projects/domain-demo-apps)
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
- [Source Repository](https://gitea.kyndemo.live/validate/sonar-test-nest4)