doc(): added chapter structure, lots of links ... looks quite readable meanwhile :-)

This commit is contained in:
Stephan Lo 2024-07-30 16:28:22 +02:00
parent 71ef2edd38
commit 92957dd8f8
12 changed files with 109 additions and 5 deletions

View file

@ -0,0 +1,9 @@
+++
archetype = "chapter"
title = "Platform Components"
weight = 3
[params]
author = 'stephan.lo@telekom.de'
date = '2024-07-30'
+++

View file

@ -0,0 +1,21 @@
+++
archetype = "sub-chapter"
title = "Developer Portals"
weight = 1
[params]
author = 'stephan.lo@telekom.de'
date = '2024-07-30'
+++
* Backstage
* Port
* Cortex
* Humanitec
* ... tbc ...
## Links
* [port-vs-backstage-choosing-your-internal-developer-portal](https://medium.com/@vaibhavgupta0702/port-vs-backstage-choosing-your-internal-developer-portal-71c6a6acd979)
* [idp-vs-self-service-portal-a-platform-engineering-showdown](https://thenewstack.io/idp-vs-self-service-portal-a-platform-engineering-showdown)
* [portals-vs-platform-orchestrator](https://humanitec.com/portals-vs-platform-orchestrator)
* [internal-developer-portal-vs-internal-developer-platform](https://www.cortex.io/post/internal-developer-portal-vs-internal-developer-platform)

View file

@ -0,0 +1,14 @@
+++
archetype = "sub-chapter"
title = "Platform Orchestrator"
weight = 1
[params]
author = 'stephan.lo@telekom.de'
date = '2024-07-30'
+++
## Links
* [portals-vs-platform-orchestrator](https://humanitec.com/portals-vs-platform-orchestrator)
* [CNOE IDPBuilder](https://cnoe.io/docs/reference-implementation/installations/idpbuilder)

View file

@ -24,11 +24,17 @@ CNVF first asks why we need platform engineering:
> * Reduce risk of security, regulatory and functional issues in products and services by governing platform capabilities and the users, tools and processes surrounding them
> * Enable cost-effective and productive use of services from public clouds and other managed offerings by enabling delegation of implementations to those providers while maintaining control over user experience
## [platformengineering.org's Definition of Platform Engineering](https://platformengineering.org/blog/what-is-platform-engineering)
> Platform engineering is the discipline of designing and building toolchains and workflows that enable self-service capabilities for software engineering organizations in the cloud-native era. Platform engineers provide an integrated product most often referred to as an “Internal Developer Platform” covering the operational necessities of the entire lifecycle of an application.
## Reference Architecture aka 'Even more wording': Internal Developer Platform vs. Developer Portal vs. Platform
https://humanitec.com/blog/wtf-internal-developer-platform-vs-internal-developer-portal-vs-paas
![idp](idp.webp)
## Internal Developer Platform
> In IPCEI-CIS right now (July 2024) we are primarily interested in understanding how IDPs are built as one option to implement an IDP is to build it ourselves.
@ -37,6 +43,8 @@ The outcome of the Platform Engineering discipline is - created by the platform
One of the first sites focusing on this discipline was [internaldeveloperplatform.org](https://internaldeveloperplatform.org/)
* [The golden path](https://engineering.atspotify.com/2020/08/how-we-use-golden-paths-to-solve-fragmentation-in-our-software-ecosystem/)
## Examples of existing IDPs
The amount of available IDPs as product is rapidly growing.
@ -48,3 +56,9 @@ The amount of available IDPs as product is rapidly growing.
* Another one: https://www.qovery.com/blog/10-best-internal-developer-platforms-to-consider-in-2023/
* Just found as another example: [platformplane](https://www.platformplane.com/)
## Additional links
* [how-to-fail-at-platform-engineering](https://www.cncf.io/blog/2024/03/08/how-to-fail-at-platform-engineering/)
* [8-real-world-reasons-to-adopt-platform-engineering](https://thenewstack.io/8-real-world-reasons-to-adopt-platform-engineering/)
* [7-core-elements-of-an-internal-developer-platform](https://thenewstack.io/7-core-elements-of-an-internal-developer-platform/)
* [internal-developer-platform-vs-internal-developer-portal](https://www.getport.io/blog/internal-developer-platform-vs-internal-developer-portal)

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

View file

@ -17,8 +17,10 @@ In a platform reference architecture there are five main planes that make up an
4, Monitoring and Logging Plane provides real-time metrics and logs for apps and infrastructure.
5. Security Plane manages secrets and identity to protect sensitive information, e.g., storing, managing, and security retrieving API keys and credentials/secrets.
![idp](../idp.webp)
(source: https://humanitec.com/blog/wtf-internal-developer-platform-vs-internal-developer-portal-vs-paas)
![alt text](platforms-def.drawio.png)
## Humanitec
@ -26,14 +28,13 @@ https://github.com/humanitec-architecture
https://humanitec.com/reference-architectures
![alt text](<66558d14e4f205de125fcc58_AWS + Humanitec Portal Reference Architecture 2024-05-25-p-1080.webp>)
## Create a reference architecture
[Create your own platform reference architecture](https://platformengineering.org/blog/create-your-own-platform-engineering-reference-architectures)
[Refernce arch slide deck](https://docs.google.com/presentation/d/1yAf_FSjiA0bAFukgu5p1DRMvvGGE1fF4KhvZbb7gn2I/edit?pli=1#slide=id.g1ef66f3349b_3_3)
[Reference arch slide deck](https://docs.google.com/presentation/d/1yAf_FSjiA0bAFukgu5p1DRMvvGGE1fF4KhvZbb7gn2I/edit?pli=1#slide=id.g1ef66f3349b_3_3)

View file

@ -0,0 +1,18 @@
+++
archetype = "chapter"
title = "Platforms"
weight = 4
[params]
author = 'stephan.lo@telekom.de'
date = '2024-07-30'
+++
## Humanitec
tbd
## 'CNOE' (Kuu.noo)
* https://cnoe.io/docs/intro
![kuunoo](./cnoe.png)

BIN
content/platforms/cnoe.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

View file

@ -0,0 +1,27 @@
+++
archetype = "chapter"
title = "Use Cases"
weight = 2
[params]
author = 'stephan.lo@telekom.de'
date = '2024-07-30'
+++
## Rationale
The challenge of IPCEI-CIS Developer Framework is to provide value for DTAG customers, and more specifically: for Developers of DTAG customers.
That's why we need verifications - or test use cases - for the Developer Framework to develop.
![alt text](platforms-def.drawio.png)
(source: https://tag-app-delivery.cncf.io/whitepapers/platforms/)
## List of Use Cases
Here we have a collection of possible usage scenarios.
### Socksshop
Deploy and develop the famous socks shops:
* https://medium.com/@wadecharley703/socks-shop-microservices-application-deployment-on-the-cloud-cd1017cce1c0

View file

Before

Width:  |  Height:  |  Size: 160 KiB

After

Width:  |  Height:  |  Size: 160 KiB

Before After
Before After