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/petclinic/README.md

@@ -1,46 +1,87 @@
 ---
-title: "Petclinic"
+title: "Petclinic Service"
 generated_by: documentor-agent
-generated_at: "2026-05-13T10:50:59+00:00"
+generated_at: "2026-05-13T10:51:17+00:00"
 human_edited: false
 source_entity: "Component/default/petclinic"
 source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-andrej2"
 ---
 
-# Petclinic
+# Petclinic Service
 
-> Petclinic service — part of petclinic-demo-andrej2.
+> A Spring Boot application for managing veterinary clinics, including scheduling, customer management, and pet records.
 
 ## Overview
 
-The Petclinic service is a core component of the petclinic-demo-andrej2 system. It is designed to provide functionality for managing pet-related data, including owners, visits, and veterinary records. This service is part of a demonstration project showcasing modern application deployment practices, including GitOps, observability, load testing, and chaos engineering.
+The Petclinic service is a Spring Boot application designed to manage veterinary clinic operations. It provides features such as scheduling appointments, managing customer and pet records, and viewing clinic information. Originally developed as a sample application by the Spring community, this service has been adapted and deployed using Backstage templates for enhanced observability and deployment automation.
 
-The service is built using Java and integrates with various platform tools such as ArgoCD for deployment, OpenTelemetry for observability, K6 for load testing, and Chaos Mesh for chaos engineering experiments. It serves as a practical example of how to implement and manage a microservice in a cloud-native environment.
+The application supports multiple database configurations, including in-memory H2, MySQL, and PostgreSQL, and can be run locally or deployed in containerized environments. It is instrumented with OpenTelemetry for comprehensive observability and integrates with Grafana for monitoring and alerting.
 
 ## Repository
 
-| Field         | Value                                                                 |
+| Field | Value |
-|---------------|-----------------------------------------------------------------------|
+|---|---|
-| Source Repo   | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) |
+| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) |
-| Branch        | main                                                                  |
+| Branch | main |
-| ArgoCD App    | petclinic-demo-andrej2                                               |
+| ArgoCD App | petclinic-demo-andrej2 |
-| Namespace     | demo-apps                                                            |
+| Namespace | demo-apps |
 
 ## Architecture
 
-<!-- TODO: FILL IN -->
+- The service is scaffolded using the Backstage Application Migration Factory template.
+- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace.
+- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed traces, metrics, and logs.
+- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each database type.
+- Observability is integrated with Grafana, providing dashboards and alerts for monitoring service health and performance.
 
 ## Configuration
 
-<!-- TODO: FILL IN -->
+| Configuration | Description |
+|---|---|
+| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
+| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
+| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
 
 ## Operations
 
-<!-- TODO: FILL IN -->
+### Local Development
+
+1. Clone the repository:
+   ```bash
+   git clone https://gitea.kyndemo.live/validate/petclinic-demo-andrej2.git
+   cd petclinic-demo-andrej2
+   ```
+2. Run the application:
+   - Using Maven:
+     ```bash
+     ./mvnw spring-boot:run
+     ```
+   - Using Gradle:
+     ```bash
+     ./gradlew bootRun
+     ```
+3. Access the application at [http://localhost:8080](http://localhost:8080).
+
+### Deployment
+
+Changes pushed to the `main` branch are automatically synced to the `demo-apps` namespace by ArgoCD. To roll back, use the ArgoCD UI or revert the commit in Git.
+
+### Database Setup
+
+- Default: In-memory H2 database.
+- Persistent options: MySQL or PostgreSQL, with Docker or `docker-compose` configurations.
+
+### Rollback
+
+1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-andrej2).
+2. Select **History and Rollback**.
+3. Choose the desired revision and click **Rollback**.
 
 ## Observability
 
-- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
+- **Grafana Dashboard**: [View Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
+- **Alerts**: Configured via Grafana, filter by `app=petclinic`.
+- OpenTelemetry instrumentation is enabled for traces, metrics, and logs.
 
 ## Dependencies
 

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

@@ -0,0 +1,79 @@
+---
+title: "sonar-test-nest4"
+generated_by: documentor-agent
+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"
+---
+
+## 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.
+
+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    | [sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4)                                                           |
+| Branch         | `dev`                                                                                                                             |
+| ArgoCD App     | —                                                                                                                                 |
+| Namespace      | `dev`                                                                                                                             |
+
+## Architecture
+
+`sonar-test-nest4` follows a modern microservice architecture with the following components:
+
+- **Runtime**: `typescript-nestjs`
+- **Container Port**: `3000`
+- **Endpoints**:
+  - `/api/items` for CRUD operations
+  - `/health` for health checks
+  - `/metrics` for Prometheus metrics
+- **Deployment**:
+  - Images are built and pushed to Azure Container Registry (ACR).
+  - Humanitec API triggers deployments to AKS using Score-based configurations.
+- **CI/CD**:
+  - 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
+
+| Config Key       | Value              |
+|------------------|--------------------|
+| `runtime`        | `typescript-nestjs` |
+| `health_path`    | `/health`          |
+| `container_port` | `3000`             |
+
+Additional configuration options are managed via `.platform/config.yaml` and Humanitec score files.
+
+## Operations
+
+### Deployment Flow
+
+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 checks and one approval.
+3. Use Backstage's CI/CD tab to monitor and trigger promotions between environments.
+
+### Runbook Notes
+
+- **Health Check**: Verify service health via `/health`.
+- **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)
+- **Prometheus Metrics**: Exposed at `/metrics` on port `3000`.
+
+## Dependencies
+
+- `api:default/sonar-test-nest4-api`
+
+## Links
+
+- [Humanitec Console](https://console.humanitec.dev/orgs/skillful-wild-chicken-2617/projects/domain-demo-apps)
+- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
+- [Source Repository](https://gitea.kyndemo.live/validate/sonar-test-nest4)

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"
+}