Skip to content

Commit 0f61ab4

Browse files
Add initial changes to the what is OpenChoreo page
1 parent 4c888c3 commit 0f61ab4

File tree

1 file changed

+33
-57
lines changed

1 file changed

+33
-57
lines changed

docs/overview/what-is-openchoreo.mdx

Lines changed: 33 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -7,76 +7,44 @@ import Link from '@docusaurus/Link';
77
import {versions} from '../_constants.mdx';
88

99
# What is OpenChoreo?
10+
=======
11+
OpenChoreo is a complete, open-source Internal Developer Platform (IDP) designed for platform engineering (PE) teams who want to streamline developer workflows and deliver Internal Developer Portals without having to build everything from scratch.
1012

11-
OpenChoreo is an open-source Internal Developer Platform (IDP) that makes Kubernetes accessible to development teams. It
12-
provides a complete platform engineering solution that transforms complex infrastructure into simple, self-service
13-
developer experiences.
13+
OpenChoreo orchestrates many CNCF and other projects to give a comprehensive framework for PE teams to build the platform they want.
1414

15-
OpenChoreo brings the best ideas from [WSO2 Choreo](https://choreo.dev) (an enterprise IDP) to the open-source
16-
community.
15+
## Why OpenChoreo?
1716

18-
## Who Should Use OpenChoreo?
17+
Kubernetes gives you powerful primitives like Namespaces, Deployments, CronJobs, Services and NetworkPolicies—but they are too low-level for most developers.
1918

20-
OpenChoreo is designed for:
19+
This creates gap: **Platform engineers are left to build the real platform** defining higher-level APIs for developers and integrating tools for security, CI/CD, observability and operational guardrails.
2120

22-
- **Platform Engineering Teams** building internal developer platforms on Kubernetes
23-
- **DevOps Teams** looking to standardize deployments and reduce operational overhead
24-
- **Development Teams** wanting self-service deployment without infrastructure complexity
25-
- **Organizations** seeking to accelerate cloud-native adoption while maintaining security and compliance
21+
**OpenChoreo fills that gap.** It provides all essentional building blocks of an IDP, including:
22+
- **High-level APIs** for modeling cloud-native applications
23+
- A **Control Plane** that understands and enforces these APIs with GitOps support
24+
- A **built-in CI system**
25+
- An **opinionated Data Plane** with runtime enforcement of design-time semantics
26+
- Built-in **Security**, **networking** and **observability** integrations
2627

27-
## The Problem
28+
With OpenChoreo, we are bringing the best ideas of [WSO2 Choreo](https://choreo.dev) (an IDP as a Service) to the open-source community. WSO2 Choreo is designed not just to automate software delivery workflows, but to support engineering best practices: enforcing architecture standards, promoting service reuse, and integrating API management and observability.
2829

29-
Modern cloud-native development has become unnecessarily complex:
30+
## OpenChoreo Components
3031

31-
- **Kubernetes is powerful but overwhelming**: Developers need to understand pods, services, ingress, ConfigMaps, and
32-
dozens of other concepts just to deploy a simple application
33-
- **Every team reinvents the wheel**: Without standards, each team creates their own deployment patterns, leading to
34-
inconsistency and technical debt
35-
- **Security is an afterthought**: Teams often sacrifice security for speed, leaving applications vulnerable
36-
- **Platform building is expensive**: Companies spend months or years building internal platforms from scratch
32+
OpenChoreo is made up of several key components that work together to deliver a complete IDP.
3733

38-
## How OpenChoreo Solves It
34+
<!-- ![](../resources/openchoreo_components.svg) -->
3935

40-
OpenChoreo provides a layered approach with clear separation between platform engineering and development:
36+
- **Platform API** - Declarative interfaces used by platform engineers to configure and manage OpenChoreo installation.
37+
- **Developer API** - Simplified, self-service interfaces for developers to model, deploy and managed to the full SDLC of cloud-native applications, without needing to understand platform internals.
38+
- **Control Plane** - The orchestration layer that watch developer and platform APIs, validates configurations and translate them into Kubernetes-native and cloud-native infrastructure.
39+
- **Data Plane** - The execution environment for applications that is built on Kubernetes and extended with Cilium, Envoy Gateway and other CNCF tools. Data Plane is where runtime semantics are enforced.
40+
- **CI Plane** - A built-in CI engine powered by Argo Workflows. It builds the container images, runs tests and publishes artifacts. It is an optional plane.
41+
- **Observability Plane** - Out-of-the-box visibility with logs, metrics and traces, using tools like Prometheus, Fluent Bit and OpenSearch.
4142

42-
**For Platform Engineers:**
43-
44-
- Set up **Data**, **Build**, and **Observability Planes** for infrastructure separation
45-
- Define **Organizations** for multi-tenant isolation
46-
- Configure **Environments** on DataPlanes
47-
- Create **Classes** (ServiceClass, WebApplicationClass) to enforce standards
48-
- Configure **DeploymentPipelines** for promotion workflows
49-
50-
**For Developers:**
51-
52-
- Create **Projects** to organize related services (aligned with DDD bounded contexts)
53-
- Define **Components** for applications
54-
- Specify **Workloads** with runtime configurations
55-
- Deploy **applications** (Services, WebApplications, ScheduledTasks) using platform Classes
56-
57-
The platform automatically handles the complexity of Kubernetes, including:
58-
59-
- [Cell-based isolation](https://github.com/wso2/reference-architecture/blob/master/reference-architecture-cell-based.md)
60-
with zero-trust networking
61-
- Automatic mTLS for all service communication
62-
- Built-in observability and distributed tracing
63-
- CI/CD pipelines with GitOps workflows
64-
- RBAC and access control
65-
66-
## What Makes OpenChoreo Different
67-
68-
- **Kubernetes Native**: Built as operators extending Kubernetes, not a layer on top
69-
- **Complete Solution**: Includes build, deploy, networking, API management, and observability—not just a UI
70-
- **Open Source**: No vendor lock-in, transparent development, community-driven
71-
- **Separation of Concerns**: Platform engineers define standards through Classes, developers express intent through
72-
Claims
73-
74-
Built on proven CNCF projects including Cilium (eBPF networking), Buildpacks, Argo (workflows), and Envoy Gateway (API
75-
management).
43+
Learn more about how these components fit together in the [OpenChoreo Architecture](./architecture.md) section.
7644

7745
## Current Status
7846

79-
OpenChoreo is currently in **active development** (v1alpha1). While the core platform is functional, APIs may change as
47+
OpenChoreo is currently in **active development**. While the core platform is functional, APIs may change as
8048
we incorporate community feedback. We recommend starting with non-production workloads as you evaluate the platform.
8149

8250
See our [Roadmap](https://github.com/orgs/openchoreo/projects/4) for upcoming features and stable release timeline.
@@ -92,9 +60,17 @@ Ready to try OpenChoreo? Start here:
9260

9361
## Community
9462

95-
OpenChoreo is an open-source project that welcomes contributions. Join our community:
63+
We’d love for you to be part of OpenChoreo’s journey! Whether you’re fixing a bug, improving documentation, or suggesting new features, every contribution counts.
9664

65+
<<<<<<< HEAD:docs/overview/what-is-openchoreo.mdx
9766
- [GitHub Discussions](https://github.com/openchoreo/openchoreo/discussions) for questions and ideas
9867
- [Discord](https://discord.com/invite/asqDFC8suT) for real-time chat
9968
- <Link to={`https://github.com/openchoreo/openchoreo/blob/${versions.githubRef}/docs/contributors/contribute.md`}>Contributing Guide</Link> to get
10069
involved
70+
=======
71+
- [Contributor Guide](https://github.com/openchoreo/openchoreo/blob/main/docs/contributors/contribute.md) – Learn how to get started.
72+
- [Report an Issue](https://github.com/openchoreo/openchoreo/issues) – Help us improve OpenChoreo.
73+
- [Join our Discord](https://discord.com/invite/asqDFC8suT) – Be part of the community.
74+
75+
We’re excited to have you onboard!
76+
>>>>>>> e2802bd (Add initial changes to the what is OpenChoreo page):docs/overview/what-is-openchoreo.md

0 commit comments

Comments
 (0)