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,73 +1,90 @@
 ---
-title: "Petclinic"
+title: "Petclinic Service"
 generated_by: documentor-agent
-generated_at: "2026-05-05T11:02:41+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 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 platform for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. Originally sourced from the Spring Petclinic project, this service has been adapted and deployed using Backstage templates to integrate with modern observability and deployment tools.
+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 enhanced observability and integrates with Grafana for monitoring and alerting. The service is part of the broader `petclinic-demo-jonathan-scaf-2` system and is managed via ArgoCD for continuous deployment.
+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 Backstage Application Migration Factory 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 CI workflows and catalog entity creation.
+- 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 ensures up-to-date deployments.
-- Observability is enabled with OpenTelemetry, exporting traces, metrics, and logs to the OTel Collector, visualized in Grafana.
 
 ## 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 | JDBC URLs for H2, MySQL, and PostgreSQL databases. |
+| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| Docker Compose | Predefined services for MySQL and PostgreSQL databases. |
+| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
-| OTel Collector Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
 
 ## 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 or Gradle: `./mvnw spring-boot:run` or `./gradlew bootRun`.
-  3. Access the application at `http://localhost:8080`.
 
-- **Deployment**:
+1. Clone the repository:
-  - ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
+   ```bash
-  - Rollback can be performed via the ArgoCD UI or by reverting commits in Git.
+   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).
 
-<!-- TODO: FILL IN -->
+### 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**: [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 with label selector `app=petclinic`.
+- **Alerts**: Configured via Grafana, filter by `app=petclinic`.
-- **Instrumentation**: OpenTelemetry auto-instrumentation enabled.
+- 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-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"
+}