The goal of this library is to provide a reusable and generic way of exposing k8s resources from within a cluster using GraphQL. This enables UIs that need to consume these objects to do so in a developer-friendly way, leveraging a rich ecosystem.

This repository contains two main components:

• Listener: watches a cluster and stores its openAPI spec in a directory.
• Gateway: exposes the openAPI spec as a GraphQL endpoints.

The system supports two modes of operation:

1. KCP Mode (ENABLE_KCP=true): Designed for KCP-based multi-cluster scenarios
   • See Virtual Workspaces for advanced KCP configuration
2. ClusterAccess Mode (ENABLE_KCP=false): Designed for support of multiple standard clusters.

For detailed information, see Clusteraccess section.

All information about authorization can be found in the authorization section.

If you want to get started quickly, you can follow the quickstart guide.

Please refer to the contributing section for instructions on how to contribute to platform-mesh.

The release is performed automatically through a GitHub Actions Workflow. All the released versions will be available through access to GitHub (as any other Golang Module).

If you find any bug that may be a security problem, please follow our instructions in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.

Copyright 2025 SAP SE or an SAP affiliate company and platform-mesh contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.