Merge pull request 'docs: README for component/default/petclinic' (#4) from documentor-agent-component-default-petclinic-doc-30fb4c9cd089 into main

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.
+- The service is based on the Spring Boot framework, leveraging its modularity and ease of integration.
-- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
+- OpenTelemetry auto-instrumentation is applied via a Kustomize overlay, 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 deployment is managed by ArgoCD, which syncs changes from the `main` branch to the `demo-apps` namespace.
-- 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.
 
 ## 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. |
+| Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose up mysql`, PostgreSQL: `docker-compose up postgres`. |
-| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. |
+| 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:
+   - Maven: `./mvnw spring-boot:run`
-     ```bash
+   - Gradle: `./gradlew bootRun`
-     ./mvnw spring-boot:run
-     ```
-   - Using Gradle:
-     ```bash
-     ./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:
+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.
-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, 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)
+- **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`
+- **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