Compare commits
45 Commits
documentor
...
documentor
| Author | SHA1 | Date | |
|---|---|---|---|
| fb65cda374 | |||
| 0527720ef5 | |||
| 823a05daf7 | |||
| 16e8a8cd36 | |||
| 4aa5c46eee | |||
| bab34ff3f8 | |||
| 73a01ffebb | |||
| 3577ca78cf | |||
| c05892070f | |||
| ea04340ef8 | |||
| 5d2e668c68 | |||
| 841a34877b | |||
| e4f1f8c9cb | |||
| 753a1fcb44 | |||
| 8483ca9768 | |||
| 040a26578d | |||
| a91b1fcf59 | |||
| b6af57adef | |||
| da4ea18d47 | |||
| 5d00f2af4c | |||
| 8179b94c8d | |||
| 27da605859 | |||
| 7529b38918 | |||
| 2d230146e7 | |||
| a47b057727 | |||
| 9f3fd7cd45 | |||
| 79ad2b2ed7 | |||
| 069ac897b2 | |||
| fc28011537 | |||
| 3b72673506 | |||
| 79621c8048 | |||
| d078fb4a95 | |||
| 04ac04d90a | |||
| 1c0e9de289 | |||
| eb74b27324 | |||
| 1e4eb91c10 | |||
| 66328cc005 | |||
| 9c74ca2ad1 | |||
| 2c64d74218 | |||
| 0aba4ac987 | |||
| 33b5b4506d | |||
| 13426e0f99 | |||
| 2cc073baf5 | |||
| 49c0442fff | |||
| e6065b0c5f |
90
catalog/component/default/petclinic-demo-andrej4/README.md
Normal file
90
catalog/component/default/petclinic-demo-andrej4/README.md
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
---
|
||||||
|
title: "Petclinic Demo Application"
|
||||||
|
generated_by: documentor-agent
|
||||||
|
generated_at: "2026-05-28T09:07:15+00:00"
|
||||||
|
human_edited: false
|
||||||
|
source_entity: "Component/default/petclinic-demo-andrej4"
|
||||||
|
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-andrej4"
|
||||||
|
---
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The **Petclinic Demo Application** is a deployment of the Spring PetClinic sample application, tailored for demonstration purposes. It showcases a modern Java-based microservice architecture, leveraging Spring Boot for rapid development and deployment. The application is deployed via ArgoCD into the `demo-apps` namespace and includes integrations for observability, load testing, and chaos engineering.
|
||||||
|
|
||||||
|
This service plays a critical role in demonstrating best practices for application lifecycle management, including CI/CD workflows, OpenTelemetry instrumentation, and Kubernetes-based deployments. It serves as a reference implementation for teams adopting similar technologies and workflows.
|
||||||
|
|
||||||
|
## Repository
|
||||||
|
|
||||||
|
| Property | Value |
|
||||||
|
|----------------|---------------------------------------------------------------------------------------------------------|
|
||||||
|
| **Source Repo**| [Petclinic Demo Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej4) |
|
||||||
|
| **Branch** | `main` |
|
||||||
|
| **ArgoCD App** | [petclinic-demo-andrej4](https://argocd.kyndemo.live/applications/petclinic-demo-andrej4) |
|
||||||
|
| **Namespace** | `demo-apps` |
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
The Petclinic Demo Application is built on the Spring Boot framework and deployed as a containerized service in Kubernetes. Key architectural components include:
|
||||||
|
|
||||||
|
- **Spring Boot Application**: The core service, providing RESTful APIs and a web interface.
|
||||||
|
- **Database**: Configurable to use H2 (in-memory), MySQL, or PostgreSQL, depending on the active profile.
|
||||||
|
- **OpenTelemetry Integration**: Auto-instrumentation for tracing, metrics, and logs, exported to an OTel Collector.
|
||||||
|
- **ArgoCD**: Continuous deployment and synchronization from the `main` branch.
|
||||||
|
- **K6 Load Testing**: Configured for performance testing.
|
||||||
|
- **Chaos Mesh**: Enabled for chaos engineering experiments.
|
||||||
|
|
||||||
|
Data flows through the application from user interactions to backend services, with observability tools providing insights into performance and reliability.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
| Configuration Item | Description |
|
||||||
|
|--------------------------|----------------------------------------------------------------------------------------------|
|
||||||
|
| `spring.profiles.active` | Sets the active profile (`default`, `mysql`, `postgres`). |
|
||||||
|
| `OTel Collector URL` | `http://otel-collector.monitoring.svc.cluster.local:4318` |
|
||||||
|
| `Database URL` | Configurable for H2, MySQL, or PostgreSQL. |
|
||||||
|
| `K6 ConfigMap` | `k6-test-petclinic-demo-andrej4` |
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
|
||||||
|
1. Clone the repository:
|
||||||
|
```bash
|
||||||
|
git clone https://gitea.kyndemo.live/validate/petclinic-demo-andrej4.git
|
||||||
|
cd petclinic-demo-andrej4
|
||||||
|
```
|
||||||
|
2. Push changes to the `main` branch:
|
||||||
|
```bash
|
||||||
|
git add . && git commit -m "your change" && git push origin main
|
||||||
|
```
|
||||||
|
3. ArgoCD will automatically sync changes to the `demo-apps` namespace.
|
||||||
|
|
||||||
|
### Rollback
|
||||||
|
|
||||||
|
1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic-demo-andrej4).
|
||||||
|
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 is fully instrumented with OpenTelemetry. Observability data is visualized in Grafana.
|
||||||
|
|
||||||
|
- **Grafana Dashboard**: [View Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-andrej4)
|
||||||
|
- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-andrej4`.
|
||||||
|
|
||||||
|
_Not configured — see platform observability docs for additional details._
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
- `component:default/argocd-service`
|
||||||
|
- `resource:default/k6-operator`
|
||||||
|
- `resource:default/otel-collector`
|
||||||
|
|
||||||
|
## Links
|
||||||
|
|
||||||
|
- [Live Application](https://petclinic-demo-andrej4.kyndemo.live)
|
||||||
|
- [Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej4)
|
||||||
|
- [ArgoCD App](https://argocd.kyndemo.live/applications/petclinic-demo-andrej4)
|
||||||
|
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-demo-andrej4)
|
||||||
12
catalog/component/default/petclinic-demo-andrej4/_meta.json
Normal file
12
catalog/component/default/petclinic-demo-andrej4/_meta.json
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
{
|
||||||
|
"sourceShas": {
|
||||||
|
"catalog-info.yaml": "7f8e08e4d71a45033f49d9190e35fd08ebbb7645",
|
||||||
|
"README.md": "ef9b745ac26efecf8340b75eea18b8151ba7a86e",
|
||||||
|
"docs/adr/index.md": "b9a0b93743cf579be35101bbc63b29356be2849f",
|
||||||
|
"docs/index.md": "f7bef9b17f650992e3a89fbecf37eb0ea948b8e0",
|
||||||
|
"docs/runbooks/index.md": "f9796c4d1a113b786df89cd74dee0f50d98d6025"
|
||||||
|
},
|
||||||
|
"promptVersion": "1.0",
|
||||||
|
"generatedAt": "2026-05-28T09:07:25+00:00",
|
||||||
|
"contentHash": "625799bc84a8ff7004d26604e1d76286e95b9a3617abf6c014146a04202ff719"
|
||||||
|
}
|
||||||
@@ -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-05T10:49:39+00:00"
|
generated_at: "2026-05-05T11:02:41+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,72 +9,61 @@ source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2
|
|||||||
|
|
||||||
# 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–based veterinary clinic application deployed via ArgoCD into the demo-apps namespace.
|
||||||
|
|
||||||
## Overview
|
## 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 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 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 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
|
## Repository
|
||||||
|
|
||||||
| Field | Value |
|
| 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 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](https://github.com/spring-projects/spring-petclinic).
|
- 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.
|
- 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.
|
- 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.
|
- The deployment flow includes CI workflows, Kubernetes manifests, and observability configurations integrated into the repository.
|
||||||
|
|
||||||
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
|
||||||
|
|
||||||
| Configuration | Description |
|
| Configuration | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| Environment Variables | `spring.profiles.active` for database configuration (`mysql`, `postgres`, or `default` for H2). |
|
| `spring.profiles.active` | Specifies the active Spring profile (`mysql`, `postgres`, or default `h2`). |
|
||||||
| Database | Default is H2; supports MySQL and PostgreSQL with Docker or Docker Compose. |
|
| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
|
||||||
| Observability | OpenTelemetry endpoint: `http://otel-collector.monitoring.svc.cluster.local:4318`. |
|
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Deployment Workflow
|
- **Development Workflow**:
|
||||||
1. Clone the repository:
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
|
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
|
||||||
cd petclinic-demo-jonathan-scaf-2
|
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
|
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
|
- **Rollback**:
|
||||||
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**: [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)
|
- **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)
|
||||||
- OpenTelemetry instrumentation is enabled, exporting traces, metrics, and logs to the OTel Collector.
|
- **Alerting**: Configured via Grafana with label selector `app.kubernetes.io/instance=petclinic-demo-jonathan-scaf-2`.
|
||||||
|
|
||||||
_Not configured — see platform observability docs._
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
|
|
||||||
|
|||||||
@@ -1,76 +1,90 @@
|
|||||||
---
|
---
|
||||||
title: "Petclinic Service"
|
title: "Petclinic Service"
|
||||||
generated_by: documentor-agent
|
generated_by: documentor-agent
|
||||||
generated_at: "2026-05-05T10:41:37+00:00"
|
generated_at: "2026-05-13T10:51:17+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-jonathan-scaf-2"
|
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-andrej2"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Petclinic Service
|
# Petclinic Service
|
||||||
|
|
||||||
> A Spring Boot–based application for managing veterinary clinic operations, including scheduling, customer management, and pet records.
|
> A Spring Boot application for managing veterinary clinics, including scheduling, customer management, and pet records.
|
||||||
|
|
||||||
## Overview
|
## 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 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 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.
|
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.
|
||||||
|
|
||||||
## Repository
|
## Repository
|
||||||
|
|
||||||
| Field | Value |
|
| Field | Value |
|
||||||
|---|---|
|
|---|---|
|
||||||
| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2) |
|
| Source Repo | [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic-demo-andrej2) |
|
||||||
| Branch | main |
|
| Branch | main |
|
||||||
| ArgoCD App | petclinic-demo-jonathan-scaf-2 |
|
| ArgoCD App | petclinic-demo-andrej2 |
|
||||||
| Namespace | demo-apps |
|
| Namespace | demo-apps |
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
- The Petclinic service is scaffolded using the Application Migration Factory Backstage template.
|
- The service is scaffolded using the Backstage Application Migration Factory template.
|
||||||
- Deployment flow:
|
- Deployment is managed via ArgoCD, which continuously syncs the `main` branch to the `demo-apps` namespace.
|
||||||
1. Source code cloned from the original Spring Petclinic repository.
|
- OpenTelemetry auto-instrumentation is applied via Kustomize overlays, enabling detailed traces, metrics, and logs.
|
||||||
2. Backstage overlays applied for catalog entity creation and CI workflows.
|
- The application supports multiple database configurations, including H2 (default), MySQL, and PostgreSQL, with profiles for each database type.
|
||||||
3. OpenTelemetry auto-instrumentation injected via Kustomize overlays.
|
- Observability is integrated with Grafana, providing dashboards and alerts for monitoring service health and performance.
|
||||||
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
|
||||||
|
|
||||||
| Configuration | Description |
|
| Configuration | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
|
| `spring.profiles.active` | Sets the active Spring profile (`mysql`, `postgres`, or default `h2`). |
|
||||||
| Database URL | For H2: `jdbc:h2:mem:<uuid>` (printed at startup). |
|
| Database URLs | `jdbc:h2:mem:<uuid>` for H2, or Docker-based MySQL/PostgreSQL configurations. |
|
||||||
| 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` |
|
| OpenTelemetry Endpoint | `http://otel-collector.monitoring.svc.cluster.local:4318` |
|
||||||
| PostgreSQL Docker | `docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:18.3` |
|
|
||||||
|
|
||||||
## Operations
|
## 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`.
|
|
||||||
|
|
||||||
- **Container Build**:
|
1. Clone the repository:
|
||||||
Use the Spring Boot build plugin: `./mvnw spring-boot:build-image`.
|
```bash
|
||||||
|
git clone https://gitea.kyndemo.live/validate/petclinic-demo-andrej2.git
|
||||||
|
cd petclinic-demo-andrej2
|
||||||
|
```
|
||||||
|
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**:
|
### Deployment
|
||||||
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.
|
|
||||||
|
|
||||||
<!-- TODO: FILL IN -->
|
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.
|
||||||
|
|
||||||
|
### Database Setup
|
||||||
|
|
||||||
|
- 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**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic).
|
- **Grafana Dashboard**: [View Dashboard](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, filter by `app=petclinic`.
|
||||||
- **Alerts**: Configured via Grafana with label selector `app=petclinic`.
|
- OpenTelemetry instrumentation is enabled for traces, metrics, and logs.
|
||||||
|
|
||||||
## 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
Normal file
79
catalog/component/default/sonar-test-nest4/README.md
Normal file
@@ -0,0 +1,79 @@
|
|||||||
|
---
|
||||||
|
title: "sonar-test-nest4"
|
||||||
|
generated_by: documentor-agent
|
||||||
|
generated_at: "2026-05-21T08:45:51+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 critical role in the demo-apps domain, serving as a testbed for platform capabilities such as CI/CD pipelines, observability, and load testing. It is managed via Humanitec and deployed to Azure Kubernetes Service (AKS) using Score-based configurations.
|
||||||
|
|
||||||
|
## 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 with the following components:
|
||||||
|
|
||||||
|
- **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 API triggers deployments to AKS using Score-based configurations.
|
||||||
|
- **CI/CD**:
|
||||||
|
- Gitea Actions workflows (`build-push.yml` and `deploy-humanitec.yml`) automate build, test, and deployment processes.
|
||||||
|
- Promotion between environments (`dev → staging → prod`) is gated by CI checks and manual approvals.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
| Config Key | Value |
|
||||||
|
|------------------|--------------------|
|
||||||
|
| `runtime` | `typescript-nestjs` |
|
||||||
|
| `health_path` | `/health` |
|
||||||
|
| `container_port` | `3000` |
|
||||||
|
|
||||||
|
Additional configuration options are managed via `.platform/config.yaml` and Humanitec score files.
|
||||||
|
|
||||||
|
## 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 checks and one approval.
|
||||||
|
3. Use Backstage's CI/CD tab to monitor and trigger promotions between environments.
|
||||||
|
|
||||||
|
### Runbook Notes
|
||||||
|
|
||||||
|
- **Health Check**: Verify service health via `/health`.
|
||||||
|
- **Metrics**: Access Prometheus metrics at `/metrics`.
|
||||||
|
- **Load Testing**: K6 is enabled for load testing, with configurations stored in the `k6-test-sonar-test-nest4` ConfigMap.
|
||||||
|
|
||||||
|
## Observability
|
||||||
|
|
||||||
|
- **Grafana Dashboard**: [OpenTelemetry Application Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4)
|
||||||
|
- **Prometheus Metrics**: Exposed at `/metrics` on port `3000`.
|
||||||
|
|
||||||
|
## 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
Normal file
13
catalog/component/default/sonar-test-nest4/_meta.json
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"sourceShas": {
|
||||||
|
"catalog-info.yaml": "aa72b708c50b03b5dd454112e1f50ab88546e586",
|
||||||
|
".platform/initialized.md": "24a574f77ac17059b313a824398b9bb19263232e",
|
||||||
|
"README.md": "393357c07b620a60ef22f449987d9195d533dd10",
|
||||||
|
"docs/api.md": "86776bdd5e2fbe634709920102282ed589927c5b",
|
||||||
|
"docs/architecture.md": "00364872501f36d455a6597502481c8422368746",
|
||||||
|
"docs/index.md": "81f0ec2243665ad41daf93202c872cfc023eb21a"
|
||||||
|
},
|
||||||
|
"promptVersion": "1.0",
|
||||||
|
"generatedAt": "2026-05-21T08:46:06+00:00",
|
||||||
|
"contentHash": "a82efb2e2e92a9bcb63354c3faab85a4f8438528764c04da61699539d261fa17"
|
||||||
|
}
|
||||||
@@ -1,44 +1,33 @@
|
|||||||
```markdown
|
|
||||||
---
|
---
|
||||||
title: "Platform"
|
title: "Platform"
|
||||||
generated_by: documentor-agent
|
generated_by: documentor-agent
|
||||||
generated_at: "2026-05-05T10:06:41+00:00"
|
generated_at: "2026-05-28T11:56:08+00:00"
|
||||||
human_edited: false
|
human_edited: false
|
||||||
source_entity: "Domain/default/platform"
|
source_entity: "Domain/default/platform"
|
||||||
---
|
---
|
||||||
|
|
||||||
# Platform
|
|
||||||
|
|
||||||
> Platform domain for platform engineering capabilities and tooling.
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The Platform domain serves as the central hub for platform engineering capabilities and tooling within the organization. It encompasses systems and tools that enable efficient development, deployment, and management of software across the organization. This domain is designed to provide foundational services and frameworks that support the broader engineering ecosystem.
|
The Platform domain encompasses platform engineering capabilities and tooling. It serves as the foundation for enabling teams to build, deploy, and manage applications efficiently. This domain focuses on providing shared services, infrastructure, and tools that streamline development workflows and enhance operational reliability.
|
||||||
|
|
||||||
The systems within this domain are critical for ensuring scalability, reliability, and developer productivity. By consolidating platform-related resources and expertise, the Platform domain helps streamline operations and fosters innovation.
|
By centralizing platform engineering efforts, this domain supports scalability, consistency, and innovation across the organization. It includes systems and tools that empower developers and operational teams to focus on delivering business value while reducing the complexity of managing underlying infrastructure.
|
||||||
|
|
||||||
## Ownership
|
## Ownership
|
||||||
|
|
||||||
| Field | Value |
|
| Owner | Namespace | Labels |
|
||||||
|---|---|
|
|--------------------------------|-----------|--------|
|
||||||
| Owner | group:default/platform-engineering |
|
| group:default/platform-engineering | default | — |
|
||||||
| Namespace | default |
|
|
||||||
| Labels | — |
|
## Systems
|
||||||
|
|
||||||
|
- `system:default/agentic-agents`
|
||||||
|
- `system:default/cjot-backstage`
|
||||||
|
- `system:default/platform-engineering`
|
||||||
|
|
||||||
## Relationships
|
## Relationships
|
||||||
|
|
||||||
The Platform domain includes the following systems:
|
<!-- TODO: FILL IN -->
|
||||||
|
|
||||||
- **Agentic Agents** (`system:default/agentic-agents`)
|
|
||||||
- **CJOT Backstage** (`system:default/cjot-backstage`)
|
|
||||||
- **Petclinic Demo Jonathan Scaf 2** (`system:default/petclinic-demo-jonathan-scaf-2`)
|
|
||||||
- **Platform Engineering** (`system:default/platform-engineering`)
|
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
_No links configured._
|
_No links configured._
|
||||||
|
|
||||||
## Notes
|
|
||||||
|
|
||||||
Platform domain for platform engineering capabilities and tooling.
|
|
||||||
```
|
|
||||||
Reference in New Issue
Block a user