Merge pull request 'docs: documentation for validate/sonar-test-nest4' (#21) from documentor-validate-sonar-test-nest4-1a23c5f4 into main

Reviewed-on: #21

catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md

@@ -1,7 +1,7 @@
 ---
 title: "Petclinic Demo Jonathan Scaf 2"
 generated_by: documentor-agent
-generated_at: "2026-05-05T10:06:28+00:00"
+generated_at: "2026-05-05T11:02:41+00:00"
 human_edited: false
 source_entity: "Component/default/petclinic-demo-jonathan-scaf-2"
 source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
@@ -9,67 +9,61 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
 
 # Petclinic Demo Jonathan Scaf 2
 
-> A deployment of the Spring PetClinic application, scaffolded via Backstage and managed with ArgoCD in the `demo-apps` namespace.
+> A Spring Boot–based veterinary clinic application deployed via ArgoCD into the demo-apps namespace.
 
 ## Overview
 
-Petclinic Demo Jonathan Scaf 2 is a deployment of the Spring PetClinic application, a sample Spring Boot project designed to showcase best practices in Java application development. This service was scaffolded using the Backstage Application Migration Factory template and integrates OpenTelemetry for observability, K6 for load testing, and Chaos Mesh for chaos engineering.
+Petclinic Demo Jonathan Scaf 2 is a deployment of the Spring PetClinic application, a sample project showcasing Spring Boot capabilities. This service provides a web-based interface for managing veterinary clinic operations, including scheduling appointments, managing pet records, and tracking visits. It is designed to demonstrate modern application deployment practices, including GitOps workflows, OpenTelemetry instrumentation, and integration with Kubernetes.
 
-The application provides a web interface for managing veterinary clinics, including features for scheduling appointments, managing pet records, and tracking clinic staff. It is deployed via ArgoCD, which continuously syncs the application from the `main` branch of its source repository into the `demo-apps` namespace.
-
-This deployment is instrumented for monitoring and observability, with metrics and traces visualized in Grafana. It also supports rollback and automated sync workflows through ArgoCD.
+The application is scaffolded using the Backstage Application Migration Factory template, which overlays CI/CD workflows and observability configurations. It is continuously deployed via ArgoCD, ensuring that changes pushed to the repository are automatically synced to the Kubernetes cluster.
 
 ## Repository
 
 | Field | Value |
 |---|---|
-| Source Repo | [https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
+| Source Repo | [Petclinic Demo Jonathan Scaf 2](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
 | Branch | main |
 | ArgoCD App | petclinic-demo-jonathan-scaf-2 |
 | Namespace | demo-apps |
 
 ## Architecture
 
-- The application is based on the Spring PetClinic project, cloned from [https://github.com/spring-projects/spring-petclinic](https://github.com/spring-projects/spring-petclinic).
-- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability.
+- The application is based on the Spring PetClinic project, cloned from `https://github.com/spring-projects/spring-petclinic`.
+- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
 - ArgoCD manages the deployment, continuously syncing changes from the `main` branch to the `demo-apps` namespace.
-- The deployment flow includes CI workflows, Backstage catalog entity creation, and integration with monitoring tools like Grafana.
+- The deployment flow includes CI workflows, Kubernetes manifests, and observability configurations integrated into the repository.
 
 ## Configuration
 
 | Configuration | Description |
 |---|---|
 | `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
-| Database | Default is H2 in-memory; supports MySQL and PostgreSQL with Docker or Docker Compose. |
-| OpenTelemetry | Auto-instrumentation enabled; traces exported to OTel Collector. |
+| 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
 
-### Development Workflow
+- **Development Workflow**:
+  ```bash
+  git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
+  cd petclinic-demo-jonathan-scaf-2
+  # make changes, then:
+  git add . && git commit -m "your change" && git push origin main
+  ```
+  ArgoCD automatically syncs changes to the `demo-apps` namespace.
 
-```bash
-git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
-cd petclinic-demo-jonathan-scaf-2
-# make changes, then:
-git add . && git commit -m "your change" && git push origin main
-```
+- **Rollback**:
+  1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
+  2. Click **History and Rollback**.
+  3. Select the desired revision and click **Rollback**.
+  Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the rollback.
 
-ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
-
-### Rollback
-
-1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
-2. Click **History and Rollback**.
-3. Select the desired revision and click **Rollback**.
-
-Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the rollback.
+<!-- TODO: FILL IN -->
 
 ## Observability
 
-- **Grafana Dashboard**: [https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-jonathan-scaf-2](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-jonathan-scaf-2)
-- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`
-
-Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana. Alerts are configured via Grafana and can be monitored in Backstage.
+- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-jonathan-scaf-2)
+- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`.
 
 ## Dependencies
 

catalog/component/default/petclinic/README.md

@@ -1,76 +1,90 @@
 ---
 title: "Petclinic Service"
 generated_by: documentor-agent
-generated_at: "2026-05-05T10:41:37+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-jonathan-scaf-2"
+source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-andrej2"
 ---
 
 # Petclinic Service
 
-> A Spring Boot–based application for managing veterinary clinic operations, including scheduling, customer management, and pet records.
+> A Spring Boot application for managing veterinary clinics, including scheduling, customer management, and pet records.
 
 ## Overview
 
-The Petclinic service is a Java-based application built using Spring Boot. It provides a comprehensive solution for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. Originally developed as a sample application by the Spring community, this service has been adapted and deployed as part of the `petclinic-demo-jonathan-scaf-2` system.
+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 application supports multiple database configurations, including in-memory H2, MySQL, and PostgreSQL, and is designed to be easily deployable in containerized environments. It includes OpenTelemetry instrumentation for observability and integrates with ArgoCD for continuous deployment. The service plays a critical role in the broader veterinary platform, serving as the primary interface for clinic management.
+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 |
 |---|---|
-| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
+| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) |
 | Branch | main |
-| ArgoCD App | petclinic-demo-jonathan-scaf-2 |
+| ArgoCD App | petclinic-demo-andrej2 |
 | Namespace | demo-apps |
 
 ## Architecture
 
-- The Petclinic service is scaffolded using the Application Migration Factory Backstage template.
-- Deployment flow:
-  1. Source code cloned from the original Spring Petclinic repository.
-  2. Backstage overlays applied for catalog entity creation and CI workflows.
-  3. OpenTelemetry auto-instrumentation injected via Kustomize overlays.
-  4. ArgoCD Application created targeting the `demo-apps` namespace.
-  5. Continuous sync from the `main` branch via ArgoCD.
-- Observability is enabled through OpenTelemetry, with metrics and traces visualized in Grafana.
+- 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
 
 | Configuration | Description |
 |---|---|
 | `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
-| Database URL | For H2: `jdbc:h2:mem:<uuid>` (printed at startup). |
-| MySQL Docker | `docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:9.6` |
-| PostgreSQL Docker | `docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.3` |
+| 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
 
-- **Local Development**:
-  1. Clone the repository: `git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git`.
-  2. Start the application using Maven: `./mvnw spring-boot:run` or Gradle: `./gradlew bootRun`.
-  3. Access the application at `http://localhost:8080`.
+### Local Development
 
-- **Container Build**:
-  Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`.
+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).
 
-- **Rollback**:
-  1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
-  2. Use the "History and Rollback" feature to revert to a previous version.
+### Deployment
 
-<!-- TODO: FILL IN -->
+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**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic).
-- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`.
-- **Alerts**: Configured via Grafana with label selector `app=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
 
 - `component:default/argocd-service`
 - `resource:default/k6-operator`
-- `resource:default/otel-collector`
-- `resource:default/veterinary-platform`
+- `resource:default/otel-collector`

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

@@ -0,0 +1,84 @@
+---
+title: "sonar-test-nest4"
+generated_by: documentor-agent
+generated_at: "2026-05-21T07:55:31+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 CRUD operations, and is instrumented with OpenTelemetry for observability. It is designed to integrate seamlessly into the platform's CI/CD pipeline, leveraging Humanitec for deployment orchestration and Azure Container Registry for image storage.
+
+The service plays a critical role in the demo-apps domain, showcasing best practices for microservice development, deployment, and observability. It is managed by the platform engineering team and adheres to a strict branch promotion model to ensure quality and stability across environments.
+
+## Repository
+
+| Field          | Value                                                                                                                              |
+|----------------|------------------------------------------------------------------------------------------------------------------------------------|
+| Source Repo    | [validate/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:
+
+- **Runtime**: `typescript-nestjs`
+- **Container Port**: `3000`
+- **Endpoints**:
+  - `/api/items` for CRUD operations on items.
+  - `/health` for health checks.
+  - `/metrics` for Prometheus-compatible metrics.
+- **Deployment Flow**:
+  - CI/CD pipelines in Gitea Actions handle build, test, and deployment.
+  - Images are pushed to Azure Container Registry (`bstagecjotdevacr`).
+  - Humanitec orchestrates deployments to AKS using Score files.
+
+The service is designed for scalability and observability, with OpenTelemetry instrumentation and Prometheus metrics exposed at `/metrics`.
+
+## Configuration
+
+| Config Key       | Value            |
+|------------------|------------------|
+| `runtime`        | `typescript-nestjs` |
+| `health_path`    | `/health`        |
+| `container_port` | `3000`           |
+
+Additional configuration details are managed via `.platform/config.yaml` and Humanitec Score files.
+
+## Operations
+
+### Deployment Steps
+
+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.
+3. Merge PR to trigger deployment to the target environment.
+
+### Runbook Notes
+
+- **Health Check**: Verify service health at `/health`.
+- **Metrics**: Monitor Prometheus metrics at `/metrics`.
+- **Promotion Flow**:
+  - `dev → staging`: Requires CI gate and approval.
+  - `staging → prod`: Requires CI gate and approval.
+  - `prod → main`: Merge via PR after release.
+
+## 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`.
+
+_Chaos Mesh and K6 load testing are enabled for this service._
+
+## 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": "1dfa78366377f0f0c1d72669a551f44e90e8f6b1",
+    ".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-21T07:55:50+00:00",
+  "contentHash": "86c1649daaec999ba977c2baee3ad51bd3f679de80480fb0c830c0ef3626ece1"
+}