docs: generate README for component/default/petclinic [documentor-agent]
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Petclinic"
|
||||
generated_by: documentor-agent
|
||||
generated_at: "2026-05-05T10:50:01+00:00"
|
||||
generated_at: "2026-05-05T11:02:41+00:00"
|
||||
human_edited: false
|
||||
source_entity: "Component/default/petclinic"
|
||||
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
|
||||
@@ -9,73 +9,61 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
|
||||
|
||||
# Petclinic
|
||||
|
||||
> A Spring Boot–based application for managing veterinary clinics, including appointments, customers, and pets.
|
||||
> 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 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 Petclinic service is a Java-based application built using Spring Boot. It provides a comprehensive platform for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. Originally sourced from the Spring Petclinic project, this service has been adapted and deployed using Backstage templates to integrate with modern observability and deployment tools.
|
||||
|
||||
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.
|
||||
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 enhanced observability and integrates with Grafana for monitoring and alerting. The service is part of the broader `petclinic-demo-jonathan-scaf-2` system and is managed via ArgoCD for continuous deployment.
|
||||
|
||||
## Repository
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| Source Repo | [https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
|
||||
| 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 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.
|
||||
- The Petclinic service is scaffolded using the Backstage Application Migration Factory template.
|
||||
- Deployment flow:
|
||||
1. Source code cloned from the original Spring Petclinic repository.
|
||||
2. Backstage overlays applied for CI workflows and catalog entity creation.
|
||||
3. OpenTelemetry auto-instrumentation injected via Kustomize overlays.
|
||||
4. ArgoCD application created targeting the `demo-apps` namespace.
|
||||
5. Continuous sync from the `main` branch ensures up-to-date deployments.
|
||||
- Observability is enabled with OpenTelemetry, exporting traces, metrics, and logs to the OTel Collector, visualized in Grafana.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Configuration | Description |
|
||||
|---|---|
|
||||
| `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`. |
|
||||
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default H2). |
|
||||
| Database URLs | JDBC URLs for H2, MySQL, and PostgreSQL databases. |
|
||||
| Docker Compose | Predefined services for MySQL and PostgreSQL databases. |
|
||||
| OTel Collector Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
|
||||
|
||||
## 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 or Gradle: `./mvnw spring-boot:run` or `./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:
|
||||
- Maven: `./mvnw spring-boot:run`
|
||||
- Gradle: `./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.
|
||||
- Rollback can be performed via the ArgoCD UI or by reverting commits in Git.
|
||||
|
||||
### Deployment
|
||||
|
||||
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**.
|
||||
<!-- TODO: FILL IN -->
|
||||
|
||||
## Observability
|
||||
|
||||
- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic).
|
||||
- **Alerts**: Configured via Grafana, filtered by `app=petclinic`.
|
||||
|
||||
_Not configured — see platform observability docs for additional details._
|
||||
- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
|
||||
- **Alerts**: Configured via Grafana with label selector `app=petclinic`.
|
||||
- **Instrumentation**: OpenTelemetry auto-instrumentation enabled.
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
Reference in New Issue
Block a user