validate/platform-docs
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: validate:documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-ceb419154e01
Branches Tags
validate:main validate:documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-ceb419154e01 validate:documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-cd01e135d4a8
..
compare: validate:documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-cd01e135d4a8
Branches Tags
validate:main validate:documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-ceb419154e01 validate:documentor-agent-component-default-petclinic-demo-jonathan-scaf-2-doc-cd01e135d4a8

1 Commits
documentor ... documentor

Author SHA1 Message Date
demo-bot
3f5491f617 docs: generate README for component/default/petclinic-demo-jonathan-scaf-2 [documentor-agent] 2026-05-05 10:41:28 +00:00
2 changed files with 64 additions and 64 deletions
Expand all files Collapse all files

49
catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md
View File

@@ -1,7 +1,7 @@
---
title: "Petclinic Demo Jonathan Scaf 2"
generated_by: documentor-agent
generated_at: "2026-05-05T10:49:39+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,13 +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 integrated with OpenTelemetry, ArgoCD, and Chaos Mesh.
> 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 deployment integrates modern DevOps tools and practices, including ArgoCD for continuous delivery, OpenTelemetry for observability, and Chaos Mesh for chaos engineering experiments.
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 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.
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
@@ -28,53 +28,44 @@ The application provides a web interface for managing veterinary clinics, includ
## 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.
- 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.
- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each.
## Configuration
| Configuration | Description |
|---|---|
| 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`. |
| `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
### Deployment Workflow
1. Clone the repository:
- **Development Workflow**:
```bash
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
cd petclinic-demo-jonathan-scaf-2
```
2. Make changes and push:
```bash
# make changes, then:
git add . && git commit -m "your change" && git push origin main
```
3. ArgoCD automatically syncs changes to the `demo-apps` namespace.
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**.
- **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.
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)
- OpenTelemetry instrumentation is enabled, exporting traces, metrics, and logs to the OTel Collector.
_Not configured — see platform observability docs._
- **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

69
catalog/component/default/petclinic/README.md
View File

@@ -1,21 +1,21 @@
---
title: "Petclinic Service"
title: "Petclinic"
generated_by: documentor-agent
generated_at: "2026-05-05T10:41:37+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"
---
# Petclinic Service
# Petclinic
> A Spring Boot–based 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 a comprehensive solution for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. Originally developed as a sample application by the Spring community, this service has been adapted and deployed as part of the `petclinic-demo-jonathan-scaf-2` system.
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 application supports multiple database configurations, including in-memory H2, MySQL, and PostgreSQL, and is designed to be easily deployable in containerized environments. It includes OpenTelemetry instrumentation for observability and integrates with ArgoCD for continuous deployment. The service plays a critical role in the broader veterinary platform, serving as the primary interface for clinic management.
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
@@ -28,45 +28,54 @@ The application supports multiple database configurations, including in-memory H
## Architecture
- The Petclinic service is scaffolded using the Application Migration Factory Backstage template.
- Deployment flow:
1. Source code cloned from the original Spring Petclinic repository.
2. Backstage overlays applied for catalog entity creation and CI workflows.
3. OpenTelemetry auto-instrumentation injected via Kustomize overlays.
4. ArgoCD Application created targeting the `demo-apps` namespace.
5. Continuous sync from the `main` branch via ArgoCD.
- Observability is enabled through OpenTelemetry, with metrics and traces visualized in Grafana.
- 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` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| Database URL | For H2: `jdbc:h2:mem:<uuid>` (printed at startup). |
| MySQL Docker | `docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:9.6` |
| PostgreSQL Docker | `docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.3` |
| `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
- **Local Development**:
1. Clone the repository: `git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git`.
2. Start the application using Maven: `./mvnw spring-boot:run` or Gradle: `./gradlew bootRun`.
3. Access the application at `http://localhost:8080`.
### Local Development
- **Container Build**:
Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`.
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).
- **Rollback**:
1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-jonathan-scaf-2).
2. Use the "History and Rollback" feature to revert to a previous version.
### Deployment
<!-- TODO: FILL IN -->
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
- **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 with label selector `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`
This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana.
## Dependencies