docs: generate README for component/default/petclinic-demo-jonathan-scaf [documentor-agent]
This commit is contained in:
@@ -0,0 +1,57 @@
|
|||||||
|
---
|
||||||
|
title: "Petclinic Demo Jonathan Scaf"
|
||||||
|
generated_by: documentor-agent
|
||||||
|
generated_at: "2026-04-27T13:00:16+00:00"
|
||||||
|
human_edited: false
|
||||||
|
source_entity: "Component/default/petclinic-demo-jonathan-scaf"
|
||||||
|
source_repo: "https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf"
|
||||||
|
---
|
||||||
|
|
||||||
|
# Petclinic Demo Jonathan Scaf
|
||||||
|
|
||||||
|
> Scaffold ArgoCD + Kustomize template.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The Petclinic Demo Jonathan Scaf repository provides a scaffolded setup for deploying applications using ArgoCD and Kustomize. It includes manifest files and overlays for deployment and observability instrumentation. This repository is designed to streamline the deployment process and ensure consistency across environments. It plays a critical role in enabling GitOps workflows for the platform engineering team.
|
||||||
|
|
||||||
|
The repository structure includes ArgoCD application manifests, Backstage component registration files, and overlays for deployment and observability. It supports OpenTelemetry (OTel) instrumentation for enhanced observability of services.
|
||||||
|
|
||||||
|
## Repository
|
||||||
|
|
||||||
|
| Field | Value |
|
||||||
|
|---------------|-------------------------------------------------------------------------------------------|
|
||||||
|
| Source Repo | [https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf](https://gitea.kyndemo.live/validate/petclinic-demo-jonathan-scaf) |
|
||||||
|
| Branch | main |
|
||||||
|
| ArgoCD App | petclinic-demo-jonathan-scaf-dev |
|
||||||
|
| Namespace | default |
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
- The repository is structured to support GitOps workflows using ArgoCD.
|
||||||
|
- It includes overlays for deployment (`deploy/`) and optional OpenTelemetry instrumentation (`otel/`).
|
||||||
|
- The `application.yaml` file defines the ArgoCD application manifest, while `catalog-info.yaml` registers the component in Backstage.
|
||||||
|
- Kustomize is used to manage overlays, enabling modular and environment-specific configurations.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
| Configuration Item | Description |
|
||||||
|
|--------------------|-----------------------------------------------|
|
||||||
|
| `application.yaml` | Defines the ArgoCD application manifest. |
|
||||||
|
| `kustomization.yaml` | Manages overlays for deployment and observability. |
|
||||||
|
| `otel-patch.yaml` | Optional patch for OpenTelemetry instrumentation. |
|
||||||
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
|
- Push changes to the repository to trigger automatic synchronization via ArgoCD.
|
||||||
|
- Ensure overlays are correctly configured for the target environment before deployment.
|
||||||
|
- Use the `otel/` overlay for enabling OpenTelemetry instrumentation if required.
|
||||||
|
|
||||||
|
## Observability
|
||||||
|
|
||||||
|
- OpenTelemetry instrumentation is supported via the `otel/` overlay.
|
||||||
|
- _Not configured — see platform observability docs._
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
_No declared dependencies._
|
||||||
Reference in New Issue
Block a user