Compare commits
1 Commits
753a1fcb44
...
documentor
| Author | SHA1 | Date | |
|---|---|---|---|
| 3f5491f617 |
@@ -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-05T10:41:16+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"
|
||||
@@ -9,15 +9,13 @@ 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.
|
||||
> A Spring Boot application deployed via ArgoCD into the `demo-apps` namespace, featuring OpenTelemetry instrumentation and support for load testing and chaos engineering.
|
||||
|
||||
## 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 Spring Boot project designed to showcase best practices in building modern Java applications. This service is scaffolded using the Backstage Application Migration Factory template and integrates observability, load testing, and chaos engineering capabilities.
|
||||
|
||||
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 application provides a web interface for managing veterinary clinics, including features for scheduling appointments, managing pet records, and handling customer information. It is deployed in the `demo-apps` namespace and continuously synced via ArgoCD from the `main` branch of its source repository. OpenTelemetry instrumentation is enabled for comprehensive observability, and the service supports load testing using K6 and chaos engineering experiments via Chaos Mesh.
|
||||
|
||||
## Repository
|
||||
|
||||
@@ -30,46 +28,44 @@ This deployment is instrumented for monitoring and observability, with metrics a
|
||||
|
||||
## 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 [https://github.com/spring-projects/spring-petclinic](https://github.com/spring-projects/spring-petclinic).
|
||||
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed tracing, metrics, and logging.
|
||||
- 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 application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each.
|
||||
|
||||
## 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` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
|
||||
| Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose.yml` service `mysql`, PostgreSQL: `docker-compose.yml` service `postgres`. |
|
||||
| OpenTelemetry Collector | Endpoint: `http://otel-collector.monitoring.svc.cluster.local:4318`. |
|
||||
|
||||
## Operations
|
||||
|
||||
### Development Workflow
|
||||
- **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 automatically syncs changes to the `demo-apps` namespace.
|
||||
|
||||
```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
|
||||
```
|
||||
- **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**.
|
||||
|
||||
ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
|
||||
Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the rollback.
|
||||
|
||||
### 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.
|
||||
<!-- TODO: FILL IN -->
|
||||
|
||||
## 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.
|
||||
- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`.
|
||||
- **Instrumentation**: OpenTelemetry traces, metrics, and logs exported to the OTel Collector.
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
Reference in New Issue
Block a user