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

Compare commits

base: validate:a91b1fcf59de34e77cc7f5d26c052defad417bfa
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
a91b1fcf59 ... 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
4 changed files with 43 additions and 138 deletions
Expand all files Collapse all files

26
catalog/component/default/petclinic-demo-jonathan-scaf-2/README.md
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-05T11:02:41+00:00" generated_at: "2026-05-05T10:41:16+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–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 ## 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 ## Repository
| Field | Value | | 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 | | 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 application is based on the Spring PetClinic project, cloned from `https://github.com/spring-projects/spring-petclinic`. - 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 observability for traces, metrics, and logs. - 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. - 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
| Configuration | Description | | Configuration | Description |
|---|---| |---|---|
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). | | `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. | | Database URLs | H2: `jdbc:h2:mem:<uuid>` (default), MySQL: `docker-compose.yml` service `mysql`, PostgreSQL: `docker-compose.yml` service `postgres`. |
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` | | OpenTelemetry Collector | Endpoint: `http://otel-collector.monitoring.svc.cluster.local:4318`. |
## Operations ## 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). 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**: [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`. - **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

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

@@ -1,46 +1,45 @@
--- ---
title: "Petclinic Service" title: "Petclinic"
generated_by: documentor-agent generated_by: documentor-agent
generated_at: "2026-05-13T10:51:17+00:00" generated_at: "2026-05-05T10:06:42+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-andrej2" source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
--- ---
# Petclinic Service # Petclinic
> A Spring Boot application for managing veterinary clinics, including scheduling, customer management, and pet records. > A Spring Boot–based application for managing veterinary clinic operations, including scheduling, customer management, and pet records.
## Overview ## Overview
The Petclinic service is a Spring Boot application designed to manage veterinary clinic operations. It provides features such as scheduling appointments, managing customer and pet records, and viewing clinic information. Originally developed as a sample application by the Spring community, this service has been adapted and deployed using Backstage templates for enhanced observability and deployment automation. 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 can be run locally or deployed in containerized environments. It is instrumented with OpenTelemetry for comprehensive observability and integrates with Grafana for monitoring and alerting. 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 ## Repository
| Field | Value | | Field | Value |
|---|---| |---|---|
| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) | | Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
| Branch | main | | Branch | main |
| ArgoCD App | petclinic-demo-andrej2 | | ArgoCD App | petclinic-demo-jonathan-scaf-2 |
| Namespace | demo-apps | | Namespace | demo-apps |
## Architecture ## Architecture
- The service is scaffolded using the Backstage Application Migration Factory template. - The Petclinic service is deployed using ArgoCD, targeting the `demo-apps` namespace.
- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace. - OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed observability for traces, metrics, and logs.
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed traces, metrics, and logs. - The application uses Spring Boot for rapid development and deployment, with support for both in-memory and external databases.
- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each database type. - Continuous integration and deployment workflows are managed through Backstage and ArgoCD, ensuring seamless updates and rollbacks.
- Observability is integrated with Grafana, providing dashboards and alerts for monitoring service health and performance.
## 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 | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. | | Database URLs | `jdbc:h2:mem:<uuid>` for H2, or external database URLs for MySQL/PostgreSQL. |
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` | | Environment Variables | Used for database credentials when running MySQL/PostgreSQL containers. |
## Operations ## Operations
@@ -48,8 +47,8 @@ The application supports multiple database configurations, including in-memory H
1. Clone the repository: 1. Clone the repository:
```bash ```bash
git clone https://gitea.kyndemo.live/validate/petclinic-demo-andrej2.git git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
cd petclinic-demo-andrej2 cd petclinic-demo-jonathan-scaf-2
``` ```
2. Run the application: 2. Run the application:
- Using Maven: - Using Maven:
@@ -64,27 +63,23 @@ The application supports multiple database configurations, including in-memory H
### Deployment ### Deployment
Changes pushed to the `main` branch are automatically synced to the `demo-apps` namespace by ArgoCD. To roll back, use the ArgoCD UI or revert the commit in Git. 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**.
### Database Setup Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the rollback.
- Default: In-memory H2 database.
- Persistent options: MySQL or PostgreSQL, with Docker or `docker-compose` configurations.
### Rollback
1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-andrej2).
2. Select **History and Rollback**.
3. Choose the desired revision and click **Rollback**.
## Observability ## Observability
- **Grafana Dashboard**: [View Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic) - **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, filter by `app=petclinic`. - **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`
- OpenTelemetry instrumentation is enabled for traces, metrics, and logs.
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`

79
catalog/component/default/sonar-test-nest4/README.md
View File

@@ -1,79 +0,0 @@
---
title: "sonar-test-nest4"
generated_by: documentor-agent
generated_at: "2026-05-18T09:44:21+00:00"
human_edited: false
source_entity: "Component/default/sonar-test-nest4"
source_repo: "https://gitea.kyndemo.live/validate/sonar-test-nest4"
---
## Overview
`sonar-test-nest4` is a stateless microservice built using the `typescript-nestjs` runtime. It was scaffolded from the **Create Microservice** golden-path template on the Kyndryl Platform. The service provides a REST API for managing items, including endpoints for CRUD operations. It is designed to be lightweight, scalable, and observable, with integrated OpenTelemetry instrumentation and Prometheus metrics.
This service plays a key role in the demo-apps domain, serving as a foundational component for item management workflows. It is deployed via Humanitec to an AKS cluster, with CI/CD pipelines managed through Gitea Actions. Observability is enabled through Grafana dashboards and Prometheus metrics, ensuring operational insights and performance monitoring.
## Repository
| Field | Value |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| Source Repo | [sonar-test-nest4](https://gitea.kyndemo.live/validate/sonar-test-nest4) |
| Branch | `dev` |
| ArgoCD App | — |
| Namespace | `dev` |
## Architecture
`sonar-test-nest4` follows a modern microservice architecture:
- **Runtime**: `typescript-nestjs`
- **Container Port**: `3000`
- **Endpoints**:
- `/api/items` for CRUD operations
- `/health` for health checks
- `/metrics` for Prometheus metrics
- **Deployment**:
- Images are built and pushed to Azure Container Registry (ACR).
- Humanitec manages deployments to AKS using Score files.
- **CI/CD**:
- Gitea Actions workflows (`build-push.yml` and `deploy-humanitec.yml`) automate build, test, and deployment processes.
- **Branch Model**:
- `dev` → `staging` → `prod` → `main` (system of record).
## Configuration
| Config Key | Value |
|------------------|--------------------|
| `runtime` | `typescript-nestjs` |
| `health_path` | `/health` |
| `container_port` | `3000` |
## Operations
### Deployment Flow
1. Push changes to the `dev` branch to trigger automatic builds and deployments to the dev environment.
2. Promote changes to `staging` or `prod` via PRs, requiring CI gate and approval.
3. Merge production-ready code to the `main` branch as the system of record.
### Observability
- **Health Check**: `/health` endpoint returns `{"status":"UP"}`.
- **Metrics**: `/metrics` endpoint exposes Prometheus metrics.
- **Grafana Dashboard**: [Opentelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4).
## Observability
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
- Prometheus metrics enabled (`/metrics`).
- OpenTelemetry instrumentation integrated.
## Dependencies
- `api:default/sonar-test-nest4-api`
## Links
- [Humanitec Console](https://console.humanitec.dev/orgs/skillful-wild-chicken-2617/projects/domain-demo-apps)
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
- [Source Repository](https://gitea.kyndemo.live/validate/sonar-test-nest4)

13
catalog/component/default/sonar-test-nest4/_meta.json
View File

@@ -1,13 +0,0 @@
{
"sourceShas": {
"catalog-info.yaml": "5c2be634ddfec05ec6fed8c7b85cb2c8b9ab3c13",
".platform/initialized.md": "24a574f77ac17059b313a824398b9bb19263232e",
"README.md": "4b5a7f83a6729688266ef621748367cbd556ddfe",
"docs/api.md": "86776bdd5e2fbe634709920102282ed589927c5b",
"docs/architecture.md": "00364872501f36d455a6597502481c8422368746",
"docs/index.md": "81f0ec2243665ad41daf93202c872cfc023eb21a"
},
"promptVersion": "1.0",
"generatedAt": "2026-05-18T09:44:33+00:00",
"contentHash": "f915ebba47688cb37836b549477a2d11ff8d46d82974a7d6cba92f5e2090ca32"
}