Documentation of EDP. As a product itself.
Find a file
2024-12-17 11:51:16 +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 adds docu files for all team members 2024-12-17 11:51:16 +01:00
edp-backstage-integration feat(backstage-doc): prooved integration into backstage 2024-12-16 23:48:37 +01:00
live-preview-integration feat(backstage-doc): created mkdocs outline, refactored docs structure 2024-12-16 23:04:31 +01:00
mkdocs.yaml fix(backstage-doc): added missing main mkdocs.yaml 2024-12-17 10:03:31 +01:00
README.md adds docu files for all team members 2024-12-17 11:51:16 +01:00

🌟 EdgeDeveloperPlatform - EDP Release 'PoC' - Franz

Telekom MMS & T-Systems, December 2024

Tagline: Change the way we work with IDP's.


This file describes how you can read the EDP documentation and run and use the platform.

📋 Table of Contents


📖 About the Product

eDF_PoC is a tool to quickly instantiate and manage IDPs. The eDF 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 Fibonacci Go Application.(https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/Franz.Germann/fibonacci_go).

🛠️ Application Stack

  • 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

✔️ Prerequisites

  • Tools you'll need to execute the scripts:
    • go
    • curl
    • jq
    • git
    • openssl
    • docker
    • kind
    • kubectlmikefarah/yq
    • helm

🚀 Installation

  1. Clone the repository:

    git clone https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/edf_poc.git
    cd edf_poc
    
    
  2. List all kind clusters:

    kind get clusters
    Output:
    primary
    shoot
    
    
  3. Delete all clusters:

    kind delete clusters primary shoot
    
    
  4. start edfbuilder

    cd edfbuilder
    git pull
    ./start.sh
    
    
  5. In a second terminal when the edfbuilder is ready:

    ./example.sh
    
    
  6. Get all the passwords:

    ./getpassword.sh
    
    

📖 Access our Documentation

  • 3 ways
    • via backstage in the osc
    • via file structure in forgejo
    • via local backstage in local kind cluster (link to install guide in git repo(seperate file))

📷 Screenshots

[IMAGES]


🤝 Contributing

Contributions are welcome! 🎉

Fork the project.
Create a feature branch (git checkout -b feature/YourFeature).
Commit your changes (git commit -m 'Add a new feature').
Push to the branch (git push origin feature/YourFeature).
Open a Pull Request.

📝 License

[LICENSE]