Documentation of EDP. As a product itself.
Find a file
2024-12-20 13:17:03 +01:00
.vscode chore(backstage-doc): added devbox and README for techdocs-cli local development 2024-12-16 21:55:00 +01:00
design refactor(edp-poc): moved local development code and poc documentation design in respective folders 2024-12-16 22:21:17 +01:00
docs doc(pos-doc): refactored README 2024-12-20 13:17:03 +01:00
edp-backstage-integration Update edp-backstage-integration/catalog-info.yaml 2024-12-18 12:31:54 +00:00
live-preview-integration feat(backstage-doc): created mkdocs outline, refactored docs structure 2024-12-16 23:04:31 +01:00
mkdocs.yaml doc(pos-doc): refactored README 2024-12-20 13:17:03 +01:00
README.md doc(pos-doc): refactored README 2024-12-20 13:17:03 +01:00

🌟 EDP - EdgeDeveloperPlatform

  • Owner: Telekom MMS & T-Systems
  • Date: December 20, 2024
  • Version: Release 1.0.0 ('PoC')

About this Repository

This repo edp-doc is the documentation repository of the EDP product.

About the EDP Product

EDP is a product developed by the IPCEI-CIS subproject 'edge Developer Framework'. The goal is to provide a cutting edge developer experience for developing and delivering applications in the cloud edge continuum.

What EDP contains

The EDP product consists of three parts:

  1. The platform orchestrator, processing declarative 'platform stack' descriptions
  2. The predefined stack for a Demo EDP instance
  3. The documentation

Platform Orchestrator edpbuilder

edpbuilder is a tool to quickly instantiate and manage Internal Development Platforms (IDPs). The Edge Development Platform Builder (edpbuilder) can easily setup a Kubenetes cluster (local kind cluster or OSC instance) and deploy tools to manage the Kubernetes resources and the software lifecicle of an application.

Predefined Demo EDP Stack

There are predefined stack sets for deploying and orchestrating a whole platform.

At the time of writing (version PoC) we provide the Demo EDPas PoC stack.

Demo EDP Stack

The Demo EDP Stack contains the follwing application components:

  • Version-Control: Forgejo
  • CI: Forgejo Actions
  • CD: ArgoCD
  • Monitoring: Grafana, Prometheus, Loki, Promtail
  • SSO: Keycloak
  • Developer Portal: Backstage
  • Secret-Management: OpenBao, external-secrets
  • Infrastructur-Provisioning: Crossplane

One usecase to demonstrate the capabilities and development lifecycle flow through all stack components is the PetClinic Application

Documentation

The EDP documentation is subject to this repo in folder docs. It is created in the mkdocs documentation format and natively embedded in the Backstage TechDocs documentation technology.

Thus it can be read in four ways by

  1. accessing the Backstage portal in a running Demo EDP
  2. accessing the Backstage portal in a Demo EDP setup on your computer
  3. browsing the documentaion repository
  4. browsing in a Backstage simulation on your computer