Merge pull request 'docs: documentation for validate/sonar-test-nest4' (#17) from documentor-validate-sonar-test-nest4-08037ae6 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,45 +1,46 @@
 ---
-title: "Petclinic"
+title: "Petclinic Service"
 generated_by: documentor-agent
-generated_at: "2026-05-05T10:06:42+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 solution for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. The application is designed to be lightweight and easily deployable, with support for in-memory databases (H2) and external databases like MySQL and PostgreSQL.
+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.
 
-This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and has been scaffolded using the Backstage Application Migration Factory template. It includes OpenTelemetry instrumentation for observability and integrates with ArgoCD for continuous deployment. The application is suitable for development and experimental environments, with a focus on showcasing Spring Boot capabilities and providing a foundation for further customization.
+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 deployed using ArgoCD, targeting the `demo-apps` namespace.
+- The service is scaffolded using the Backstage Application Migration Factory template.
-- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
+- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace.
-- The application uses Spring Boot for rapid development and deployment, with support for both in-memory and external databases.
+- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed traces, metrics, and logs.
-- Continuous integration and deployment workflows are managed through Backstage and ArgoCD, ensuring seamless updates and rollbacks.
+- 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 | `jdbc:h2:mem:<uuid>` for H2, or external database URLs for MySQL/PostgreSQL. |
+| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. |
+| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
 
 ## Operations
 
@@ -47,8 +48,8 @@ This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and
 
 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:
    - Using Maven:
@@ -63,23 +64,27 @@ This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and
 
 ### Deployment
 
-ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace. To roll back to a previous version:
+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.
-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.
+### 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`.
-
+- OpenTelemetry instrumentation is enabled for traces, metrics, and logs.
-This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana.
 
 ## 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,81 @@
+---
+title: "sonar-test-nest4"
+generated_by: documentor-agent
+generated_at: "2026-05-15T15:21:00+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 broader system by offering item management capabilities. It is deployed on Azure Kubernetes Service (AKS) via Humanitec's Score-based deployment model, with container images stored in Azure Container Registry (ACR). The CI/CD pipeline is managed through Gitea Actions, ensuring automated builds, tests, and deployments across development, staging, and production 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 stateless architecture and is deployed as a containerized service. Key components include:
+
+- **Runtime**: `typescript-nestjs`
+- **Container Port**: `3000`
+- **Endpoints**:
+  - `/api/items` for CRUD operations
+  - `/health` for health checks
+  - `/metrics` for Prometheus metrics
+- **Deployment Flow**:
+  - Push to `dev`, `staging`, or `prod` triggers CI/CD workflows:
+    - `build-push.yml`: Builds and tests the application, then pushes the container image to Azure Container Registry.
+    - `deploy-humanitec.yml`: Deploys the service to AKS using Humanitec's API.
+- **Branch Model**:
+  - `dev`: Active development, auto-deploys to the dev environment.
+  - `staging`: Pre-production, promoted from `dev` via PR.
+  - `prod`: Production, promoted from `staging` via PR.
+  - `main`: System of record, receives merges from `prod`.
+
+## Configuration
+
+| Config Key       | Value          |
+|------------------|----------------|
+| `runtime`        | `typescript-nestjs` |
+| `health_path`    | `/health`      |
+| `container_port` | `3000`         |
+
+## Operations
+
+### Deployment Steps
+
+1. Push changes to the `dev` branch for automatic deployment to the dev environment.
+2. Open a PR to promote changes from `dev` to `staging`. Ensure CI tests pass and obtain one approval.
+3. Open a PR to promote changes from `staging` to `prod`. Ensure CI tests pass and obtain one approval.
+4. Merge changes from `prod` to `main` for system-of-record updates.
+
+### Runbook Notes
+
+- Monitor `/health` for service status.
+- Use `/metrics` for Prometheus-based observability.
+- For load testing, refer to the K6 configuration in the `dev` namespace.
+
+## 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**: Enabled 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": "5c2be634ddfec05ec6fed8c7b85cb2c8b9ab3c13",
+    ".platform/initialized.md": "24a574f77ac17059b313a824398b9bb19263232e",
+    "README.md": "b1f5c8dec0bf22d85c71f5049fb595bf1faa891c",
+    "docs/api.md": "86776bdd5e2fbe634709920102282ed589927c5b",
+    "docs/architecture.md": "6d022a6fee34ee24f7274bb18396d1c107be0c17",
+    "docs/index.md": "81f0ec2243665ad41daf93202c872cfc023eb21a"
+  },
+  "promptVersion": "1.0",
+  "generatedAt": "2026-05-15T15:21:17+00:00",
+  "contentHash": "c8f2f45262bf333754d6cb5a5e1e036b7ad2ceb7ec42d6618d086454aca34cad"
+}