1 Commits

2 changed files with 58 additions and 61 deletions

View File

@@ -1,7 +1,7 @@
---
title: "Petclinic Demo Jonathan Scaf 2"
generated_by: documentor-agent
generated_at: "2026-05-05T11:02:10+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,66 +9,63 @@ 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 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.
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 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.
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
| Field | Value |
|---|---|
| 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` |
| 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 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.
- 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 and load-testing tools.
- 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 URLs | H2: `jdbc:h2:mem:<uuid>`; MySQL and PostgreSQL require external setup. |
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
| `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.
ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
### 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
This service has OpenTelemetry auto-instrumentation enabled. Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana.
- **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.
- **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)
- **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

View File

@@ -1,7 +1,7 @@
---
title: "Petclinic"
generated_by: documentor-agent
generated_at: "2026-05-05T10:50:01+00:00"
generated_at: "2026-05-05T10:06:42+00:00"
human_edited: false
source_entity: "Component/default/petclinic"
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
@@ -9,37 +9,37 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
# Petclinic
> A Spring Bootbased application for managing veterinary clinics, including appointments, customers, and pets.
> A Spring Bootbased 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 solution for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. The application is designed to be lightweight and easily deployable, with support for in-memory databases (H2) and external databases like MySQL and PostgreSQL.
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.
This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and has been scaffolded using the Backstage Application Migration Factory template. It includes OpenTelemetry instrumentation for observability and integrates with ArgoCD for continuous deployment. The application is suitable for development and experimental environments, with a focus on showcasing Spring Boot capabilities and providing a foundation for further customization.
## 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 deployed using ArgoCD, targeting the `demo-apps` namespace.
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
- The application uses Spring Boot for rapid development and deployment, with support for both in-memory and external databases.
- Continuous integration and deployment workflows are managed through Backstage and ArgoCD, ensuring seamless updates and rollbacks.
## 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`. |
| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or external database URLs for MySQL/PostgreSQL. |
| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. |
## Operations
@@ -51,31 +51,31 @@ Originally sourced from the Spring Petclinic project, this service has been scaf
cd petclinic-demo-jonathan-scaf-2
```
2. Run the application:
- Maven: `./mvnw spring-boot:run`
- Gradle: `./gradlew bootRun`
- Using Maven:
```bash
./mvnw spring-boot:run
```
- Using Gradle:
```bash
./gradlew bootRun
```
3. Access the application at [http://localhost:8080](http://localhost:8080).
### 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
ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace. To roll back to a previous version:
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**.
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**: [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`.
- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`
_Not configured — see platform observability docs for additional details._
This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana.
## Dependencies