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-demo-jonathan-scaf-2/README.md

@@ -1,7 +1,7 @@
 ---
 title: "Petclinic Demo Jonathan Scaf 2"
 generated_by: documentor-agent
-generated_at: "2026-05-05T11:02:10+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,66 +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 project showcasing Spring Boot capabilities. This service was scaffolded using the Backstage Application Migration Factory template, enabling automated CI/CD workflows and observability instrumentation. The application is deployed into the `demo-apps` namespace and continuously managed by ArgoCD.
+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 Spring PetClinic application provides a simple interface for managing veterinary clinic operations, including customer, pet, and visit records. It is built using Spring Boot and supports multiple database configurations, including H2, MySQL, and PostgreSQL. This deployment integrates OpenTelemetry for observability and supports load testing with k6 and chaos engineering with Chaos Mesh.
+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 | [Petclinic Demo Jonathan Scaf 2](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
-| Branch | `main` |
+| Branch | main |
-| ArgoCD App | `petclinic-demo-jonathan-scaf-2` |
+| ArgoCD App | petclinic-demo-jonathan-scaf-2 |
-| Namespace | `demo-apps` |
+| Namespace | demo-apps |
 
 ## Architecture
 
-- The service is based on the Spring PetClinic application, cloned from the upstream repository at `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 comprehensive 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 and load-testing tools.
+- 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). |
+| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
-| Database URLs | H2: `jdbc:h2:mem:<uuid>`; MySQL and PostgreSQL require external setup. |
+| 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.
 
-ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
+- **Rollback**:
-
-### 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
 
-This service has OpenTelemetry auto-instrumentation enabled. Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana.
-
 - **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)
-- Filter by `app=petclinic-demo-jonathan-scaf-2` to see service-specific data.
+- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`.
-- Alerts are configured via Grafana and can be monitored in Backstage.
 
 ## Dependencies
 

catalog/component/default/petclinic/README.md

@@ -1,45 +1,46 @@
 ---
-title: "Petclinic"
+title: "Petclinic Service"
 generated_by: documentor-agent
-generated_at: "2026-05-05T10:50:01+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
+# Petclinic Service
 
-> A Spring Boot–based application for managing veterinary clinics, including appointments, customers, and pets.
+> 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 functionality for managing veterinary clinic operations, including customer records, pet details, and appointment scheduling. The application is designed to be lightweight and modular, making it suitable for deployment in various environments.
+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.
 
-Originally sourced from the Spring Petclinic project, this service has been scaffolded and enhanced using the Backstage Application Migration Factory template. It includes OpenTelemetry instrumentation for observability and integrates with ArgoCD for continuous deployment. The service is deployed in the `demo-apps` namespace and is part of the broader `petclinic-demo-jonathan-scaf-2` system.
+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 | [https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2](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 service is based on the Spring Boot framework, leveraging its modularity and ease of integration.
+- The service is scaffolded using the Backstage Application Migration Factory template.
-- OpenTelemetry auto-instrumentation is applied via a Kustomize overlay, enabling detailed observability for traces, metrics, and logs.
+- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace.
-- Continuous deployment is managed by ArgoCD, which syncs changes from 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.
+- 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` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
+| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
-| Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose up mysql`, PostgreSQL: `docker-compose up postgres`. |
+| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318`. |
+| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
 
 ## Operations
 
@@ -47,39 +48,43 @@ Originally sourced from the Spring Petclinic project, this service has been scaf
 
 1. Clone the repository:
    ```bash
-   git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
+   git clone https://gitea.kyndemo.live/validate/petclinic-demo-andrej2.git
-   cd petclinic-demo-jonathan-scaf-2
+   cd petclinic-demo-andrej2
    ```
 2. Run the application:
-   - Maven: `./mvnw spring-boot:run`
+   - Using Maven:
-   - Gradle: `./gradlew bootRun`
+     ```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 by ArgoCD to the `demo-apps` namespace. To roll back, use the ArgoCD UI or revert the Git commit.
+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, configured via Spring profiles.
+- Persistent options: MySQL or PostgreSQL, with Docker or `docker-compose` configurations.
 
 ### Rollback
 
-1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
+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)
-- **Alerts**: Configured via Grafana, filtered by `app=petclinic`.
+- **Alerts**: Configured via Grafana, filter by `app=petclinic`.
-
+- OpenTelemetry instrumentation is enabled for traces, metrics, and logs.
-_Not configured — see platform observability docs for additional details._
 
 ## Dependencies
 
 - `component:default/argocd-service`
 - `resource:default/k6-operator`
 - `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-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"
+}