12 Commits

Author SHA1 Message Date
1e4eb91c10 Merge pull request 'docs: README for component/default/petclinic' (#8) from documentor-agent-component-default-petclinic-doc-52cb3f849f5f into main 2026-05-13 10:51:11 +00:00
66328cc005 docs: generate README for component/default/petclinic [documentor-agent] 2026-05-13 10:51:08 +00:00
9c74ca2ad1 Merge pull request 'docs: README for component/default/petclinic' (#7) from documentor-agent-component-default-petclinic-doc-ed08d1a43ef6 into main 2026-05-05 11:02:58 +00:00
2c64d74218 Merge pull request 'docs: README for component/default/petclinic-demo-jonathan-scaf-2' (#6) from documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-26eceb0fa4b9 into main 2026-05-05 11:02:58 +00:00
0aba4ac987 docs: generate README for component/default/petclinic [documentor-agent] 2026-05-05 11:02:54 +00:00
33b5b4506d docs: generate README for component/default/petclinic-demo-jonathan-scaf-2 [documentor-agent] 2026-05-05 11:02:53 +00:00
13426e0f99 Merge pull request 'docs: README for component/default/petclinic-demo-jonathan-scaf-2' (#5) from documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-d95bf65b5534 into main 2026-05-05 11:02:24 +00:00
2cc073baf5 docs: generate README for component/default/petclinic-demo-jonathan-scaf-2 [documentor-agent] 2026-05-05 11:02:21 +00:00
49c0442fff Merge pull request 'docs: README for component/default/petclinic' (#4) from documentor-agent-component-default-petclinic-doc-30fb4c9cd089 into main 2026-05-05 10:50:17 +00:00
e6065b0c5f docs: generate README for component/default/petclinic [documentor-agent] 2026-05-05 10:50:13 +00:00
a1f162f55a Merge pull request 'docs: README for component/default/petclinic' (#2) from documentor-agent-component-default-petclinic-doc-07cfc9dd5bba into main 2026-05-05 10:41:51 +00:00
37b54abf82 docs: generate README for component/default/petclinic [documentor-agent] 2026-05-05 10:41:47 +00:00
2 changed files with 28 additions and 66 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:41:16+00:00" generated_at: "2026-05-05T11:02:41+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"
@@ -9,37 +9,37 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
# Petclinic Demo Jonathan Scaf 2 # Petclinic Demo Jonathan Scaf 2
> A Spring Boot application deployed via ArgoCD into the `demo-apps` namespace, featuring OpenTelemetry instrumentation and support for load testing and chaos engineering. > A Spring Bootbased veterinary clinic application deployed via ArgoCD into the demo-apps namespace.
## 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 building modern Java applications. This service is scaffolded using the Backstage Application Migration Factory template and integrates observability, load testing, and chaos engineering capabilities. Petclinic Demo Jonathan Scaf 2 is a deployment of the Spring PetClinic application, a sample project showcasing Spring Boot capabilities. This service provides a web-based interface for managing veterinary clinic operations, including scheduling appointments, managing pet records, and tracking visits. It is designed to demonstrate modern application deployment practices, including GitOps workflows, OpenTelemetry instrumentation, and integration with Kubernetes.
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. The application is scaffolded using the Backstage Application Migration Factory template, which overlays CI/CD workflows and observability configurations. It is continuously deployed via ArgoCD, ensuring that changes pushed to the repository are automatically synced to the Kubernetes cluster.
## 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 service is based on the Spring PetClinic application, cloned from [https://github.com/spring-projects/spring-petclinic](https://github.com/spring-projects/spring-petclinic). - The application is based on the Spring PetClinic project, cloned from `https://github.com/spring-projects/spring-petclinic`.
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed tracing, metrics, and logging. - OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
- 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 application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each. - The deployment flow includes CI workflows, Kubernetes manifests, and observability configurations integrated into the repository.
## Configuration ## Configuration
| Configuration | Description | | Configuration | Description |
|---|---| |---|---|
| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). | | `spring.profiles.active` | Specifies 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`. | | Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
| OpenTelemetry Collector | Endpoint: `http://otel-collector.monitoring.svc.cluster.local:4318`. | | OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
## Operations ## Operations
@@ -56,16 +56,14 @@ The application provides a web interface for managing veterinary clinics, includ
1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2). 1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
2. Click **History and Rollback**. 2. Click **History and Rollback**.
3. Select the desired revision and click **Rollback**. 3. Select the desired revision and click **Rollback**.
Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the rollback. Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the rollback.
<!-- TODO: FILL IN --> <!-- TODO: FILL IN -->
## 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) - **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)
- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=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 ## Dependencies

View File

@@ -1,85 +1,49 @@
--- ---
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-13T10:50:59+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-andrej2"
--- ---
# Petclinic # Petclinic
> A Spring Bootbased application for managing veterinary clinic operations, including scheduling, customer management, and pet records. > Petclinic service — part of petclinic-demo-andrej2.
## 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 core component of the petclinic-demo-andrej2 system. It is designed to provide functionality for managing pet-related data, including owners, visits, and veterinary records. This service is part of a demonstration project showcasing modern application deployment practices, including GitOps, observability, load testing, and chaos engineering.
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. The service is built using Java and integrates with various platform tools such as ArgoCD for deployment, OpenTelemetry for observability, K6 for load testing, and Chaos Mesh for chaos engineering experiments. It serves as a practical example of how to implement and manage a microservice in a cloud-native environment.
## Repository ## Repository
| Field | Value | | Field | Value |
|---|---| |---------------|-----------------------------------------------------------------------|
| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) | | Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) |
| Branch | main | | Branch | main |
| ArgoCD App | petclinic-demo-jonathan-scaf-2 | | ArgoCD App | petclinic-demo-andrej2 |
| Namespace | demo-apps | | Namespace | demo-apps |
## Architecture ## Architecture
- The Petclinic service is deployed using ArgoCD, targeting the `demo-apps` namespace. <!-- TODO: FILL IN -->
- 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
| Configuration | Description | <!-- TODO: FILL IN -->
|---|---|
| `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. |
| Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. |
## Operations ## Operations
### Local Development <!-- TODO: FILL IN -->
1. Clone the repository:
```bash
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
cd petclinic-demo-jonathan-scaf-2
```
2. Run the application:
- Using Maven:
```bash
./mvnw spring-boot:run
```
- Using Gradle:
```bash
./gradlew bootRun
```
3. Access the application at [http://localhost:8080](http://localhost:8080).
### Deployment
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. 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 ## 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](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`
This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana.
## Dependencies ## Dependencies
- `component:default/argocd-service` - `component:default/argocd-service`
- `resource:default/k6-operator` - `resource:default/k6-operator`
- `resource:default/otel-collector` - `resource:default/otel-collector`
- `resource:default/veterinary-platform`