Stephan Lo
82d424aeca
- Remove Backstage component page (not in product structure) - Add editorial status alert to all draft pages with: * Jira ticket reference placeholder * Assignee field * Draft status indicator * Last updated date * TODO checklist for completion - Update component template with editorial header - Use Docsy alert shortcode (warning style) for professional appearance
87 lines
2.6 KiB
Markdown
87 lines
2.6 KiB
Markdown
---
|
|
title: "Components"
|
|
linkTitle: "Components"
|
|
weight: 2
|
|
description: >
|
|
Overview of EDP platform components and their integration.
|
|
---
|
|
|
|
{{% alert title="Draft" color="warning" %}}
|
|
**Editorial Status**: This page is currently being developed.
|
|
|
|
* **Jira Ticket**: TBD
|
|
* **Assignee**: Team
|
|
* **Status**: Draft - Overview and template created
|
|
* **Last Updated**: 2025-11-16
|
|
* **TODO**:
|
|
* [ ] Document each component based on product structure
|
|
* [ ] Add component maturity levels
|
|
* [ ] Include integration diagrams
|
|
{{% /alert %}}
|
|
|
|
## Component Overview
|
|
|
|
The Edge Developer Platform consists of multiple integrated components. Each component serves specific purposes in the overall platform architecture.
|
|
|
|
This section provides detailed documentation for each component, including:
|
|
|
|
* Description and purpose
|
|
* Key features and capabilities
|
|
* Repository links and resources
|
|
* Usage instructions and examples
|
|
* Integration points with other components
|
|
|
|
## Core Components
|
|
|
|
### Source Code Management
|
|
|
|
**Forgejo**: Self-hosted Git service with repository management, issue tracking, and collaboration features.
|
|
|
|
**GitLab**: Enterprise-grade Git repository management with CI/CD integration.
|
|
|
|
### Container Orchestration
|
|
|
|
**Kubernetes**: Container orchestration platform for deploying and managing containerized applications.
|
|
|
|
### CI/CD & Automation
|
|
|
|
**Woodpecker**: Lightweight CI/CD server with pipeline automation.
|
|
|
|
**GARM**: GitHub Actions-compatible runner manager for self-hosted environments.
|
|
|
|
**ArgoCD**: GitOps continuous delivery tool for Kubernetes.
|
|
|
|
### Developer Portal
|
|
|
|
**Backstage**: Developer portal providing unified interface for platform services, documentation, and tooling.
|
|
|
|
### Observability
|
|
|
|
**VictoriaMetrics**: Time-series database for metrics storage and querying.
|
|
|
|
**Prometheus**: Metrics collection and alerting.
|
|
|
|
**Grafana**: Visualization and dashboards for metrics and logs.
|
|
|
|
### Infrastructure as Code
|
|
|
|
**Terraform**: Infrastructure provisioning and management.
|
|
|
|
**Crossplane**: Kubernetes-native infrastructure management.
|
|
|
|
## Component Status
|
|
|
|
Each component page includes current status and maturity level. Check individual component documentation for detailed information.
|
|
|
|
## Template for Component Documentation
|
|
|
|
When documenting a component, include:
|
|
|
|
1. **Overview**: Brief description and purpose
|
|
2. **Key Features**: Main capabilities and use cases
|
|
3. **Architecture**: How it fits into EDP
|
|
4. **Getting Started**: Quick start guide
|
|
5. **Usage Examples**: Common scenarios and patterns
|
|
6. **Repository**: Link to source code and additional resources
|
|
7. **Integration**: Connection points with other components
|
|
8. **Status**: Current maturity level
|