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-demo-jonathan-scaf-2' (#5) from documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-d95bf65b5534 into main

Browse Source
This commit was merged in pull request #5.
This commit is contained in:
demo-bot
2026-05-05 11:02:24 +00:00
parent 49c0442fff 2cc073baf5
commit 13426e0f99
1 changed files with 17 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md
View File

@@ -1,7 +1,7 @@
---
title: "Petclinic Demo Jonathan Scaf 2"
generated_by: documentor-agent
generated_at: "2026-05-05T10:06:28+00:00"
generated_at: "2026-05-05T11:02:10+00:00"
human_edited: false
source_entity: "Component/default/petclinic-demo-jonathan-scaf-2"
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
@@ -13,35 +13,33 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
## Overview
Petclinic Demo Jonathan Scaf 2 is a deployment of the Spring PetClinic application, a sample Spring Boot project designed to showcase best practices in Java application development. This service was scaffolded using the Backstage Application Migration Factory template and integrates OpenTelemetry for observability, K6 for load testing, and Chaos Mesh for chaos engineering.
Petclinic Demo Jonathan Scaf 2 is a deployment of the Spring PetClinic application, a sample project showcasing Spring Boot capabilities. This service was scaffolded using the Backstage Application Migration Factory template, enabling automated CI/CD workflows and observability instrumentation. The application is deployed into the `demo-apps` namespace and continuously managed by ArgoCD.
The application provides a web interface for managing veterinary clinics, including features for scheduling appointments, managing pet records, and tracking clinic staff. It is deployed via ArgoCD, which continuously syncs the application from the `main` branch of its source repository into the `demo-apps` namespace.
This deployment is instrumented for monitoring and observability, with metrics and traces visualized in Grafana. It also supports rollback and automated sync workflows through ArgoCD.
The Spring PetClinic application provides a simple interface for managing veterinary clinic operations, including customer, pet, and visit records. It is built using Spring Boot and supports multiple database configurations, including H2, MySQL, and PostgreSQL. This deployment integrates OpenTelemetry for observability and supports load testing with k6 and chaos engineering with Chaos Mesh.
## 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) |
| Branch | main |
| ArgoCD App | petclinic-demo-jonathan-scaf-2 |
| Namespace | demo-apps |
| Source Repo | [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 application is based on the Spring PetClinic project, cloned from [https://github.com/spring-projects/spring-petclinic](https://github.com/spring-projects/spring-petclinic).
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability.
- The service is based on the Spring PetClinic application, cloned from the upstream repository at `https://github.com/spring-projects/spring-petclinic`.
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling comprehensive observability.
- ArgoCD manages the deployment, continuously syncing changes from the `main` branch to the `demo-apps` namespace.
- The deployment flow includes CI workflows, Backstage catalog entity creation, and integration with monitoring tools like Grafana.
- The deployment flow includes CI workflows, Backstage catalog entity creation, and integration with monitoring and load-testing tools.
## Configuration
| Configuration | Description |
|---|---|
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| Database | Default is H2 in-memory; supports MySQL and PostgreSQL with Docker or Docker Compose. |
| OpenTelemetry | Auto-instrumentation enabled; traces exported to OTel Collector. |
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default H2). |
| Database URLs | H2: `jdbc:h2:mem:<uuid>`; MySQL and PostgreSQL require external setup. |
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
## Operations
@@ -66,10 +64,11 @@ Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the r
## Observability
- **Grafana Dashboard**: [https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-jonathan-scaf-2](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-jonathan-scaf-2)
- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`
This service has OpenTelemetry auto-instrumentation enabled. Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana.
Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana. Alerts are configured via Grafana and can be monitored in Backstage.
- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-jonathan-scaf-2)
- Filter by `app=petclinic-demo-jonathan-scaf-2` to see service-specific data.
- Alerts are configured via Grafana and can be monitored in Backstage.
## Dependencies