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

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.
+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.
-
-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.
 
 ## 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).
+- 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.
+- 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. |
+| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| OpenTelemetry | Auto-instrumentation enabled; traces exported to OTel Collector. |
+| 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
+- **Rollback**:
-git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
+  1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
-cd petclinic-demo-jonathan-scaf-2
+  2. Click **History and Rollback**.
-# make changes, then:
+  3. Select the desired revision and click **Rollback**.
-git add . && git commit -m "your change" && git push origin main
+  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.
+<!-- TODO: FILL IN -->
-
-### 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.
 
 ## 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)
+- **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)
-- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`
+- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`.
-
-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.
 
 ## 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.
+- The service is scaffolded using the Backstage Application Migration Factory template.
-- Deployment flow:
+- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace.
-  1. Source code cloned from the original Spring Petclinic repository.
+- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed traces, metrics, and logs.
-  2. Backstage overlays applied for catalog entity creation and CI workflows.
+- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each database type.
-  3. OpenTelemetry auto-instrumentation injected via Kustomize overlays.
+- Observability is integrated with Grafana, providing dashboards and alerts for monitoring service health and performance.
-  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.
 
 ## 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). |
+| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| 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` |
+| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
-| PostgreSQL Docker | `docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.3` |
 
 ## Operations
 
-- **Local Development**:
+### 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`.
 
-- **Container Build**:
+1. Clone the repository:
-  Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`.
+   ```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**:
+### Deployment
-  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.
 
-<!-- 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).
+- **Grafana Dashboard**: [View Dashboard](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, filter by `app=petclinic`.
-- **Alerts**: Configured via Grafana with label selector `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/otel-collector`
-- `resource:default/veterinary-platform`

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

@@ -0,0 +1,79 @@
+---
+title: "sonar-test-nest4"
+generated_by: documentor-agent
+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"
+---
+
+## 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 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`                                                                                                                                            |
+
+## Architecture
+
+`sonar-test-nest4` follows a modern microservice architecture:
+
+- **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 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              |
+|------------------|--------------------|
+| `runtime`        | `typescript-nestjs` |
+| `health_path`    | `/health`          |
+| `container_port` | `3000`            |
+
+## 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 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](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
+
+- `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": "5c2be634ddfec05ec6fed8c7b85cb2c8b9ab3c13",
+    ".platform/initialized.md": "24a574f77ac17059b313a824398b9bb19263232e",
+    "README.md": "4b5a7f83a6729688266ef621748367cbd556ddfe",
+    "docs/api.md": "86776bdd5e2fbe634709920102282ed589927c5b",
+    "docs/architecture.md": "00364872501f36d455a6597502481c8422368746",
+    "docs/index.md": "81f0ec2243665ad41daf93202c872cfc023eb21a"
+  },
+  "promptVersion": "1.0",
+  "generatedAt": "2026-05-18T09:44:33+00:00",
+  "contentHash": "f915ebba47688cb37836b549477a2d11ff8d46d82974a7d6cba92f5e2090ca32"
+}