Skip to content

docs(developers): platform service design#124

Open
christophrj wants to merge 5 commits into
mainfrom
docs/platform-services-design
Open

docs(developers): platform service design#124
christophrj wants to merge 5 commits into
mainfrom
docs/platform-services-design

Conversation

@christophrj

Copy link
Copy Markdown
Member

On-behalf-of: @SAP christopher.junk@sap.com

What this PR does / why we need it:
This PR introduces platform service design doc that describes the concept of platform services in OpenControlPlane.

Which issue(s) this PR fixes:
Fixes #41

Special notes for your reviewer:

Release note:

NONE

@christophrj christophrj force-pushed the docs/platform-services-design branch 2 times, most recently from ed0d608 to 3e1f089 Compare June 2, 2026 11:41
On-behalf-of: @SAP christopher.junk@sap.com
Signed-off-by: Christopher Junk <christopher.junk@sap.com>
@christophrj christophrj force-pushed the docs/platform-services-design branch from 3e1f089 to 8d1755b Compare June 2, 2026 12:00
On-behalf-of: @SAP christopher.junk@sap.com
Signed-off-by: Christopher Junk <christopher.junk@sap.com>
On-behalf-of: @SAP christopher.junk@sap.com
Signed-off-by: Christopher Junk <christopher.junk@sap.com>
On-behalf-of: @SAP christopher.junk@sap.com
Signed-off-by: Christopher Junk <christopher.junk@sap.com>
@christophrj christophrj marked this pull request as ready for review June 2, 2026 12:19
@christophrj

Copy link
Copy Markdown
Member Author

Since we are always talking about the three platform personas brought up in the Why Kubernetes Is Inappropriate for Platforms, and How to Make It Better talk, I think it would make sense to add this as a reference to the design doc. @maximiliantech what do you think

On-behalf-of: @SAP christopher.junk@sap.com
Signed-off-by: Christopher Junk <christopher.junk@sap.com>

@maximiliantech maximiliantech left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great design documentation @christophrj! I really like that it is straight forward and follows the same structure like the Service Provider design document ❤️ Just have some minor comments. What do you think?

| :------ | :--------------- | :--------------- |
| Platform cluster | ✳️ | ❌ |
| Onboarding cluster | ✳️ | ✅ |
| Managed Control Plane | ❌ | ✅ |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be best to name this here ControlPlane. What do you think?

Suggested change
| Managed Control Plane |||
| Control Plane |||

# Develop

:::info Coming Soon
A comprehensive guide for developing Platform Providers from scratch is coming soon.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@christophrj Could you do a general search for Platform Providers throughout the documentation and replace that with Platform Services please 🙏

Comment on lines +16 to +20
| Persona | OpenControlPlane Concept | Responsibility |
| :------ | :--------------- | :------------------- |
| Platform Owner | Platform Service and [Cluster Provider](../clusterprovider/04-design.mdx) | Provide platform capabilities consumed by the layers below |
| Service Provider | [Service Providers](../serviceprovider/01-design.mdx) | Provide managed services consumed by the layer below |
| User | Not an OpenControlPlane concept but a human end user | Generate value from the services provided by Platform Owners and Service Providers |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like that you are describing the personas here once again 💯 But we are now somehow inconsistent with developers/serviceprovider/design#terminology where we say "Platform Operator" instead of "Platform Owner" (we do should call them "Platform Owner" throughout the documentation).

Do we want to refactor this as part of this PR or make a follow-up PR? :)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be more occurrences of the wrong persona name throughout the documentation as well 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Expand Platform Service concept documentation

2 participants