From 37b54abf82104440bc325b39522478fe10d2ed2c Mon Sep 17 00:00:00 2001 From: demo-bot Date: Tue, 5 May 2026 10:41:47 +0000 Subject: [PATCH] docs: generate README for component/default/petclinic [documentor-agent] --- catalog/component/default/petclinic/README.md | 69 ++++++++----------- 1 file changed, 30 insertions(+), 39 deletions(-) diff --git a/catalog/component/default/petclinic/README.md b/catalog/component/default/petclinic/README.md index 2bae387..51a9dc7 100644 --- a/catalog/component/default/petclinic/README.md +++ b/catalog/component/default/petclinic/README.md @@ -1,21 +1,21 @@ --- -title: "Petclinic" +title: "Petclinic Service" generated_by: documentor-agent -generated_at: "2026-05-05T10:06:42+00:00" +generated_at: "2026-05-05T10:41:37+00:00" human_edited: false source_entity: "Component/default/petclinic" source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2" --- -# Petclinic +# Petclinic Service > A Spring Boot–based application for managing veterinary clinic operations, 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 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. Originally developed as a sample application by the Spring community, this service has been adapted and deployed as part of the `petclinic-demo-jonathan-scaf-2` system. -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 is designed to be easily deployable in containerized environments. It includes OpenTelemetry instrumentation for observability and integrates with ArgoCD for continuous deployment. The service plays a critical role in the broader veterinary platform, serving as the primary interface for clinic management. ## Repository @@ -28,54 +28,45 @@ This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and ## 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 Petclinic service is scaffolded using the Application Migration Factory Backstage template. +- Deployment flow: + 1. Source code cloned from the original Spring Petclinic repository. + 2. Backstage overlays applied for catalog entity creation and CI workflows. + 3. OpenTelemetry auto-instrumentation injected via Kustomize overlays. + 4. ArgoCD Application created targeting the `demo-apps` namespace. + 5. Continuous sync from the `main` branch via ArgoCD. +- Observability is enabled through OpenTelemetry, with metrics and traces visualized in Grafana. ## Configuration | Configuration | Description | |---|---| -| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). | -| Database URLs | `jdbc:h2:mem:` for H2, or external database URLs for MySQL/PostgreSQL. | -| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. | +| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). | +| Database URL | For H2: `jdbc:h2:mem:` (printed at startup). | +| MySQL Docker | `docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:9.6` | +| PostgreSQL Docker | `docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.3` | ## 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: `./mvnw spring-boot:run` or Gradle: `./gradlew bootRun`. + 3. Access the application at `http://localhost:8080`. -1. Clone the repository: - ```bash - git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git - cd petclinic-demo-jonathan-scaf-2 - ``` -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). +- **Container Build**: + Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`. -### Deployment +- **Rollback**: + 1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2). + 2. Use the "History and Rollback" feature to revert to a previous version. -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**. - -Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the 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` - -This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana. +- **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 with label selector `app=petclinic`. ## Dependencies