Merge pull request 'docs: README for component/default/petclinic' (#4) from documentor-agent-component-default-petclinic-doc-30fb4c9cd089 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:41:16+00:00"
+generated_at: "2026-05-05T10:06:28+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,13 +9,15 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
 
 # Petclinic Demo Jonathan Scaf 2
 
-> A Spring Boot application deployed via ArgoCD into the `demo-apps` namespace, featuring OpenTelemetry instrumentation and support for load testing and chaos engineering.
+> A deployment of the Spring PetClinic application, scaffolded via Backstage and managed with ArgoCD in 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 building modern Java applications. This service is scaffolded using the Backstage Application Migration Factory template and integrates observability, load testing, and chaos engineering capabilities.
+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.
 
-The application provides a web interface for managing veterinary clinics, including features for scheduling appointments, managing pet records, and handling customer information. It is deployed in the `demo-apps` namespace and continuously synced via ArgoCD from the `main` branch of its source repository. OpenTelemetry instrumentation is enabled for comprehensive observability, and the service supports load testing using K6 and chaos engineering experiments via Chaos Mesh.
+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.
 
 ## Repository
 
@@ -28,44 +30,46 @@ The application provides a web interface for managing veterinary clinics, includ
 
 ## Architecture
 
-- The service is based on the Spring PetClinic application, 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 tracing, metrics, and logging.
+- 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.
 - ArgoCD manages the deployment, continuously syncing changes from the `main` branch to the `demo-apps` namespace.
-- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each.
+- The deployment flow includes CI workflows, Backstage catalog entity creation, and integration with monitoring tools like Grafana.
 
 ## Configuration
 
 | Configuration | Description |
 |---|---|
-| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
-| Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose.yml` service `mysql`, PostgreSQL: `docker-compose.yml` service `postgres`. |
-| OpenTelemetry Collector | Endpoint: `http://otel-collector.monitoring.svc.cluster.local:4318`. |
+| `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. |
 
 ## Operations
 
-- **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.
+### Development Workflow
 
-- **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**.
+```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
+```
 
-  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)
-- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`.
-- **Instrumentation**: OpenTelemetry traces, metrics, and logs exported to the OTel Collector.
+- **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.
 
 ## Dependencies
 

catalog/component/default/petclinic/README.md

@@ -1,7 +1,7 @@
 ---
 title: "Petclinic"
 generated_by: documentor-agent
-generated_at: "2026-05-05T10:06:42+00:00"
+generated_at: "2026-05-05T10:50:01+00:00"
 human_edited: false
 source_entity: "Component/default/petclinic"
 source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
@@ -9,37 +9,37 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
 
 # Petclinic
 
-> A Spring Boot–based application for managing veterinary clinic operations, including scheduling, customer management, and pet records.
+> A Spring Boot–based application for managing veterinary clinics, including appointments, customers, and pets.
 
 ## 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 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.
 
-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.
+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.
 
 ## Repository
 
 | Field | Value |
 |---|---|
-| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
+| Source Repo | [https://gitea.kyndemo.live/validate/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 Petclinic service is deployed using ArgoCD, targeting the `demo-apps` namespace.
-- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
-- The application uses Spring Boot for rapid development and deployment, with support for both in-memory and external databases.
-- Continuous integration and deployment workflows are managed through Backstage and ArgoCD, ensuring seamless updates and rollbacks.
+- The service is based on the Spring Boot framework, leveraging its modularity and ease of integration.
+- OpenTelemetry auto-instrumentation is applied via a Kustomize overlay, enabling detailed observability for traces, metrics, and logs.
+- Continuous deployment is managed by ArgoCD, which syncs changes from the `main` branch to the `demo-apps` namespace.
+- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each.
 
 ## Configuration
 
 | Configuration | Description |
 |---|---|
 | `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
-| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or external database URLs for MySQL/PostgreSQL. |
-| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. |
+| Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose up mysql`, PostgreSQL: `docker-compose up postgres`. |
+| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318`. |
 
 ## Operations
 
@@ -51,31 +51,31 @@ This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and
    cd petclinic-demo-jonathan-scaf-2
    ```
 2. Run the application:
-   - Using Maven:
-     ```bash
-     ./mvnw spring-boot:run
-     ```
-   - Using Gradle:
-     ```bash
-     ./gradlew bootRun
-     ```
+   - Maven: `./mvnw spring-boot:run`
+   - Gradle: `./gradlew bootRun`
 3. Access the application at [http://localhost:8080](http://localhost:8080).
 
 ### Deployment
 
-ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace. To roll back to a previous version:
-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**.
+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.
 
-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, configured via Spring profiles.
+
+### Rollback
+
+1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
+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`
+- **Grafana Dashboard**: [OpenTelemetry Application Observability](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`.
 
-This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana.
+_Not configured — see platform observability docs for additional details._
 
 ## Dependencies