Compare commits
1 Commits
c4f7a688fa
...
documentor
| Author | SHA1 | Date | |
|---|---|---|---|
| 3f5491f617 |
@@ -1,90 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@@ -1,12 +0,0 @@
|
||||
{
|
||||
"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"
|
||||
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
|
||||
|
||||
|
||||
@@ -1,60 +1,56 @@
|
||||
---
|
||||
title: "Petclinic Service"
|
||||
title: "Petclinic"
|
||||
generated_by: documentor-agent
|
||||
generated_at: "2026-06-08T16:14:03+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"
|
||||
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2"
|
||||
---
|
||||
|
||||
# Petclinic
|
||||
|
||||
> A Spring Boot–based application for managing veterinary clinic operations, including scheduling, customer management, and pet records.
|
||||
|
||||
## Overview
|
||||
|
||||
The Petclinic service is a Spring Boot application designed to manage veterinary clinic operations, including scheduling appointments, managing pet records, and handling customer information. It serves as a foundational component of the broader Petclinic system, providing essential functionality for veterinary platforms.
|
||||
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.
|
||||
|
||||
This service is built using Java 17 and leverages Spring Boot for rapid development and deployment. It supports multiple database configurations, including in-memory H2, MySQL, and PostgreSQL, making it adaptable to various environments. Observability is integrated via OpenTelemetry, enabling detailed monitoring and performance analysis.
|
||||
|
||||
Petclinic plays a critical role in the system by ensuring reliable and scalable management of veterinary clinic data, while also serving as a demonstration of modern application development practices.
|
||||
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
|
||||
|
||||
| Field | Value |
|
||||
|----------------|-----------------------------------------------------------------------------------------------------------------|
|
||||
| **Source Repo**| [Petclinic Repository](https://gitea.kyndemo.live/validate/petclinic) |
|
||||
| **Branch** | `main` |
|
||||
| **ArgoCD App** | [petclinic](https://argocd.kyndemo.live/applications/petclinic) |
|
||||
| **Namespace** | `demo-apps` |
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| 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 Petclinic service is a Spring Boot application deployed via ArgoCD in the `demo-apps` namespace. It integrates OpenTelemetry for observability and supports multiple database configurations, including H2, MySQL, and PostgreSQL. The deployment process involves continuous synchronization from the `main` branch of the source repository.
|
||||
|
||||
Key architectural components:
|
||||
- **Spring Boot Framework**: Provides the core application structure and dependency management.
|
||||
- **Database Configurations**: Supports H2 (default), MySQL, and PostgreSQL, with profiles for switching between them.
|
||||
- **OpenTelemetry Integration**: Enables tracing, metrics, and logging for detailed observability.
|
||||
- **ArgoCD Deployment**: Ensures continuous delivery and synchronization of application updates.
|
||||
|
||||
<!-- TODO: FILL IN -->
|
||||
- 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 Option | Description |
|
||||
|-------------------------------|-------------------------------------------------------------------------------------------------|
|
||||
| `spring.profiles.active` | Sets the active profile for database configuration (`mysql`, `postgres`, or default `h2`). |
|
||||
| `MYSQL_USER` | MySQL username for database authentication. |
|
||||
| `MYSQL_PASSWORD` | MySQL password for database authentication. |
|
||||
| `POSTGRES_USER` | PostgreSQL username for database authentication. |
|
||||
| `POSTGRES_PASSWORD` | PostgreSQL password for database authentication. |
|
||||
| Configuration | Description |
|
||||
|---|---|
|
||||
| `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
|
||||
|
||||
### Running Locally
|
||||
### Local Development
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://gitea.kyndemo.live/validate/petclinic.git
|
||||
cd petclinic
|
||||
git clone https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf-2.git
|
||||
cd petclinic-demo-jonathan-scaf-2
|
||||
```
|
||||
2. Start the application:
|
||||
2. Run the application:
|
||||
- Using Maven:
|
||||
```bash
|
||||
./mvnw spring-boot:run
|
||||
@@ -65,18 +61,10 @@ Key architectural components:
|
||||
```
|
||||
3. Access the application at [http://localhost:8080](http://localhost:8080).
|
||||
|
||||
### Container Deployment
|
||||
1. Build the container image:
|
||||
```bash
|
||||
./mvnw spring-boot:build-image
|
||||
```
|
||||
2. Run the container:
|
||||
```bash
|
||||
docker run -p 8080:8080 docker.io/library/spring-petclinic:latest
|
||||
```
|
||||
### Deployment
|
||||
|
||||
### Rollback
|
||||
1. Open the [ArgoCD UI](https://argocd.kyndemo.live/applications/petclinic).
|
||||
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**.
|
||||
|
||||
@@ -84,12 +72,10 @@ Alternatively, revert the commit in Git and push — ArgoCD will auto-sync the r
|
||||
|
||||
## Observability
|
||||
|
||||
This service is configured with OpenTelemetry instrumentation. Metrics, traces, 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-service=petclinic)
|
||||
- **OTel Collector Endpoint**: `http://otel-collector.monitoring.svc.cluster.local:4318`
|
||||
|
||||
- **Grafana Dashboard**: [Petclinic Observability](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
|
||||
- **Alerting**: Alerts are configured via Grafana and can be filtered by `app=petclinic`.
|
||||
|
||||
_Additional observability details are available in the platform observability documentation._
|
||||
This service is fully instrumented with OpenTelemetry, providing detailed insights into application performance and health. Alerts and metrics can be monitored via Grafana.
|
||||
|
||||
## Dependencies
|
||||
|
||||
@@ -97,10 +83,3 @@ _Additional observability details are available in the platform observability do
|
||||
- `resource:default/k6-operator`
|
||||
- `resource:default/otel-collector`
|
||||
- `resource:default/veterinary-platform`
|
||||
|
||||
## Links
|
||||
|
||||
- [Live Application](https://petclinic.kyndemo.live)
|
||||
- [Repository](https://gitea.kyndemo.live/validate/petclinic)
|
||||
- [ArgoCD App](https://argocd.kyndemo.live/applications/petclinic)
|
||||
- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-service=petclinic)
|
||||
@@ -1,79 +0,0 @@
|
||||
---
|
||||
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)
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"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,33 +1,44 @@
|
||||
```markdown
|
||||
---
|
||||
title: "Platform"
|
||||
generated_by: documentor-agent
|
||||
generated_at: "2026-05-28T12:04:59+00:00"
|
||||
generated_at: "2026-05-05T10:06:41+00:00"
|
||||
human_edited: false
|
||||
source_entity: "Domain/default/platform"
|
||||
---
|
||||
|
||||
# Platform
|
||||
|
||||
> Platform domain for platform engineering capabilities and tooling.
|
||||
|
||||
## Overview
|
||||
|
||||
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 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.
|
||||
|
||||
By centralizing platform engineering efforts, this domain ensures consistency, scalability, and alignment across various systems and teams. It is a critical component for driving innovation and maintaining high standards in software delivery.
|
||||
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.
|
||||
|
||||
## Ownership
|
||||
|
||||
| Owner | Namespace | Labels |
|
||||
|--------------------------------|-----------|--------|
|
||||
| group:default/platform-engineering | default | — |
|
||||
|
||||
## Systems
|
||||
|
||||
- `system:default/agentic-agents`
|
||||
- `system:default/cjot-backstage`
|
||||
- `system:default/platform-engineering`
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| Owner | group:default/platform-engineering |
|
||||
| Namespace | default |
|
||||
| Labels | — |
|
||||
|
||||
## Relationships
|
||||
|
||||
<!-- TODO: FILL IN -->
|
||||
The Platform domain includes the following systems:
|
||||
|
||||
- **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
|
||||
|
||||
_No links configured._
|
||||
|
||||
## Notes
|
||||
|
||||
Platform domain for platform engineering capabilities and tooling.
|
||||
```
|
||||
Reference in New Issue
Block a user