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

docs: README for component/default/petclinic #10

Merged
demo-bot merged 1 commits from documentor-agent-component-default-petclinic-doc-0638e68ccf36 into main 2026-05-13 10:51:35 +00:00
Conversation 0 Commits 1 Files Changed 1 +58 -15
1 changed files with 58 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,44 +1,87 @@
--- ---
title: "Petclinic" title: "Petclinic Service"
generated_by: documentor-agent generated_by: documentor-agent
generated_at: "2026-05-13T10:51:15+00:00" generated_at: "2026-05-13T10:51:17+00:00"
human_edited: false human_edited: false
source_entity: "Component/default/petclinic" source_entity: "Component/default/petclinic"
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-andrej2" source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-andrej2"
--- ---
# Petclinic # Petclinic Service
> Petclinic service — part of petclinic-demo-andrej2. > A Spring Boot application for managing veterinary clinics, including scheduling, customer management, and pet records.
## Overview ## Overview
The Petclinic service is a core component of the petclinic-demo-andrej2 system. It is designed to provide functionality for managing pet-related data and operations, such as scheduling appointments, tracking pet health records, and managing customer information. This service is built using Java and integrates with various platform tools for deployment, observability, load testing, and chaos engineering. The Petclinic service is a Spring Boot application designed to manage veterinary clinic operations. It provides features such as scheduling appointments, managing customer and pet records, and viewing clinic information. Originally developed as a sample application by the Spring community, this service has been adapted and deployed using Backstage templates for enhanced observability and deployment automation.
The application supports multiple database configurations, including in-memory H2, MySQL, and PostgreSQL, and can be run locally or deployed in containerized environments. It is instrumented with OpenTelemetry for comprehensive observability and integrates with Grafana for monitoring and alerting.
## Repository ## Repository
| Field | Value | | Field | Value |
|---------------|-------------------------------------------------------------------------------------------| |---|---|
| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) | | Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) |
| Branch | main | | Branch | main |
| ArgoCD App | petclinic-demo-andrej2 | | ArgoCD App | petclinic-demo-andrej2 |
| Namespace | demo-apps | | Namespace | demo-apps |
## Architecture ## Architecture
<!-- TODO: FILL IN --> - The service is scaffolded using the Backstage Application Migration Factory template.
- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace.
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed traces, metrics, and logs.
- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each database type.
- Observability is integrated with Grafana, providing dashboards and alerts for monitoring service health and performance.
## Configuration ## Configuration
<!-- TODO: FILL IN --> | Configuration | Description |
|---|---|
| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
## Operations ## Operations
<!-- TODO: FILL IN --> ### Local Development
1. Clone the repository:
```bash
git clone https://gitea.kyndemo.live/validate/petclinic-demo-andrej2.git
cd petclinic-demo-andrej2
```
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
Changes pushed to the `main` branch are automatically synced to the `demo-apps` namespace by ArgoCD. To roll back, use the ArgoCD UI or revert the commit in Git.
### Database Setup
- Default: In-memory H2 database.
- Persistent options: MySQL or PostgreSQL, with Docker or `docker-compose` configurations.
### Rollback
1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-andrej2).
2. Select **History and Rollback**.
3. Choose the desired revision and click **Rollback**.
## Observability ## Observability
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic) - **Grafana Dashboard**: [View Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
- **Alerts**: Configured via Grafana, filter by `app=petclinic`.
- OpenTelemetry instrumentation is enabled for traces, metrics, and logs.
## Dependencies ## Dependencies