Skip to content

Update docs related to Kgateway for dataplane #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VajiraPrabuddhaka merged 1 commit into from
Dec 1, 2025
Merged

Update docs related to Kgateway for dataplane #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/concepts/runtime-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ OpenChoreo manages network security through the cell architecture and gateway pa
allowed between components of the same project, while all cross-cell communication must flow through the defined
gateways. This provides security boundaries between different application domains.

The platform uses Cilium for network policy enforcement and Envoy Gateway for ingress traffic management. Developers
declare their components' endpoints and connections in the workload specification, and the platform handles the
The platform uses Cilium for network policy enforcement and Kgateway for ingress traffic management. Developers

@chalindukodikara chalindukodikara Nov 28, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We are not using Cilium by default, right? Can we remove it?

@NomadXD NomadXD Nov 29, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@chalindukodikara The whole runtime model section is outdated and there is no cell boundary now. So I didn't update things related to cilium with this PR.

@chalindukodikara chalindukodikara Nov 30, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@NomadXD Shall we update the whole section if possible, with the current understanding?

declare their components' endpoints and connections in the workload specification, and the platform handles the
underlying network configuration.

## Workload Execution
Expand Down
5 changes: 3 additions & 2 deletions docs/getting-started/multi-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,11 @@ kubectl get pods -n openchoreo-data-plane --context=k3d-openchoreo-dp
```

You should see pods for:
- `envoy-gateway-*` (Running)

- `openchoreo-data-plane-gateway-*` (Running)
- `external-secrets-*` (3 pods, all Running)
- `fluent-bit-*` (Running on each node)
- `gateway-external-*` (Running)
- `gateway-default-*` (Running)

#### Configure DataPlane

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/single-cluster.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ kubectl get pods -n openchoreo-data-plane
```

You should see pods for:
- `envoy-gateway-*` (Running)
- `cluster-agent-*` (Running) - Agent for secure control plane communication
- `openchoreo-data-plane-gateway-*` (Running)
- `external-secrets-*` (3 pods, all Running)
- `fluent-bit-*` (Running on each node)
- `gateway-external-*` (Running)
- `gateway-default-*` (Running)

#### Configure DataPlane

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/what-is-openchoreo.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ OpenChoreo is made up of several key components that work together to deliver a
- **Control Plane** - The orchestration layer that watches developer and platform APIs, validates configurations and translates them into Kubernetes-native and cloud-native infrastructure.
- **Developer API** - Simplified, self-service interfaces for developers to model, deploy and manage the full SDLC of cloud-native applications, without needing to understand platform internals.
- **Platform API** - Declarative interfaces used by platform engineers to configure and manage the OpenChoreo installation.
- **Data Plane** - The execution environment for applications that is built on Kubernetes and extended with Cilium, Envoy Gateway, and other CNCF tools. The Data Plane is where runtime semantics are enforced.
- **Data Plane** - The execution environment for applications that is built on Kubernetes and extended with Cilium, Kgateway, and other CNCF tools. The Data Plane is where runtime semantics are enforced.
- **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.
- **Observability Plane** - Out-of-the-box visibility with logs, metrics and traces, using tools like Prometheus, Fluent Bit and OpenSearch.

Expand Down