refactor(documentation-structure): section concepts/platforms refactored to the general documentation layout with descriptions
This commit is contained in:
parent
f05eb6c01b
commit
6419ffd6ec
6 changed files with 61 additions and 62 deletions
|
|
@ -8,6 +8,3 @@ description: Platforming is the discipline to provide full sophisticated golden
|
|||
## Surveys
|
||||
|
||||
* [10-best-internal-developer-platforms-to-consider-in-2023/](https://www.qovery.com/blog/10-best-internal-developer-platforms-to-consider-in-2023/)
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,38 +1,8 @@
|
|||
+++
|
||||
title = "Platform Components"
|
||||
weight = 3
|
||||
[params]
|
||||
author = 'stephan.lo@telekom.de'
|
||||
date = '2024-07-30'
|
||||
+++
|
||||
---
|
||||
title: "Platform Components"
|
||||
weight: 3
|
||||
description: What in terms of components or building blocks is needed in a platform?
|
||||
---
|
||||
|
||||
> This page is in work. Right now we have in the index a collection of links describing and listing typical components and building blocks of platforms. Also we have a growing number of subsections regarding special types of components.
|
||||
|
||||
## CNCF
|
||||
|
||||
> [Here are capability domains to consider when building platforms for cloud-native computing](https://tag-app-delivery.cncf.io/whitepapers/platforms/#capabilities-of-platforms):
|
||||
|
||||
* Web portals for observing and provisioning products and capabilities
|
||||
* APIs (and CLIs) for automatically provisioning products and capabilities
|
||||
* “Golden path” templates and docs enabling optimal use of capabilities in products
|
||||
* Automation for building and testing services and products
|
||||
* Automation for delivering and verifying services and products
|
||||
* Development environments such as hosted IDEs and remote connection tools
|
||||
* Observability for services and products using instrumentation and dashboards, including observation of functionality, performance and costs
|
||||
* Infrastructure services including compute runtimes, programmable networks, and block and volume storage
|
||||
* Data services including databases, caches, and object stores
|
||||
* Messaging and event services including brokers, queues, and event fabrics
|
||||
* Identity and secret management services such as service and user identity and authorization, certificate and key issuance, and static secret storage
|
||||
* Security services including static analysis of code and artifacts, runtime analysis, and policy enforcement
|
||||
* Artifact storage including storage of container image and language-specific packages, custom binaries and libraries, and source code
|
||||
|
||||
## IDP
|
||||
|
||||
> [An Internal Developer Platform (IDP) should be built to cover 5 Core Components:](https://internaldeveloperplatform.org/core-components/)
|
||||
|
||||
| Core Component | Short Description |
|
||||
| ---- | --- |
|
||||
| Application Configuration Management | Manage application configuration in a dynamic, scalable and reliable way. |
|
||||
| Infrastructure Orchestration | Orchestrate your infrastructure in a dynamic and intelligent way depending on the context. |
|
||||
| Environment Management | Enable developers to create new and fully provisioned environments whenever needed. |
|
||||
| Deployment Management | Implement a delivery pipeline for Continuous Delivery or even Continuous Deployment (CD). |
|
||||
| Role-Based Access Control | Manage who can do what in a scalable way. |
|
||||
|
|
@ -1,11 +1,11 @@
|
|||
+++
|
||||
archetype = "sub-chapter"
|
||||
title = "Developer Portals"
|
||||
weight = 1
|
||||
[params]
|
||||
author = 'stephan.lo@telekom.de'
|
||||
date = '2024-07-30'
|
||||
+++
|
||||
---
|
||||
title: "Developer Portals"
|
||||
weight: 2
|
||||
description: Developer portals are one part of the UI for developers to access platforms. The general idea is that the UI parts should be enough for a developer to th their work.
|
||||
---
|
||||
|
||||
> This page is in work. Right now we have in the index a collection of links describing developer portals.
|
||||
|
||||
|
||||
* Backstage (siehe auch https://nl.devoteam.com/expert-view/project-unox/)
|
||||
* [Port](https://www.getport.io/)
|
||||
|
|
|
|||
|
|
@ -1,11 +1,8 @@
|
|||
+++
|
||||
archetype = "sub-chapter"
|
||||
title = "Platform Orchestrator"
|
||||
weight = 1
|
||||
[params]
|
||||
author = 'stephan.lo@telekom.de'
|
||||
date = '2024-07-30'
|
||||
+++
|
||||
---
|
||||
title: Platform Orchestrator
|
||||
weight: 3
|
||||
description: "The new kid on the block since 2023 ist 'Platform Orchestrating': Do the the magic declaratively cloud natively automated."
|
||||
---
|
||||
|
||||
'Platform Orchestration' is first mentionned by [Thoughtworks in Sept 2023](https://www.thoughtworks.com/en-de/radar/techniques/platform-orchestration)
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: List of references
|
||||
weight: 10
|
||||
linktitle: References
|
||||
description: An currently uncurated list of references with respect to typical platform building components
|
||||
---
|
||||
|
||||
## CNCF
|
||||
|
||||
> [Here are capability domains to consider when building platforms for cloud-native computing](https://tag-app-delivery.cncf.io/whitepapers/platforms/#capabilities-of-platforms):
|
||||
|
||||
* Web portals for observing and provisioning products and capabilities
|
||||
* APIs (and CLIs) for automatically provisioning products and capabilities
|
||||
* “Golden path” templates and docs enabling optimal use of capabilities in products
|
||||
* Automation for building and testing services and products
|
||||
* Automation for delivering and verifying services and products
|
||||
* Development environments such as hosted IDEs and remote connection tools
|
||||
* Observability for services and products using instrumentation and dashboards, including observation of functionality, performance and costs
|
||||
* Infrastructure services including compute runtimes, programmable networks, and block and volume storage
|
||||
* Data services including databases, caches, and object stores
|
||||
* Messaging and event services including brokers, queues, and event fabrics
|
||||
* Identity and secret management services such as service and user identity and authorization, certificate and key issuance, and static secret storage
|
||||
* Security services including static analysis of code and artifacts, runtime analysis, and policy enforcement
|
||||
* Artifact storage including storage of container image and language-specific packages, custom binaries and libraries, and source code
|
||||
|
||||
## IDP
|
||||
|
||||
> [An Internal Developer Platform (IDP) should be built to cover 5 Core Components:](https://internaldeveloperplatform.org/core-components/)
|
||||
|
||||
| Core Component | Short Description |
|
||||
| ---- | --- |
|
||||
| Application Configuration Management | Manage application configuration in a dynamic, scalable and reliable way. |
|
||||
| Infrastructure Orchestration | Orchestrate your infrastructure in a dynamic and intelligent way depending on the context. |
|
||||
| Environment Management | Enable developers to create new and fully provisioned environments whenever needed. |
|
||||
| Deployment Management | Implement a delivery pipeline for Continuous Delivery or even Continuous Deployment (CD). |
|
||||
| Role-Based Access Control | Manage who can do what in a scalable way. |
|
||||
|
|
@ -1,10 +1,9 @@
|
|||
+++
|
||||
title = "Platform Engineering"
|
||||
weight = 1
|
||||
[params]
|
||||
author = 'stephan.lo@telekom.de'
|
||||
date = '2024-07-30'
|
||||
+++
|
||||
---
|
||||
title: Platform Engineering
|
||||
weight: 1
|
||||
description: Theory and general blue prints of the platform engineering discipline
|
||||
---
|
||||
|
||||
|
||||
## Rationale
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue