Merge pull request 'docs: documentation for validate/sonar-test-nest4' (#22) from documentor-validate-sonar-test-nest4-01e0755e into main

Reviewed-on: #21

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

@@ -1,7 +1,7 @@
 ---
 title: "sonar-test-nest4"
 generated_by: documentor-agent
-generated_at: "2026-05-15T15:19:14+00:00"
+generated_at: "2026-05-21T08:45:51+00:00"
 human_edited: false
 source_entity: "Component/default/sonar-test-nest4"
 source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4"
@@ -9,34 +9,35 @@ 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.
+`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.
 
-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`).
+This service plays a critical role in the demo-apps domain, serving as a testbed for platform capabilities such as CI/CD pipelines, observability, and load testing. It is managed via Humanitec and deployed to Azure Kubernetes Service (AKS) using Score-based configurations.
 
 ## Repository
 
 | Field          | Value                                                                                                                              |
-|----------------|-----------------------------------------------------------------------------------------------------------------|
+|----------------|------------------------------------------------------------------------------------------------------------------------------------|
-| Source Repo    | [validate/sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4)                               |
+| Source Repo    | [sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4)                                                           |
-| Branch         | `dev` → `staging` → `prod` (→ `main` SoR)                                                                      |
+| Branch         | `dev`                                                                                                                             |
 | ArgoCD App     | —                                                                                                                                 |
 | Namespace      | `dev`                                                                                                                             |
 
 ## Architecture
 
-`sonar-test-nest4` follows a stateless architecture, leveraging the `typescript-nestjs` framework. Key components include:
+`sonar-test-nest4` follows a modern microservice architecture with the following components:
 
 - **Runtime**: `typescript-nestjs`
 - **Container Port**: `3000`
-- **Health Check**: `/health`
+- **Endpoints**:
-- **Metrics Endpoint**: `/metrics` (Prometheus format)
+  - `/api/items` for CRUD operations
-- **Image Registry**: Azure Container Registry (`bstagecjotdevacr`)
+  - `/health` for health checks
-
+  - `/metrics` for Prometheus metrics
-The deployment flow is managed through Gitea Actions CI/CD workflows:
+- **Deployment**:
-1. **build-push.yml**: Builds and tests the application, then pushes the container image to ACR.
+  - Images are built and pushed to Azure Container Registry (ACR).
-2. **deploy-humanitec.yml**: Deploys the service to AKS using Humanitec's API and Score configuration.
+  - Humanitec API triggers deployments to AKS using Score-based configurations.
-
+- **CI/CD**:
-Promotions between environments (`dev`, `staging`, `prod`) are triggered via PRs, with CI gates and approval requirements ensuring quality control.
+  - Gitea Actions workflows (`build-push.yml` and `deploy-humanitec.yml`) automate build, test, and deployment processes.
+  - Promotion between environments (`dev → staging → prod`) is gated by CI checks and manual approvals.
 
 ## Configuration
 
@@ -46,24 +47,26 @@ Promotions between environments (`dev`, `staging`, `prod`) are triggered via PRs
 | `health_path`    | `/health`          |
 | `container_port` | `3000`             |
 
+Additional configuration options are managed via `.platform/config.yaml` and Humanitec score files.
+
 ## Operations
 
-### Deployment Steps
+### Deployment Flow
-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.
+1. Push changes to the `dev` branch to trigger automatic builds and deployments to the dev environment.
-3. Use the Backstage CI/CD tab to trigger promotions between environments.
+2. Promote changes to `staging` or `prod` via PRs, requiring CI checks and one approval.
+3. Use Backstage's CI/CD tab to monitor and trigger promotions between environments.
 
 ### Runbook Notes
-- Monitor `/health` for service health status.
+
-- Use `/metrics` for Prometheus-based observability.
+- **Health Check**: Verify service health via `/health`.
-- Refer to `.platform/config.yaml` for runtime-specific configurations.
+- **Metrics**: Access Prometheus metrics at `/metrics`.
+- **Load Testing**: K6 is enabled for load testing, with configurations stored in the `k6-test-sonar-test-nest4` ConfigMap.
 
 ## 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)
+- **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).
+- **Prometheus Metrics**: Exposed at `/metrics` on port `3000`.
-- **Chaos Mesh**: Enabled for resilience testing.
-- **K6 Load Testing**: Configured via `k6-test-sonar-test-nest4` in the `dev` namespace.
 
 ## Dependencies
 

catalog/component/default/sonar-test-nest4/_meta.json

@@ -0,0 +1,13 @@
+{
+  "sourceShas": {
+    "catalog-info.yaml": "aa72b708c50b03b5dd454112e1f50ab88546e586",
+    ".platform/initialized.md": "24a574f77ac17059b313a824398b9bb19263232e",
+    "README.md": "393357c07b620a60ef22f449987d9195d533dd10",
+    "docs/api.md": "86776bdd5e2fbe634709920102282ed589927c5b",
+    "docs/architecture.md": "00364872501f36d455a6597502481c8422368746",
+    "docs/index.md": "81f0ec2243665ad41daf93202c872cfc023eb21a"
+  },
+  "promptVersion": "1.0",
+  "generatedAt": "2026-05-21T08:46:06+00:00",
+  "contentHash": "a82efb2e2e92a9bcb63354c3faab85a4f8438528764c04da61699539d261fa17"
+}