validate/platform-docs
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source
This commit was merged in pull request #4.
This commit is contained in:
demo-bot
2026-05-05 10:50:17 +00:00
parent a1f162f55a e6065b0c5f
commit 49c0442fff
1 changed files with 40 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
catalog/component/default/petclinic/README.md
View File

@@ -1,72 +1,81 @@
---
title: "Petclinic Service"
title: "Petclinic"
generated_by: documentor-agent
generated_at: "2026-05-05T10:41:37+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"
---
# Petclinic Service
# 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. 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.
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.
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.
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 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.
- 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` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| Database URL | For H2: `jdbc:h2:mem:<uuid>` (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` |
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| 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
- **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`.
### Local Development
- **Container Build**:
Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`.
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:
- Maven: `./mvnw spring-boot:run`
- Gradle: `./gradlew bootRun`
3. Access the application at [http://localhost:8080](http://localhost:8080).
- **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.
### Deployment
<!-- TODO: FILL IN -->
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.
### 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`.
- **Alerts**: Configured via Grafana with label selector `app=petclinic`.
- **Alerts**: Configured via Grafana, filtered by `app=petclinic`.
_Not configured — see platform observability docs for additional details._
## Dependencies