Compare commits
1 Commits
7529b38918
...
documentor
| Author | SHA1 | Date | |
|---|---|---|---|
| 89976ecf5a |
@@ -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:49:39+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 deployment of the Spring PetClinic application, scaffolded via Backstage and integrated with OpenTelemetry, ArgoCD, and Chaos Mesh.
|
||||
|
||||
## 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 Java application development. This deployment integrates modern DevOps tools and practices, including ArgoCD for continuous delivery, OpenTelemetry for observability, and Chaos Mesh for chaos engineering experiments.
|
||||
|
||||
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 tracking veterinary staff. It is deployed in the `demo-apps` namespace and continuously synced from the `main` branch of its source repository. Observability is enabled via OpenTelemetry, with metrics and traces visualized in Grafana.
|
||||
|
||||
## Repository
|
||||
|
||||
@@ -33,43 +31,50 @@ This deployment is instrumented for monitoring and observability, with metrics a
|
||||
- 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.
|
||||
- Chaos Mesh is enabled for chaos engineering experiments, allowing resilience testing of the application.
|
||||
|
||||
Deployment flow:
|
||||
1. Source code is cloned and scaffolded using Backstage templates.
|
||||
2. OpenTelemetry instrumentation is injected.
|
||||
3. ArgoCD syncs the application from the repository to the Kubernetes cluster.
|
||||
|
||||
## 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. |
|
||||
| Environment Variables | `spring.profiles.active` for database configuration (`mysql`, `postgres`, or `default` for H2). |
|
||||
| Database | Default is H2; supports MySQL and PostgreSQL with Docker or Docker Compose. |
|
||||
| Observability | OpenTelemetry endpoint: `http://otel-collector.monitoring.svc.cluster.local:4318`. |
|
||||
|
||||
## Operations
|
||||
|
||||
### Development Workflow
|
||||
|
||||
### Deployment Workflow
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
|
||||
cd petclinic-demo-jonathan-scaf-2
|
||||
# make changes, then:
|
||||
```
|
||||
2. Make changes and push:
|
||||
```bash
|
||||
git add . && git commit -m "your change" && git push origin main
|
||||
```
|
||||
|
||||
ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
|
||||
3. ArgoCD 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.
|
||||
|
||||
<!-- 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`
|
||||
- OpenTelemetry instrumentation is enabled, exporting traces, metrics, and logs to the OTel Collector.
|
||||
|
||||
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.
|
||||
_Not configured — see platform observability docs._
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
||||
Reference in New Issue
Block a user