adds correct readme file and user_documentation.md

2024-12-03 10:55:50 +01:00 · 2024-12-03 10:55:50 +01:00 · 65722bbe6d
commit 65722bbe6d
parent c91444c98c
3 changed files with 155 additions and 30 deletions
--- a/README.md
+++ b/README.md
@ -1,46 +1,114 @@
-# eDF Release 'PoC' [WiP]
+# 🌟 eDF Release 'PoC'

-This is a preliminary README in 'WiP' state - it's just sketching the story and structure of work.
+> **Tagline:** Change the way we work with IDP's.

-When we reach the 'PoC' milestone it will be replaced by a short and concise README as the main documentation entry point for our customers who want to consume the 'edf_poc' product.
+---

-## POC Content Structure
+## 📋 Table of Contents

-* [Part 1 - User documentation](https://jira.telekom-mms.com/browse/IPCEICIS-368)
-* Part 2 - Hands On
-    * [Part 2.1 - Local IdP creation](https://jira.telekom-mms.com/browse/IPCEICIS-765)
-    * [Part 2.2 - OSC IdP creation](https://jira.telekom-mms.com/browse/IPCEICIS-766)
-    * Part 2.1 & 2.2 Use Cases
-        * [Part 2.x.1 - Golden Path template for a Go application](https://jira.telekom-mms.com/browse/IPCEICIS-514)
-        * [Part 2.x.2 - Fibonacci Go application](https://jira.telekom-mms.com/browse/IPCEICIS-759)
-        * [Part 2.x.3 - Forgejo Actions with respect to the Fibonacci CI/CD](https://jira.telekom-mms.com/browse/IPCEICIS-760)
-        * [Part 2.x.4 - Telemetry with respect to the Fibonacci workload](https://jira.telekom-mms.com/browse/IPCEICIS-761)
-        * [Part 2.x.5 - OSC infrastructure with respect to the Fibonacci workload](https://jira.telekom-mms.com/browse/IPCEICIS-762)
-        * [Part 2.x.6 - Additional bells and whistles](https://jira.telekom-mms.com/browse/IPCEICIS-763)
-    * [Part 2.3 - Extended Local IdP creation and orchestration](https://jira.telekom-mms.com/browse/IPCEICIS-767)
-    * Part 2.3 Use Cases
-        * tbd
-* [Part 3 - User documentation](https://jira.telekom-mms.com/browse/IPCEICIS-768)
+- [🌟 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)

+---

-## Content and Story
+## 📖 About the Product

-This is the Storybook of the PoC content structure (content is depicted top right): 
+**eDF_PoC** is a tool to quickly setup 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>).

-![](./content-and-storybook.png)
+### 🛠️ Application Stack

-## Use case content of 2.1 and 2.2 'Hands On'
+- **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

-This is the illustration of the [use cases (aka 'functionality') in the PoC content](https://confluence.telekom-mms.com/display/IPCEICIS/Proof+of+Concept+2024): 
+---

-![](./use-cases.png)
+## ✔️ Prerequisites

-## Technical composition
+- **Tools you'll need to execute the scripts:**
+  - go
+  - curl
+  - jq
+  - git
+  - openssl
+  - docker
+  - kind
+  - kubectlmikefarah/yq
+  - helm

-The 'edf_poc'-product should be as self-contained as possible. 
+---

-Thus all parts coming from upstream repos should have a physical copy in this repo with a reference to the upstream repo. Therefore we need a mapping table from parts here to references in upstreams.
+## 🚀 Installation

-Alternative: Submodules
+1. Clone the repository:

-Proposal: The final product will be a export of the repo
+   ```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]
--- a/README_wip.md
+++ b/README_wip.md
@ -0,0 +1,46 @@
+# eDF Release 'PoC' [WiP]
+
+This is a preliminary README in 'WiP' state - it's just sketching the story and structure of work.
+
+When we reach the 'PoC' milestone it will be replaced by a short and concise README as the main documentation entry point for our customers who want to consume the 'edf_poc' product.
+
+## POC Content Structure
+
+* [Part 1 - User documentation](https://jira.telekom-mms.com/browse/IPCEICIS-368)
+* Part 2 - Hands On
+    * [Part 2.1 - Local IdP creation](https://jira.telekom-mms.com/browse/IPCEICIS-765)
+    * [Part 2.2 - OSC IdP creation](https://jira.telekom-mms.com/browse/IPCEICIS-766)
+    * Part 2.1 & 2.2 Use Cases
+        * [Part 2.x.1 - Golden Path template for a Go application](https://jira.telekom-mms.com/browse/IPCEICIS-514)
+        * [Part 2.x.2 - Fibonacci Go application](https://jira.telekom-mms.com/browse/IPCEICIS-759)
+        * [Part 2.x.3 - Forgejo Actions with respect to the Fibonacci CI/CD](https://jira.telekom-mms.com/browse/IPCEICIS-760)
+        * [Part 2.x.4 - Telemetry with respect to the Fibonacci workload](https://jira.telekom-mms.com/browse/IPCEICIS-761)
+        * [Part 2.x.5 - OSC infrastructure with respect to the Fibonacci workload](https://jira.telekom-mms.com/browse/IPCEICIS-762)
+        * [Part 2.x.6 - Additional bells and whistles](https://jira.telekom-mms.com/browse/IPCEICIS-763)
+    * [Part 2.3 - Extended Local IdP creation and orchestration](https://jira.telekom-mms.com/browse/IPCEICIS-767)
+    * Part 2.3 Use Cases
+        * tbd
+* [Part 3 - User documentation](https://jira.telekom-mms.com/browse/IPCEICIS-768)
+
+
+## Content and Story
+
+This is the Storybook of the PoC content structure (content is depicted top right): 
+
+![](./content-and-storybook.png)
+
+## Use case content of 2.1 and 2.2 'Hands On'
+
+This is the illustration of the [use cases (aka 'functionality') in the PoC content](https://confluence.telekom-mms.com/display/IPCEICIS/Proof+of+Concept+2024): 
+
+![](./use-cases.png)
+
+## Technical composition
+
+The 'edf_poc'-product should be as self-contained as possible. 
+
+Thus all parts coming from upstream repos should have a physical copy in this repo with a reference to the upstream repo. Therefore we need a mapping table from parts here to references in upstreams.
+
+Alternative: Submodules
+
+Proposal: The final product will be a export of the repo
--- a/user_documentation.md
+++ b/user_documentation.md
@ -0,0 +1,11 @@
+# User Documentation
+
+---
+
+## 📋 Table of Contents
+
+- [User Documentation](#user-documentation)
+  - [📋 Table of Contents](#-table-of-contents)
+  - [Usecases](#usecases)
+
+## Usecases