You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Platform Specification originally started as a solution to working on automation to build fully functional, Kubernetes based platforms that reside in multiple IaaS providers, leverage many external SaaS services, and manage several types of workloads (from ML/AI, to IoT and Fintech and general purpose SaaS).
3
+
4
+
It was created as a set of standard input values to Helm charts (ie structure around `values.yaml`), who were then responsible for the provisioning and lifecycle management of said platforms. If you've ever worked with Helm, you know that it's a great tool for templating and managing Kubernetes resources, but it's not a great tool for managing neither the lifecycle of a platform, nor the intricate and custom design requirements.
5
+
6
+
The Platform Specification was created to fill that gap.
7
+
8
+
## In a Nutshell: What is the Platform Specification?
9
+
The Platform Specification is an open, declarative standard for describing Cloud Native Platforms—those built on Kubernetes and cloud infrastructure.
10
+
11
+
It allows teams to codify every component of their platform—from infrastructure providers and clusters to policies, developer services, and observability—using a consistent, portable YAML format. The specification is implemented as a set of Kubernetes Custom Resource Definitions (CRDs), supported by tooling to validate, orchestrate, and manage entire platforms declaratively.
12
+
13
+
However, The Platform Specification is more than just a schema — it’s a complete framework for designing, defining, and driving cloud-native platforms.
14
+
15
+
The project consists of four core parts:
16
+
17
+
| Component | Description |
18
+
| --- | --- |
19
+
| ✏️ **Standardized API Resources (CRDs)**| A well-structured set of Custom Resource Definitions, grouped into logical API domains (e.g. `core.platformspec.io`, `design.platformspec.io`, `secure.platformspec.io`, etc.). These define all the components that make up a modern platform—from clusters and providers to policies, observability, developer services, and more. |
20
+
| 🛠️ **SDKs for Real-World Usage**| Official SDKs in Golang, Python, Java, and KCL allow you to work with the spec programmatically. These SDKs include models for all Platform Specification resources, making it easy to generate, validate, or manipulate them in code or automation pipelines. |
21
+
| 📜 **Blueprints and** 🏗️ **Builders (Realization Layer)**| Once you define your platform, Blueprints and Builders turn that definition into reality. These are implementation engines that translate Platform Specification resources into actual cloud infrastructure using tools like Terraform, CloudFormation, Crossplane, and others. |
22
+
| ⚙️ **Platform Operators (Runtime Automation)**| Coming soon: Platform Operators that bridge the gap between your platform definitions and their realization. These operators manage lifecycles, dependencies, reconciliation, and binding between Platform Specification resources and their corresponding Blueprints + Builders. |
23
+
24
+
## Why Does This Matter?
25
+
26
+
See the [Preface](/docs/project/preface) for a more detailed explanation.
27
+
28
+
## Who Is It For?
29
+
30
+
-**Platform Engineering Teams:** Defining and operating internal platforms and infrastructure with consistency and clarity.
31
+
-**SREs and DevOps Engineers:** Ensuring repeatability, automation, and reliability across clusters and environments.
32
+
-**Cloud Architects:** Designing scalable, multi-region, and multi-cloud systems with a structured representation.
33
+
-**Tool Builders and Integrators:** Creating automation and visualization tools with a standard API for interacting with platform resources.
34
+
-**Executives & Technical Leadership:** Seeking transparency and standardization across teams and initiatives through a shared language and structure.
35
+
-**Security Architects:** Codifying security, compliance, and governance policies directly into platform definitions.
36
+
-**Developers & Workload Operators:** Understanding and accessing platform capabilities through a well-defined service contract.
37
+
38
+
## How do I use it?
39
+
40
+
::: danger Not ready
41
+
The Platform Specification is still in development and not yet ready for full use.
42
+
43
+
Please follow the [News](/docs/project/news) page for updates on the project's progress.
44
+
45
+
Please visit the [Roadmap](/docs/project/roadmap) for a detailed timeline of upcoming features and releases.
46
+
47
+
We are actively working on this and will update this page as soon as it is ready.
48
+
:::
49
+
50
+
### 1. Install the CRDs
51
+
Install the Platform Specification CRDs into your Kubernetes Cluster
52
+
53
+
See the [GitHub Project](https://github.com/platformspec) for the latest releases and installation instructions.
54
+
55
+
::: warning Work in Progress
56
+
Please note that the CRDs are still being developed and are not yet ready for full installation into a cluster. We are actively working on this and will update this page as soon as they are ready.
57
+
:::
58
+
59
+
### 2. Define your Platform
60
+
Create a YAML structured file (e.g. `platform.yaml`) describing infrastructure, services, and policies.
61
+
62
+
::: warning Work in Progress
63
+
This is presently a manual process. Tooling for designing and building platforms is under active development. Reference designs and examples will be provided as soon as they are available.
64
+
:::
65
+
66
+
### 3. Select your Operator
67
+
Install and configure your Platform Specification operator to manage your platform.
68
+
69
+
::: warning Work in Progress
70
+
Operators written in Java and in Python are in development. Details will be provided as soon as they are available.
71
+
:::
72
+
73
+
### 4. Realize your Platform
74
+
Use Blueprints and their leveraged/dependent Builders to turn your platform definition into real cloud infrastructure.
75
+
76
+
::: warning Work in Progress
77
+
Blueprints and Builders are under active development. Details will be provided as soon as they are available.
78
+
:::
79
+
80
+
### 5. Manage your Platform
81
+
Use Platform Operators to automate the lifecycle of your platform, ensuring consistency and reliability.
82
+
83
+
### Further Details
84
+
Full details are provided on the [Workflow and Usage](/docs/spec/workflow-and-usage) page.
Copy file name to clipboardExpand all lines: index.md
+61-42Lines changed: 61 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,32 +4,67 @@ layout: home
4
4
5
5
hero:
6
6
name: "Platform Specification"
7
-
text: "Standards For Your Cloud Native Platform"
8
-
tagline: Capture Every Component and Configuration of Your Cloud Native Platform in One Unified Standard
7
+
# text: "Standards For Your Cloud Native Platform"
8
+
# tagline: Capture Every Component and Configuration of Your Cloud Native Platform in One Unified Standard
9
+
text: "Codify Your Cloud Native Platform"
10
+
tagline: Capture and standardize every component of your Kubernetes-powered platform—infra, policies, security, and services—using a unified set of CRDs and tools purpose-built for <strong>platform engineering</strong>.
9
11
image:
10
12
light: logo-pressedsteel-light.png
11
13
dark: logo-pressedsteel-dark.png
12
14
actions:
13
15
- theme: brand
14
-
text: Documentation
15
-
link: /docs/project/preface/
16
+
text: Getting Started
17
+
link: /docs/project/getting-started/
16
18
- theme: alt
17
19
text: The Specification
18
20
link: /docs/spec/spec
21
+
- theme: alt
22
+
text: Knowledge Base
23
+
link: /docs/types/types
19
24
20
25
features:
21
-
- title: Comprehensive Platform Coverage
22
-
details: From <strong>Infrastructure & Operations</strong> to <strong>Application Development</strong> and <strong>Services Control Planes</strong>, Platform Spec defines standards for all major platform types.
23
-
- title: Community-Driven Best Practices
24
-
details: Built upon a standardized, collaborative approach, ensuring best practices are shared and evolved by the cloud native community.
25
-
- title: Consistent Across Environments
26
-
details: Deploy consistent platforms seamlessly across diverse cloud providers and environments, fostering portability and efficiency.
27
-
- title: Flexible and Adaptable
28
-
details: The Platform Specification's extensible and modular design allows for easy integration of new technologies and customizations.
29
-
- title: Enhanced Collaboration
30
-
details: Streamline teamwork with a single, transparent configuration file, enabling platform engineers, developers, and operations teams to work in sync.
31
-
- title: Faster Time to Market
32
-
details: Accelerate platform deployment and reduce onboarding time with a clear, structured framework that empowers new team members quickly.
26
+
# - title: Comprehensive Platform Coverage
27
+
# details: From <strong>Infrastructure & Operations</strong> to <strong>Application Development</strong> and <strong>Services Control Planes</strong>, Platform Spec defines standards for all major platform types.
28
+
# - title: Enhanced Collaboration
29
+
# details: Streamline teamwork with a single, transparent configuration file, enabling platform engineers, developers, and operations teams to work in sync.
30
+
# - title: Faster Time to Market
31
+
# details: Accelerate platform deployment and reduce onboarding time with a clear, structured framework that empowers new team members quickly.
32
+
# - title: Collaborative Platform Design
33
+
# details: Use the spec CRDs to manifest your layout in workshops. Help other teams engage into the discussion by using a well defined catalog. Seemlessly continue with the machine readable results.
34
+
# - title: Standardized Tool Integration
35
+
# details: Use platformspec as a common abstraction layer between arbitraty tools of your platform. Leverage client SDKs for cleaner integrations.
36
+
# - title: Learn from comparable platform designs
37
+
# details: Make platform topologies comparable, easier to understand and learn from other projects to improve.
38
+
# - title: What is it?
39
+
# details: The Platform Specification is an open, YAML-based standard for defining modern cloud platforms. It lets you describe infrastructure, services, policies, and developer tools—across any cloud or Kubernetes environment.
40
+
# - title: Why it matters
41
+
# details: <ul><li>• Inconsistent environments</li><li>• Tribal knowledge and fragile automation</li><li>• Runaway costs and misconfigured services</li></ul>
42
+
# - title: Comprehensive Coverage
43
+
# details: From <strong>Infrastructure & Operations</strong> to <strong>Application Development</strong> and <strong>Services Control Planes</strong>, Platform Spec defines standards for all major platform types.
44
+
- title: 📦 Modular Structure
45
+
details: Define only what you need—Infrastructure, Compute, Policies, and more—in isolated, reusable sections.
46
+
linkText: See the API groups
47
+
link: /docs/spec/spec#api-groups
48
+
- title: ✏️ Declarative and Git-Friendly
49
+
details: Say what your platform should look like, not how to build it. Store and version your platform definitions as code, perfect for GitOps workflows.
50
+
linkText: See the spec
51
+
link: /docs/spec/spec
52
+
- title: 🤖 Designed for Automation
53
+
details: Build, deploy, validate, and visualize using existing CI/CD pipelines and dashboard tools.
54
+
link: /docs/spec/workflow-and-usage
55
+
linkText: Workflow and Usage
56
+
- title: ☁️ Cloud Agnostic
57
+
details: Works with any provider -- AWS, GCP, Azure, IBM, Oracle, or any others -- as long as it's a Kubernetes environment.
details: Use platformspec as a common abstraction layer between arbitrary tools of your platform. Leverage client SDKs for cleaner integrations.
62
+
link: /docs/spec/sdks.html
63
+
linkText: SDKs
64
+
- title: 🧠 Learn From Comparable Platform Designs
65
+
details: Make platform topologies comparable, easier to understand and learn from other projects to improve.
66
+
linkText: Learn About Platforms
67
+
link: /docs/types/types.html
33
68
---
34
69
35
70
<style>
@@ -51,33 +86,17 @@ features:
51
86
--vp-home-hero-image-filter: blur(68px);
52
87
}
53
88
}
54
-
</style>
55
-
56
-
<p> </p>
57
-
58
-
---
59
-
60
-
<h3>
61
-
<center>
62
-
APIs for Defining Platforms
63
-
</center>
64
-
</h3>
65
-
66
-
The Platform Specification is a community-driven standard designed to simplify <strong>Cloud Native Platform Engineering</strong>. It provides a common set of APIs for platform engineers, developers, and operations teams, regardless of their chosen cloud provider or environment. By leveraging proven best practices and a shared configuration, Platform Spec streamlines collaboration, boosts efficiency, and accelerates time to value. Whether you're operating across multiple clouds or fine-tuning a single environment, Platform Spec ensures cross-cloud consistency and reduces the complexities of platform management. This means your team can focus on what truly matters: building innovative applications and delivering exceptional user experiences. Join the community and discover how Platform Spec can empower your team to build better platforms faster.
The Platform Specification understands that cloud native platforms come in many shapes and sizes—from <strong>Infrastructure Platforms</strong> to <strong>Developer Platforms</strong>, <strong>Services Platforms</strong>, and beyond. Rather than trying to dictate a one-size-fits-all solution, Platform Spec provides a flexible framework for defining and implementing any type of platform. By recognizing the commonalities across these diverse platforms, Platform Spec leverages a modular and composable approach. This means you can reuse overlapping aspects across different platform types, streamlining the definition and description of your intended platform outcome, regardless of its specific focus. Whether you're building an Infrastructure-as-Code powerhouse or a streamlined Developer Experience, Platform Spec empowers you to build better platforms faster by focusing on what truly matters: your unique requirements and innovation.
0 commit comments