diff --git a/catalog/system/default/petclinic-argo-doc/README.md b/catalog/system/default/petclinic-argo-doc/README.md new file mode 100644 index 0000000..b7db3d9 --- /dev/null +++ b/catalog/system/default/petclinic-argo-doc/README.md @@ -0,0 +1,53 @@ +--- +title: "Petclinic Argo Documentation System" +generated_by: documentor-agent +generated_at: "2026-06-08T16:22:23+00:00" +human_edited: false +source_entity: "System/default/petclinic-argo-doc" +source_repo: "https://gitea.kyndemo.live/validate/petclinic-argo-doc" +--- + +## Overview + +The **Petclinic Argo Documentation System** is a deployment system managed via ArgoCD, designed to support the **demo-apps** namespace. It integrates observability tools like OpenTelemetry and Grafana, along with load testing capabilities using K6 and chaos engineering via Chaos Mesh. This system is part of the broader **apps** domain and serves as a foundational platform for deploying and managing services such as **petclinic**, **demo-db**, and other related components. + +The system is owned by the **platform-engineering** team and is configured to ensure high reliability and performance for applications deployed in the **demo-apps** namespace. It leverages Kubernetes for orchestration and includes monitoring and alerting capabilities to maintain operational excellence. + +## Ownership + +| Owner | Domain | Namespace | Labels | +|----------------------|--------|-----------|-------------------------------------| +| platform-engineering | apps | default | backstage.io/environment: dev
app.kubernetes.io/managed-by: backstage | + +## Components + +- **petclinic-argo-doc**: The main service deployed via ArgoCD. +- **demo-db**: A database service that is part of the system. +- **petclinic**: A Java-based service included in the system. + +## APIs + +_No APIs declared._ + +## Resources + +- **k6-operator**: Load testing operator for K6. +- **otel-collector**: OpenTelemetry collector for observability. +- **otel-operator**: OpenTelemetry operator for managing observability configurations. +- **veterinary-platform**: A resource supporting the petclinic ecosystem. + +## Relationships + +- **Depends On**: + - **argocd-service**: A service for managing ArgoCD deployments. + - **k6-operator**: For load testing. + - **otel-collector**: For observability data collection. + - **otel-operator**: For managing observability configurations. + - **veterinary-platform**: Supporting resources for the petclinic ecosystem. + +## Links + +- [Live Application](https://petclinic-argo-doc.kyndemo.live) +- [Repository](https://gitea.kyndemo.live/validate/petclinic-argo-doc) +- [ArgoCD App](https://argocd.kyndemo.live/applications/petclinic-argo-doc) +- [Grafana Dashboard](https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=petclinic-argo-doc) \ No newline at end of file