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

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

Merged
demo-bot merged 2 commits from documentor-validate-sonar-test-nest4-9e0e917a into main 2026-05-18 10:04:02 +00:00
Conversation 0 Commits 2 Files Changed 2 +33 -30
1 changed files with 33 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 040a26578d - Show all commits

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

@@ -1,7 +1,7 @@
--- ---
title: "sonar-test-nest4" title: "sonar-test-nest4"
generated_by: documentor-agent generated_by: documentor-agent
generated_at: "2026-05-18T09:44:21+00:00" generated_at: "2026-05-18T10:03:38+00:00"
human_edited: false human_edited: false
source_entity: "Component/default/sonar-test-nest4" source_entity: "Component/default/sonar-test-nest4"
source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4" source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4"
@@ -9,22 +9,22 @@ source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4"
## Overview ## 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, including endpoints for CRUD operations. It is designed to be lightweight, scalable, and observable, with integrated OpenTelemetry instrumentation and Prometheus metrics. `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 CRUD operations, and exposes observability endpoints for health checks and Prometheus metrics.
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. This service plays a key role in the broader system by offering a scalable and observable backend for item management. It is deployed using Humanitec's API-driven deployment model, leveraging Azure Kubernetes Service (AKS) and Azure Container Registry (ACR). The CI/CD pipeline automates builds, tests, and deployments across development, staging, and production environments.
## Repository ## Repository
| Field | Value | | Field | Value |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------| |----------------|------------------------------------------------------------------------------------------------------------------------------------|
| Source Repo | [sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4) | | Source Repo | [validate/sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4) |
| Branch | `dev` | | Branch | `dev` |
| ArgoCD App | — | | ArgoCD App | — |
| Namespace | `dev` | | Namespace | `dev` |
## Architecture ## Architecture
`sonar-test-nest4` follows a modern microservice architecture: `sonar-test-nest4` follows a modern microservice architecture with the following components:
- **Runtime**: `typescript-nestjs` - **Runtime**: `typescript-nestjs`
- **Container Port**: `3000` - **Container Port**: `3000`
@@ -32,41 +32,44 @@ This service plays a key role in the demo-apps domain, serving as a foundational
- `/api/items` for CRUD operations - `/api/items` for CRUD operations
- `/health` for health checks - `/health` for health checks
- `/metrics` for Prometheus metrics - `/metrics` for Prometheus metrics
- **Deployment**: - **Deployment Flow**:
- Images are built and pushed to Azure Container Registry (ACR). - Push to `dev`, `staging`, or `prod` triggers CI/CD workflows:
- Humanitec manages deployments to AKS using Score files. - `build-push.yml`: Builds and tests the service, then pushes the container image to Azure Container Registry.
- **CI/CD**: - `deploy-humanitec.yml`: Deploys the service to AKS using Humanitec's Score-based deployment model.
- Gitea Actions workflows (`build-push.yml` and `deploy-humanitec.yml`) automate build, test, and deployment processes.
- **Branch Model**: - **Branch Model**:
- `dev` → `staging` → `prod` → `main` (system of record). - `dev`: Active development, auto-deploys to the dev environment.
- `staging`: Pre-production, promoted from `dev` via PR.
- `prod`: Production, promoted from `staging` via PR.
- `main`: System of record, receives merges from `prod`.
## Configuration ## Configuration
| Config Key | Value | | Config Key | Value |
|------------------|--------------------| |------------------|-------------------|
| `runtime` | `typescript-nestjs` | | `runtime` | `typescript-nestjs` |
| `health_path` | `/health` | | `health_path` | `/health` |
| `container_port` | `3000` | | `container_port` | `3000` |
## Operations ## Operations
### Deployment Flow ### Deployment Steps
1. Push changes to the `dev` branch to trigger automatic builds and deployments to the dev environment. 1. Push changes to the `dev` branch for automatic deployment to the dev environment.
2. Promote changes to `staging` or `prod` via PRs, requiring CI gate and approval. 2. Open a PR to promote changes from `dev` to `staging`. Ensure CI tests pass and obtain one approval.
3. Merge production-ready code to the `main` branch as the system of record. 3. Open a PR to promote changes from `staging` to `prod`. Ensure CI tests pass and obtain one approval.
4. Merge changes from `prod` to `main` for system-of-record updates.
### Observability ### Observability Endpoints
- **Health Check**: `/health` endpoint returns `{"status":"UP"}`. - `/health`: Returns `{"status":"UP"}` for health checks.
- **Metrics**: `/metrics` endpoint exposes Prometheus metrics. - `/metrics`: Exposes Prometheus metrics for monitoring.
- **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 ## Observability
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4) - **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`). - **Prometheus Metrics**: Enabled (`/metrics` endpoint).
- OpenTelemetry instrumentation integrated. - **Chaos Mesh**: Enabled for resilience testing.
- **K6 Load Testing**: Configured via `k6-test-sonar-test-nest4` in the `dev` namespace.
## Dependencies ## Dependencies