diff --git a/catalog/component/default/petclinic/README.md b/catalog/component/default/petclinic/README.md new file mode 100644 index 0000000..2bae387 --- /dev/null +++ b/catalog/component/default/petclinic/README.md @@ -0,0 +1,85 @@ +--- +title: "Petclinic" +generated_by: documentor-agent +generated_at: "2026-05-05T10:06:42+00:00" +human_edited: false +source_entity: "Component/default/petclinic" +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. + +## 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. + +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. + +## Repository + +| Field | Value | +|---|---| +| Source Repo | [Petclinic Repository](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. + +## 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. | + +## Operations + +### Local Development + +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). + +### 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**. + +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. + +## Dependencies + +- `component:default/argocd-service` +- `resource:default/k6-operator` +- `resource:default/otel-collector` +- `resource:default/veterinary-platform` \ No newline at end of file