docs: generate README for component/default/petclinic-demo-jonathan-scaf-2 [documentor-agent]

2026-05-05 10:49:51 +00:00
2 changed files with 68 additions and 66 deletions
--- a/catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md
+++ b/catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md
@@ -1,7 +1,7 @@
 ---
 title: "Petclinic Demo Jonathan Scaf 2"
 generated_by: documentor-agent
-generated_at: "2026-05-05T11:02:41+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,61 +9,72 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2

 # Petclinic Demo Jonathan Scaf 2

-> A Spring Boot–based veterinary clinic application deployed via ArgoCD into 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 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.
+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 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.
+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

 | Field | Value |
 |---|---|
-| Source Repo | [Petclinic Demo Jonathan Scaf 2](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 |
 | ArgoCD App | petclinic-demo-jonathan-scaf-2 |
 | Namespace | demo-apps |

 ## Architecture

- 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 observability for traces, metrics, and logs.
+- 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, Kubernetes manifests, and observability configurations integrated into the repository.
+- 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 URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
+| 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 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.
+### 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**: [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`.
+- **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._

 ## Dependencies

--- a/catalog/component/default/petclinic/README.md
+++ b/catalog/component/default/petclinic/README.md
@@ -1,81 +1,72 @@
 ---
-title: "Petclinic"
+title: "Petclinic Service"
 generated_by: documentor-agent
-generated_at: "2026-05-05T10:50:01+00:00"
+generated_at: "2026-05-05T10:41:37+00:00"
 human_edited: false
 source_entity: "Component/default/petclinic"
 source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
 ---

-# Petclinic
+# Petclinic Service

-> A Spring Boot–based application for managing veterinary clinics, including appointments, customers, and pets.
+> 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 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. 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.

-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.
+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.

 ## 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 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.

 ## 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`. |
+| `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` |

 ## Operations

-### Local Development
+- **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`.

-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:
-   - Maven: `./mvnw spring-boot:run`
-   - Gradle: `./gradlew bootRun`
-3. Access the application at [http://localhost:8080](http://localhost:8080).
+- **Container Build**:
+  Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`.

-### Deployment
+- **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.

-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
-
-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**.
+<!-- TODO: FILL IN -->

 ## 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`.
-
-_Not configured — see platform observability docs for additional details._
+- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`.
+- **Alerts**: Configured via Grafana with label selector `app=petclinic`.

 ## Dependencies