validate/platform-docs
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: documentation for validate/sonar-test-nest4 #19

Merged
demo-bot merged 2 commits from documentor-validate-sonar-test-nest4-d63c1bc4 into main 2026-05-18 09:44:43 +00:00
Conversation 0 Commits 2 Files Changed 2 +34 -31
1 changed files with 34 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit da4ea18d47 - Show all commits

65
catalog/component/default/sonar-test-nest4/README.md
View File

@@ -1,7 +1,7 @@
---
title: "sonar-test-nest4"
generated_by: documentor-agent
generated_at: "2026-05-18T09:31:41+00:00"
generated_at: "2026-05-18T09:44:21+00:00"
human_edited: false
source_entity: "Component/default/sonar-test-nest4"
source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4"
@@ -9,61 +9,64 @@ 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 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.
`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 endpoints for CRUD operations. It is designed to be lightweight, scalable, and observable, with integrated OpenTelemetry instrumentation and Prometheus metrics.
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.
This service plays a key role in the demo-apps domain, serving as a foundational component for item management workflows. It is deployed via Humanitec to an AKS cluster, with CI/CD pipelines managed through Gitea Actions. Observability is enabled through Grafana dashboards and Prometheus metrics, ensuring operational insights and performance monitoring.
## Repository
| Field | Value |
|----------------|-----------------------------------------------------------------------------------------------------------------------------|
| Source Repo | [sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4) |
| Branch | `dev` |
| ArgoCD App | — |
| Namespace | `dev` |
| Field | Value |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| Source Repo | [sonar-test-nest4](https://gitea.kyndemo.live/validate/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.
`sonar-test-nest4` follows a modern microservice architecture:
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.
- **Deployment**:
- Images are built and pushed to Azure Container Registry (ACR).
- Humanitec manages deployments to AKS using Score files.
- **CI/CD**:
- Gitea Actions workflows (`build-push.yml` and `deploy-humanitec.yml`) automate build, test, and deployment processes.
- **Branch Model**:
- `dev` → `staging` → `prod` → `main` (system of record).
## Configuration
| Config Key | Value |
|------------------|----------------|
| Config Key | Value |
|------------------|--------------------|
| `runtime` | `typescript-nestjs` |
| `health_path` | `/health` |
| `container_port` | `3000` |
| `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.
### Deployment Flow
### 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.
1. Push changes to the `dev` branch to trigger automatic builds and deployments to the dev environment.
2. Promote changes to `staging` or `prod` via PRs, requiring CI gate and approval.
3. Merge production-ready code to the `main` branch as the system of record.
### Observability
- **Health Check**: `/health` endpoint returns `{"status":"UP"}`.
- **Metrics**: `/metrics` endpoint exposes Prometheus metrics.
- **Grafana Dashboard**: [Opentelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4).
## 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 (`k6-test-sonar-test-nest4` in `dev` namespace)
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
- Prometheus metrics enabled (`/metrics`).
- OpenTelemetry instrumentation integrated.
## Dependencies