diff --git a/catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md b/catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md index 466947c..1139c94 100644 --- 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:10+00:00" +generated_at: "2026-05-05T11:02:41+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,66 +9,61 @@ 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 managed with ArgoCD in the `demo-apps` namespace. +> A Spring Boot–based veterinary clinic application deployed via ArgoCD into the demo-apps namespace. ## Overview -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. +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 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. +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 | Field | Value | |---|---| | Source Repo | [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` | +| Branch | main | +| ArgoCD App | petclinic-demo-jonathan-scaf-2 | +| Namespace | demo-apps | ## Architecture -- 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 comprehensive observability. +- 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. - 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 and load-testing tools. +- The deployment flow includes CI workflows, Kubernetes manifests, and observability configurations integrated into the repository. ## Configuration | Configuration | Description | |---|---| -| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default H2). | -| Database URLs | H2: `jdbc:h2:mem:`; MySQL and PostgreSQL require external setup. | +| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). | +| Database URLs | `jdbc:h2:mem:` for H2, or Docker-based MySQL/PostgreSQL configurations. | | OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` | ## Operations -### Development Workflow +- **Development Workflow**: + ```bash + git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git + cd petclinic-demo-jonathan-scaf-2 + # make changes, then: + git add . && git commit -m "your change" && git push origin main + ``` + ArgoCD automatically syncs changes to the `demo-apps` namespace. -```bash -git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git -cd petclinic-demo-jonathan-scaf-2 -# make changes, then: -git add . && git commit -m "your change" && git push origin main -``` +- **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. -ArgoCD monitors the repository and 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. + ## Observability -This service has OpenTelemetry auto-instrumentation enabled. Traces, metrics, and logs are exported to the OTel Collector and visualized in Grafana. - - **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. +- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`. ## Dependencies