platform-docs/catalog/component/default/sonar-test-nest4/README.md

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:31:41+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, exposing endpoints for CRUD operations. It is designed to be lightweight, scalable, and integrates seamlessly with the platform's CI/CD pipeline and observability stack.

The service plays a critical role in the demo-apps domain, serving as a foundational component for showcasing platform capabilities such as OpenTelemetry instrumentation, Prometheus metrics, and automated load testing with k6. It is managed by the platform engineering group and follows a strict branch promotion model to ensure stability across environments.

Repository

Field	Value
Source Repo	sonar-test-nest4
Branch	dev
ArgoCD App	—
Namespace	dev

Architecture

sonar-test-nest4 is deployed as a containerized service on Azure Kubernetes Service (AKS) via Humanitec's Score-based deployment. The CI/CD pipeline is powered by Gitea Actions, which automates the build, test, and deployment processes. The service communicates with other components through its REST API and exposes Prometheus metrics for monitoring.

Key architectural details:

• Runtime: typescript-nestjs
• Container Port: 3000
• Endpoints:
  • /api/items for CRUD operations
  • /health for health checks
  • /metrics for Prometheus metrics
• Image Registry: Azure Container Registry (bstagecjotdevacr)
• Deployment Flow:
  • Push to dev triggers automatic build and deployment to the dev environment.
  • Promotion to staging and prod requires PR approval and passing CI gates.

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 dev environment.
2. Open a PR for promotion to staging or prod. Ensure CI tests pass and obtain one approval.
3. Merge the PR to trigger deployment to the target environment.

Runbook Notes

• Monitor the /health endpoint for service status.
• Use the /metrics endpoint for Prometheus-based observability.
• Refer to .platform/config.yaml for runtime-specific configurations.

Observability

• Grafana Dashboard: Opentelemetry Application Observability
• Prometheus Metrics: Enabled (/metrics endpoint)
• Chaos Mesh: Enabled for resilience testing
• k6 Load Testing: Configured (k6-test-sonar-test-nest4 in dev namespace)

Dependencies

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

Links

• Humanitec Console
• Grafana Dashboard
• Source Repository