Compare commits
7 Commits
3577ca78cf
...
documentor
| Author | SHA1 | Date | |
|---|---|---|---|
| fb65cda374 | |||
| 0527720ef5 | |||
| 823a05daf7 | |||
| 16e8a8cd36 | |||
| 4aa5c46eee | |||
| bab34ff3f8 | |||
| 73a01ffebb |
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,44 +1,33 @@
|
||||
```markdown
|
||||
---
|
||||
title: "Platform"
|
||||
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
|
||||
source_entity: "Domain/default/platform"
|
||||
---
|
||||
|
||||
# Platform
|
||||
|
||||
> Platform domain for platform engineering capabilities and tooling.
|
||||
|
||||
## 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
|
||||
|
||||
| Field | Value |
|
||||
|---|---|
|
||||
| Owner | group:default/platform-engineering |
|
||||
| Namespace | default |
|
||||
| Labels | — |
|
||||
| Owner | Namespace | Labels |
|
||||
|--------------------------------|-----------|--------|
|
||||
| group:default/platform-engineering | default | — |
|
||||
|
||||
## Systems
|
||||
|
||||
- `system:default/agentic-agents`
|
||||
- `system:default/cjot-backstage`
|
||||
- `system:default/platform-engineering`
|
||||
|
||||
## Relationships
|
||||
|
||||
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`)
|
||||
<!-- TODO: FILL IN -->
|
||||
|
||||
## Links
|
||||
|
||||
_No links configured._
|
||||
|
||||
## Notes
|
||||
|
||||
Platform domain for platform engineering capabilities and tooling.
|
||||
```
|
||||
_No links configured._
|
||||
Reference in New Issue
Block a user