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 51 additions and 37 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: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,37 +9,37 @@ 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 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 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 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 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 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) |
+| 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 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, Kubernetes manifests, and observability configurations integrated into the repository.
+- 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 | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
-| 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

@@ -56,14 +56,16 @@ The application is scaffolded using the Backstage Application Migration Factory
  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)
+- **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

--- a/catalog/component/default/petclinic/README.md
+++ b/catalog/component/default/petclinic/README.md
@@ -1,7 +1,7 @@
 ---
 title: "Petclinic"
 generated_by: documentor-agent
-generated_at: "2026-05-05T11:02:41+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"
@@ -13,9 +13,9 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2

 ## Overview

-The Petclinic service is a Java-based application built using Spring Boot. It provides a comprehensive platform for managing veterinary clinic operations, including scheduling appointments, managing customer and pet records, and handling clinic workflows. Originally sourced from the Spring Petclinic project, this service has been adapted and deployed using Backstage templates to integrate with modern observability and deployment tools.
+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 enhanced observability and integrates with Grafana for monitoring and alerting. The service is part of the broader `petclinic-demo-jonathan-scaf-2` system and is managed via ArgoCD for continuous deployment.
+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,42 +28,54 @@ The application supports multiple database configurations, including in-memory H

 ## Architecture

- The Petclinic service is scaffolded using the Backstage Application Migration Factory template.
- Deployment flow:
-  1. Source code cloned from the original Spring Petclinic repository.
-  2. Backstage overlays applied for CI workflows and catalog entity creation.
-  3. OpenTelemetry auto-instrumentation injected via Kustomize overlays.
-  4. ArgoCD application created targeting the `demo-apps` namespace.
-  5. Continuous sync from the `main` branch ensures up-to-date deployments.
- Observability is enabled with OpenTelemetry, exporting traces, metrics, and logs to the OTel Collector, 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` | Specifies the active Spring profile (`mysql`, `postgres`, or default H2). |
-| Database URLs | JDBC URLs for H2, MySQL, and PostgreSQL databases. |
-| Docker Compose | Predefined services for MySQL and PostgreSQL databases. |
-| OTel Collector Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
+| `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 or Gradle: `./mvnw spring-boot:run` or `./gradlew bootRun`.
-  3. Access the application at `http://localhost:8080`.
+### Local Development

- **Deployment**:
-  - ArgoCD monitors the repository and automatically syncs changes to the `demo-apps` namespace.
-  - Rollback can be performed via the ArgoCD UI or by reverting commits in Git.
+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).

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

 - **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 with label selector `app=petclinic`.
- **Instrumentation**: OpenTelemetry auto-instrumentation enabled.
+- **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