---
title: "Sonar Test Nest4"
generated_by: documentor-agent
generated_at: "2026-05-14T12:03:00+00:00"
human_edited: false
source_entity: "Component/default/sonar-test-nest4"
source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4"
---

# Sonar Test Nest4

> A stateless microservice built with TypeScript and NestJS, providing API endpoints for item management and Prometheus-based observability.

## Overview

Sonar Test Nest4 is a stateless microservice scaffolded from the **Create Microservice** golden-path template on the Kyndryl Platform. It is designed to manage items through a RESTful API and includes built-in observability features such as health checks and Prometheus metrics.

The service is implemented using the `typescript-nestjs` runtime and follows a structured branch model (`dev`, `staging`, `prod`, and `main`) to ensure smooth CI/CD workflows. It is deployed to Azure Kubernetes Service (AKS) via Humanitec, with container images stored in Azure Container Registry (ACR).

This service plays a key role in the broader system by providing item management capabilities and adhering to platform standards for observability, deployment, and runtime configuration.

## Repository

| Field | Value |
|---|---|
| Source Repo | [Sonar Test Nest4 Repository](https://gitea.kyndemo.live/validate/sonar-test-nest4) |
| Branch | dev |
| ArgoCD App | — |
| Namespace | dev |

## Architecture

Sonar Test Nest4 is built using the `typescript-nestjs` runtime and deployed as a stateless service. Key architectural components include:

- **Runtime**: TypeScript with NestJS framework.
- **Container Port**: `3000`.
- **Health Check Endpoint**: `/health`.
- **Metrics Endpoint**: `/metrics` (Prometheus format).
- **Image Repository**: Azure Container Registry (`bstagecjotdevacr`).

The CI/CD pipeline is managed through Gitea Actions workflows:
- `build-push.yml`: Builds and tests the application, then pushes the container image to ACR.
- `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 |

## Operations

The service follows a structured branch model for development and deployment:

- **dev**: Active development branch; commits trigger automatic builds and deployments to the dev environment.
- **staging**: Pre-production environment; changes are promoted from `dev` via PR with CI gate and approval.
- **prod**: Production environment; changes are promoted from `staging` via PR with CI gate and approval.
- **main**: System of record; receives merges from `prod` after releases.

Deployment workflows are runtime-agnostic and rely on `.platform/config.yaml` for configuration.

## Observability

- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4): OpenTelemetry-based application observability.
- Prometheus metrics exposed at `/metrics`.
- Health check endpoint at `/health`.

## Dependencies

_No declared dependencies._