docs: generate README for component/default/petclinic-demo-jonathan-scaf-2 [documentor-agent]
This commit is contained in:
@@ -0,0 +1,79 @@
|
|||||||
|
---
|
||||||
|
title: "Petclinic Demo Jonathan Scaf 2"
|
||||||
|
generated_by: documentor-agent
|
||||||
|
generated_at: "2026-05-05T10:06:28+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"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Petclinic Demo Jonathan Scaf 2
|
||||||
|
|
||||||
|
> A deployment of the Spring PetClinic application, scaffolded via Backstage and managed with ArgoCD in the `demo-apps` namespace.
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## 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 |
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
## 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. |
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Development Workflow
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
|
||||||
|
cd petclinic-demo-jonathan-scaf-2
|
||||||
|
# make changes, then:
|
||||||
|
git add . && git commit -m "your change" && git push origin main
|
||||||
|
```
|
||||||
|
|
||||||
|
ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
|
||||||
|
|
||||||
|
### Rollback
|
||||||
|
|
||||||
|
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**: [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`
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
- `component:default/argocd-service`
|
||||||
|
- `resource:default/k6-operator`
|
||||||
|
- `resource:default/otel-collector`
|
||||||
|
- `resource:default/veterinary-platform`
|
||||||
Reference in New Issue
Block a user