6 Commits

2 changed files with 44 additions and 45 deletions

View File

@@ -1,7 +1,7 @@
--- ---
title: "Petclinic Demo Jonathan Scaf 2" title: "Petclinic Demo Jonathan Scaf 2"
generated_by: documentor-agent 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 human_edited: false
source_entity: "Component/default/petclinic-demo-jonathan-scaf-2" source_entity: "Component/default/petclinic-demo-jonathan-scaf-2"
source_repo: "https://gitea.kyndemo.live/validate/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 ## 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. 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.
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 ## Repository
| Field | Value | | 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 Demo Jonathan Scaf 2](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
| Branch | main | | Branch | `main` |
| ArgoCD App | petclinic-demo-jonathan-scaf-2 | | ArgoCD App | `petclinic-demo-jonathan-scaf-2` |
| Namespace | demo-apps | | Namespace | `demo-apps` |
## Architecture ## 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). - 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 detailed observability. - 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. - 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
| Configuration | Description | | Configuration | Description |
|---|---| |---|---|
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). | | `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. | | Database URLs | H2: `jdbc:h2:mem:<uuid>`; MySQL and PostgreSQL require external setup. |
| OpenTelemetry | Auto-instrumentation enabled; traces exported to OTel Collector. | | OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
## Operations ## Operations
@@ -66,10 +64,11 @@ Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the r
## Observability ## 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) This service has OpenTelemetry auto-instrumentation enabled. Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana.
- **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. - **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 ## Dependencies

View File

@@ -1,7 +1,7 @@
--- ---
title: "Petclinic" title: "Petclinic"
generated_by: documentor-agent generated_by: documentor-agent
generated_at: "2026-05-05T10:06:42+00:00" generated_at: "2026-05-05T10:50:01+00:00"
human_edited: false human_edited: false
source_entity: "Component/default/petclinic" source_entity: "Component/default/petclinic"
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2" 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 # Petclinic
> A Spring Bootbased application for managing veterinary clinic operations, including scheduling, customer management, and pet records. > A Spring Bootbased application for managing veterinary clinics, including appointments, customers, and pets.
## Overview ## Overview
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. 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.
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. 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.
## Repository ## Repository
| Field | Value | | Field | Value |
|---|---| |---|---|
| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) | | Source Repo | [https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
| Branch | main | | Branch | main |
| ArgoCD App | petclinic-demo-jonathan-scaf-2 | | ArgoCD App | petclinic-demo-jonathan-scaf-2 |
| Namespace | demo-apps | | Namespace | demo-apps |
## Architecture ## Architecture
- The Petclinic service is deployed using ArgoCD, targeting the `demo-apps` namespace. - The service is based on the Spring Boot framework, leveraging its modularity and ease of integration.
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs. - OpenTelemetry auto-instrumentation is applied via a Kustomize overlay, 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 deployment is managed by ArgoCD, which syncs changes from the `main` branch to the `demo-apps` namespace.
- Continuous integration and deployment workflows are managed through Backstage and ArgoCD, ensuring seamless updates and rollbacks. - The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each.
## Configuration ## Configuration
| Configuration | Description | | Configuration | Description |
|---|---| |---|---|
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). | | `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or external database URLs for MySQL/PostgreSQL. | | Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose up mysql`, PostgreSQL: `docker-compose up postgres`. |
| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. | | OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318`. |
## Operations ## Operations
@@ -51,31 +51,31 @@ This service is part of the broader `petclinic-demo-jonathan-scaf-2` system and
cd petclinic-demo-jonathan-scaf-2 cd petclinic-demo-jonathan-scaf-2
``` ```
2. Run the application: 2. Run the application:
- Using Maven: - Maven: `./mvnw spring-boot:run`
```bash - Gradle: `./gradlew bootRun`
./mvnw spring-boot:run
```
- Using Gradle:
```bash
./gradlew bootRun
```
3. Access the application at [http://localhost:8080](http://localhost:8080). 3. Access the application at [http://localhost:8080](http://localhost:8080).
### Deployment ### Deployment
ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace. To roll back to a previous version: 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.
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. ### Database Setup
- Default: In-memory H2 database.
- Persistent options: MySQL or PostgreSQL, configured via Spring profiles.
### Rollback
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**.
## Observability ## Observability
- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=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` - **Alerts**: Configured via Grafana, filtered by `app=petclinic`.
This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana. _Not configured — see platform observability docs for additional details._
## Dependencies ## Dependencies