edp-doc/README.md

114 lines
2.3 KiB
Markdown
Raw Normal View History

2024-11-28 14:14:49 +00:00
# 🌟 eDF Release 'PoC'
2024-11-28 14:14:49 +00:00
> **Tagline:** Change the way we work with IDP's.
2024-11-28 14:14:49 +00:00
---
2024-11-28 14:14:49 +00:00
## 📋 Table of Contents
2024-11-28 14:14:49 +00:00
- [🌟 eDF Release 'PoC'](#-edf-release-poc)
- [📋 Table of Contents](#-table-of-contents)
- [📖 About the Product](#-about-the-product)
- [🛠️ Application Stack](#-application-stack)
- [✔️ Prerequisites](#-prerequisites)
- [🚀 Installation](#-installation)
- [📷 Screenshots](#-screenshots)
- [🤝 Contributing](#-contributing)
- [📝 License](#-license)
2024-11-28 14:14:49 +00:00
---
2024-11-28 14:14:49 +00:00
## 📖 About the Product
2024-11-28 14:14:49 +00:00
**edf_poc** is a tool to quickly setup and manage IDPs. Part of it is a Kubernetes cluster and a stack of tools to manage Kubernetes resources and the software lifecicle.(https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/Franz.Germann/fibonacci_go).
**why** This project solves the problem of having to manually setup and configure your own cloud environment.
2024-11-28 14:14:49 +00:00
### 🛠️ Application Stack
2024-11-28 14:14:49 +00:00
- **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
2024-11-28 14:14:49 +00:00
---
2024-11-28 14:14:49 +00:00
## ✔️ Prerequisites
2024-11-28 14:14:49 +00:00
- **Tools you'll need to execute the scripts:**
- go
- curl
- jq
- git
- openssl
- docker
- kind
- kubectlmikefarah/yq
- helm
2024-11-28 14:14:49 +00:00
---
2024-11-28 14:14:49 +00:00
## 🚀 Installation
2024-11-28 14:14:49 +00:00
1. Clone the repository:
2024-11-28 14:14:49 +00:00
```bash
git clone https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW/edf_poc.git
cd edf_poc
2. List all kind clusters:
```bash
kind get clusters
Output:
primary
shoot
3. Delete all clusters:
```bash
kind delete clusters primary shoot
4. start edfbuilder
```bash
cd edfbuilder
git pull
./start.sh
5. In a second terminal when the edfbuilder is ready:
```bash
./example.sh
6. Get all the passwords:
```bash
./getpassword.sh
---
## 📷 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]