Michal.Wrobel/edp-doc
1
0
Fork 0
forked from DevFW/edp-doc
Code Pull requests Activity

doc(pos-doc): refactored README

Browse source
This commit is contained in:
Stephan Lo 2024-12-20 13:17:03 +01:00
parent 13bd4343d9
commit 8d17325bcd
5 changed files with 113 additions and 93 deletions
Download patch file Download diff file Expand all files Collapse all files

81
README.md
View file

@ -1,65 +1,58 @@
# 🌟 EdgeDeveloperPlatform - EDP Release 'PoC'
# 🌟 EDP - EdgeDeveloperPlatform
Telekom MMS & T-Systems, December 2024
> * Owner: Telekom MMS & T-Systems
> * Date: December 20, 2024
> * Version: Release 1.0.0 ('PoC')
> **Tagline:** Change the way we work with IDP's.
## About this Repository
---
This repo [`edp-doc`](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW-CICD/edp-doc) is the documentation repository of the **EDP product**.
## 📋 Table of Contents
## About the EDP Product
- [🌟 EdgeDeveloperPlatform - EDP Release 'PoC'](#-edgedeveloperplatform---edp-release-poc)
- [📋 Table of Contents](#-table-of-contents)
- [📖 About the Product](#-about-the-product)
- [🛠️ Application Stack](#️-application-stack)
- [📖 Access our Documentation](#-access-our-documentation)
- [In our Open Sovereign Cloud](#in-our-open-sovereign-cloud)
- [In a local kind cluster](#in-a-local-kind-cluster)
- [In the Forgejo repository](#in-the-forgejo-repository)
- [📝 License](#-license)
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
## 📖 About the Product
The EDP product consists of three parts:
**edpbuilder** is a tool to quickly instantiate and manage **I**nternal **D**evelopment **P**latform's (**IDP**s).
The **E**dge **D**evelopment **P**latform Builder(**edp**builder) 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.
One usecase to demonstrate the capabilities of our tool is the PetClinic Application. (LINK)
1. The platform orchestrator, processing declarative 'platform stack' descriptions
1. The predefined stack for a Demo EDP instance
1. The documentation
### 🛠️ Application Stack
### Platform Orchestrator `edpbuilder`
- **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
[edpbuilder](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/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.
## 📖 Access our Documentation
### Predefined `Demo EDP` Stack
Our documentation is designed to be easily accessible regardless of your environment. Here are three primary ways to view it:
There are predefined stack sets for deploying and orchestrating a whole platform.
### In our Open Sovereign Cloud
At the time of writing (version PoC) we provide the [`Demo EDP`as PoC stack](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW-CICD/stacks).
Our documentation can be easily accessed through a Backstage instance hosted on our Open Sovereign Cloud (OSC). Simply log in to our OSC Backstage platform to read through the documentation.
#### `Demo EDP` Stack
- URL: <https://edf-cc1.cx.fg1.ffm.osc.live/docs/edppoc/component/edp-documentation>
- Username: user1
- Password: PpMpfZYICG9MRRF-3QBY2Zz1-+URYB6+-JRe
The `Demo EDP` Stack contains the follwing application components:
### In a local kind cluster
* 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
Using the edpbuilder, you can set up a local IDP that comes with a Backstage instance containing the documentation.
*[How to set up a local IDP on a kind cluster](docs/userguide/edpbuilder.md)*
One usecase to demonstrate the capabilities and development lifecycle flow through all stack components is the [PetClinic Application](./docs/user-documentation/petclinic.md)
### In the Forgejo repository
If you prefer direct access, the content of our documentation is centrally defined and maintained within the docs folder of this repository.
### Documentation
---
The EDP documentation is subject to this repo in folder [`docs`](./docs/). It is created in the [`mkdocs`](https://www.mkdocs.org/) documentation format and natively embedded in the [`Backstage TechDocs` documentation technology](https://backstage.io/docs/features/techdocs/).
## 📝 License
Thus it can be read in four ways by
[LICENSE]
1. [accessing the Backstage portal in a running Demo EDP](./docs/introduction/index.md#doc-in-backstage-in-a-running-demo-edp)
2. [accessing the Backstage portal in a Demo EDP setup on your computer](./docs/introduction/index.md#doc-in-backstage-in-a-demo-edp-setup-on-your-computer)
3. [browsing the documentaion repository](./docs/introduction/index.md#doc-in-the-repository)
4. [browsing in a Backstage simulation on your computer](./docs/introduction/index.md#doc-in-a-backstage-simulation)