feat(technical-doc): nearly finished this funny techdoc hugo to mkdocs conversion

This commit is contained in:
Stephan Lo 2024-12-19 23:26:25 +01:00
parent dae67f17f1
commit 910ea62dee
32 changed files with 75 additions and 62 deletions

View file

@ -1,11 +1,6 @@
+++
archetype = "sub-chapter"
title = "CI/CD Pipeline"
weight = 1
[params]
author = 'florian.fuerstenberg@t-systems.com'
date = '2024-10-08'
+++
---
title: CI/CD Pipeline
---
This document describes the concept of pipelining in the context of the Edge Developer Framework.

View file

@ -4,14 +4,11 @@ weight: 1
description: The 5-step storyflow of this Onboarding chapter
---
{{% pageinfo color="info" %}}
## Summary
This onboarding section is for you when are new to IPCEI-CIS subproject 'Edge Developer Framework (EDF)' and you want to know about
* its context to 'Platform Engineering'
* and why we think it's the stuff we need to care about in the EDF
{{% /pageinfo %}}
## Storyline of our current project plan (2024)

View file

@ -4,7 +4,6 @@ weight: 2
description: Driving requirements for a platform
---
{{% pageinfo color="info" %}}
## Summary
The 'Edge Developer Framework' is both the project and the product we are working for. Out of the leading 'Portfolio Document'
@ -12,7 +11,6 @@ we derive requirements which are ought to be fulfilled by Platform Engineering.
**This is our claim!**
{{% /pageinfo %}}
## What are the specifications we know from the IPCEI-CIS Project Portfolio document

View file

@ -5,14 +5,11 @@ weight: 3
description: DevOps is dead - long live next level DevOps in platforms
---
{{% pageinfo color="info" %}}
## Summary
Since 2010 we have DevOps. This brings increasing delivery speed and efficiency at scale.
But next we got high 'cognitive loads' for developers and production congestion due to engineering lifecycle complexity.
So we need on top of DevOps an instrumentation to ensure and enforce speed, quality, security in modern, cloud native software development. This instrumentation is called 'golden paths' in intenal develoepr platforms (IDP).
{{% /pageinfo %}}
## History of Platform Engineering

View file

@ -4,7 +4,6 @@ weight: 4
description: Next level platforming is orchestrating platforms
---
{{% pageinfo color="info" %}}
## Summary
When defining and setting up platforms next two intrinsic problems arise:
@ -13,7 +12,6 @@ When defining and setting up platforms next two intrinsic problems arise:
Thus the technology of 'Platform Orchestrating' emerged recently, in late 2023.
{{% /pageinfo %}}
## Platform reference architecture

View file

@ -4,7 +4,6 @@ weight: 5
description: Our top candidate for a platform orchestrator
---
{{% pageinfo color="info" %}}
## Summary
In late 2023 platform orchestration raised - the discipline of declarativley dinfing, building, orchestarting and reconciling building blocks of (digital) platforms.
@ -12,7 +11,6 @@ In late 2023 platform orchestration raised - the discipline of declarativley din
The famost one ist the platform orchestrator from Humanitec. They provide lots of concepts and access, also open sourced tools and schemas. But they do not have open sourced the ocheastartor itself.
Thus we were looking for open source means for platform orchestrating and found [CNOE](https://cnoe.io).
{{% /pageinfo %}}
## Requirements for an Orchestrator

View file

@ -4,14 +4,13 @@ weight: 6
description: CNOE hands on
---
{{% pageinfo color="info" %}}
## Summary
CNOE is a 'Platform Engineering Framework' (Danger: Our wording!) - it is open source and locally runnable.
It consists of the orchestrator 'idpbuilder' and both of some predefined building blocks and also some predefined platform configurations.
{{% /pageinfo %}}
## Orchestrator 'idpbuilder', initial run

View file

@ -4,12 +4,10 @@ weight: 7
description: 'Summary and final thoughts: Always challenge theses concepts, accumptions and claims!'
---
{{% pageinfo color="info" %}}
## Summary
In the project 'Edge Developer Framework' we start with DevOps, set platforms on top to automate golden paths, and finally set 'frameworks' (aka Orchestrators') on top to have declarative,automated and reconcilable platforms.
{{% /pageinfo %}}
## From Devops over Platform to Framework Engineering

View file

@ -1,7 +1,6 @@
+++
title = "Backstage Local Setup Tutorial"
weight = 4
+++
---
title: Backstage Local Setup Tutorial
---
This document provides a comprehensive guide on the prerequisites and the process to set up and run Backstage locally on your machine.

View file

@ -1,7 +1,6 @@
+++
title = "Existing Backstage Plugins"
weight = 4
+++
---
title: Existing Backstage Plugins
---
1. **Catalog**:
- Used for managing services and microservices, including registration, visualization, and the ability to track dependencies and relationships between services. It serves as a central directory for all services in an organization.

View file

@ -1,7 +1,6 @@
+++
title = "Backstage Description"
weight = 4
+++
---
title: Backstage Description
---
Backstage by Spotify can be seen as a Platform Portal. It is an open platform for building and managing internal developer tools, providing a unified interface for accessing various tools and resources within an organization.

View file

@ -1,7 +1,7 @@
+++
title = "Plugin Creation Tutorial"
weight = 4
+++
---
title: Plugin Creation Tutorial
---
Backstage plugins and functionality extensions should be writen in TypeScript/Node.js because backstage is written in those languages
### General Algorithm for Adding a Plugin in Backstage

View file

@ -1,7 +1,6 @@
+++
title = "Installation of idpbuilder"
weight = 1
+++
---
title: Installation of idpbuilder
---
## Local installation with KIND Kubernetes

View file

@ -1,7 +1,6 @@
+++
title = "Template for basic Argo Workflow"
weight = 4
+++
---
title: Template for basic Argo Workflow
---
# Backstage Template for Basic Argo Workflow with Spark Job

View file

@ -1,7 +1,6 @@
+++
title = "Template for basic kubernetes deployment"
weight = 4
+++
---
title: Template for basic kubernetes deployment
---
# Backstage Template for Kubernetes Deployment

View file

@ -18,21 +18,60 @@ nav:
- OpenBAO: user-documentation/openbao.md
- PetClinic: user-documentation/petclinic.md
- Technical Documentation:
- Platform concepts:
- 'Code: Software and Workloads': technical-documentation/concepts/1_software-and-workloads/_index.md
- Concepts:
- Code: technical-documentation/concepts/1_software-and-workloads/_index.md
- Engineers: technical-documentation/concepts/2_engineering-people/_index.md
- Use Cases: technical-documentation/concepts/3_use-cases/_index.md
- Digital Platforms: technical-documentation/concepts/4_digital-platforms/_index.md
- Platform Orchestrators: technical-documentation/concepts/5_platforms/_index.md
- EDP solution:
- Platforms:
- Platform Engineering: technical-documentation/concepts/4_digital-platforms/platform-engineering/_index.md
- Reference Architecture: technical-documentation/concepts/4_digital-platforms/platform-engineering/reference-architecture/_index.md
- Platform Components:
- CI/CD Pipeline: technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/_index.md
- Developer Portals: technical-documentation/concepts/4_digital-platforms/platform-components/developer-portals/_index.md
- Orchestrator: technical-documentation/concepts/4_digital-platforms/platform-components/orchestrator/_index.md
- References: technical-documentation/concepts/4_digital-platforms/platform-components/references/_index.md
- Orchestrators:
- CNOE: technical-documentation/concepts/5_platforms/CNOE/_index.md
- Humanitec: technical-documentation/concepts/5_platforms/Humanitec/_index.md
- Solution:
- Design: technical-documentation/solution/design/_index.md
- Scenarios: technical-documentation/solution/scenarios/_index.md
- Tools: technical-documentation/solution/tools/_index.md
- EDP Project:
- Bootstrapping: technical-documentation/project/bootstrapping/_index.md
- Conceptual Onboarding: technical-documentation/project/conceptual-onboarding/_index.md
- Stakeholer Workshop: technical-documentation/project/intro-stakeholder-workshop/_index.md
- Tools:
- Backstage:
- Description: technical-documentation/solution/tools/Backstage/general-information/_index.md
- Setup Tutorial: technical-documentation/solution/tools/Backstage/backstage-setup-tutorial/_index.md
- Existing Plugins: technical-documentation/solution/tools/Backstage/existing-plugins/_index.md
- Plugin Creation Tutorial: technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/_index.md
- CNOE:
- Competitors: technical-documentation/solution/tools/CNOE/competitors/_index.md
- Included Backstage Templates:
- Basic Argo Workflow: technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md
- Basic Kubernetes deployment: technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md
- Idpbuilder:
- Installation: technical-documentation/solution/tools/CNOE/idpbuilder/installation/_index.md
- Http Routing: technical-documentation/solution/tools/CNOE/idpbuilder/http-routing.md
- ArgoCD: technical-documentation/solution/tools/CNOE/argocd/_index.md
- Validation and Verification: technical-documentation/solution/tools/CNOE/verification.md
- Crossplane:
- Provider Kind: technical-documentation/solution/tools/crossplane/provider-kind/_index.md
- Kube-Prometheus-Stack: technical-documentation/solution/tools/Kube-prometheus-stack/_index.md
- Kyverno Integration: technical-documentation/solution/tools/kyverno-integration/_index.md
- Loki: technical-documentation/solution/tools/Loki/_index.md
- Promtail: technical-documentation/solution/tools/Promtail/_index.md
- Project:
- Conceptual Onboarding:
- Introduction: technical-documentation/project/conceptual-onboarding/1_intro/_index.md
- Edge Developer Framework: technical-documentation/project/conceptual-onboarding/2_edge-developer-framework/_index.md
- Platforming: technical-documentation/project/conceptual-onboarding/3_platforming/_index.md
- Orchestrators: technical-documentation/project/conceptual-onboarding/4_orchestrators/_index.md
- CNOE: technical-documentation/project/conceptual-onboarding/5_cnoe/_index.md
- CNOE Showtime: technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/_index.md
- Conclusio: technical-documentation/project/conceptual-onboarding/7_conclusio/_index.md
- Bootstrapping:
- Infrastructure: technical-documentation/project/bootstrapping/_index.md
- Backup: technical-documentation/project/bootstrapping/backup/_index.md
- Plan 2024: technical-documentation/project/plan-in-2024/_index.md
- Stakeholer Workshop: technical-documentation/project/intro-stakeholder-workshop/_index.md
- Team Process: technical-documentation/project/team-process/_index.md