Platform Mesh

API sharing

Provider workspaces export APIs; account workspaces bind them. Once bound, the exported types appear as native resources in the consumer workspace and are subject to the same RBAC and authorization chain as anything else in that workspace.

See API sharing for how Platform Mesh layers account structure and IAM wiring on top of these primitives.

Primitives

Primitive	Platform Mesh role	Upstream
APIResourceSchema	Immutable schema. api-syncagent generates these from CRDs; Platform Mesh hand-authors them for core.platform-mesh.io and system.platform-mesh.io.	API resource schemas
APIExport	Publishes a set of schemas in a provider workspace.	Exporting APIs
APIBinding	Imports an APIExport into a consumer workspace.	Binding APIs
Permission claims	Provider declares; consumer accepts. Platform Mesh uses these heavily for workspaces, apibindings, logicalclusters, secrets.	Permission claims
Identity hash	SHA-256 in APIExport.status.identityHash. Used by consumers to scope claim lookups across multiple exports of the same group/resource.	Exporting APIs
APIExportEndpointSlice	Publishes virtual-workspace URLs.	Endpoint slices

API versions

apis.kcp.io serves both v1alpha1 and v1alpha2. kcp converts between them automatically. Platform Mesh ships APIExport templates on v1alpha1 and APIBinding templates on v1alpha2; both halves work against any consumer using either version. For the full schema and conversion semantics, see kcp’s exporting-apis and binding-apis docs.

APIExport — core.platform-mesh.io

The Platform Mesh core APIExport publishes the Account, AccountInfo, AuthorizationModel, Store, and Invite schemas, and claims access to upstream tenancy and Kubernetes resources it needs to reconcile:

# platform-mesh-operator/manifests/kcp/01-platform-mesh-system/apiexport-core.platform-mesh.io.yaml
# Excerpt — schema versions and the claim list change between releases.
# For the canonical content, see the manifest in the platform-mesh-operator
# release that ships with your Platform Mesh version.
apiVersion: apis.kcp.io/v1alpha1
kind: APIExport
metadata:
  name: core.platform-mesh.io
spec:
  latestResourceSchemas:
    - <version>.accountinfos.core.platform-mesh.io
    - <version>.accounts.core.platform-mesh.io
    - <version>.contentconfigurations.ui.platform-mesh.io
    - <version>.providermetadatas.ui.platform-mesh.io
    - <version>.authorizationmodels.core.platform-mesh.io
    - <version>.stores.core.platform-mesh.io
    - <version>.invites.core.platform-mesh.io
  permissionClaims:
    - resource: workspaces
      group: tenancy.kcp.io
      all: true
      identityHash: <tenancy-kcp-io-identity-hash>
    - resource: workspacetypes
      group: tenancy.kcp.io
      all: true
      identityHash: <tenancy-kcp-io-identity-hash>
    - resource: apibindings
      group: apis.kcp.io
      all: true
    - resource: apiexports
      group: apis.kcp.io
      all: true
    - resource: apiresourceschemas
      group: apis.kcp.io
      all: true
    - resource: logicalclusters
      group: core.kcp.io
      all: true
    - resource: secrets
      group: ""
      all: true

The identityHash values are filled in at apply time from the upstream tenancy.kcp.io APIExport’s status. The schema and claim lists in the live manifest evolve with each release; treat the YAML above as a structural example rather than a copy-paste source.

APIBinding — accepting permission claims

Consumers must explicitly accept each claim. The matching binding for the preceding export uses the v1alpha2 API, which adds selector and verbs:

# platform-mesh-operator/manifests/kcp/01-platform-mesh-system/apibinding-core.platform-mesh.io.yaml
apiVersion: apis.kcp.io/v1alpha2
kind: APIBinding
metadata:
  name: core.platform-mesh.io
spec:
  reference:
    export:
      name: core.platform-mesh.io
      path: root:platform-mesh-system
  permissionClaims:
  - resource: workspaces
    group: tenancy.kcp.io
    selector: { matchAll: true }
    verbs: ['*']
    state: Accepted
    identityHash: 
  - resource: identityproviderconfigurations
    group: core.platform-mesh.io
    selector: { matchAll: true }
    verbs: ['*']
    state: Accepted
    identityHash: 

selector.matchAll: true accepts every object in the resource type. Consumers can scope further with matchLabels or matchExpressions.

APIExportEndpointSlice

Provider controllers (and the rebac-authz-webhook) read this resource to discover the virtual-workspace URLs they should connect to. Each APIExport in Platform Mesh has a matching slice:

# platform-mesh-operator/manifests/kcp/01-platform-mesh-system/apiexportendpointslice-core.platform-mesh.io.yaml
apiVersion: apis.kcp.io/v1alpha1
kind: APIExportEndpointSlice
metadata:
  name: core.platform-mesh.io
spec:
  export:
    path: root:platform-mesh-system
    name: core.platform-mesh.io

The URLs land in status.endpoints[].url. See Virtual workspaces for how Platform Mesh consumes them.

Claim patterns across the platform-mesh org

Different providers claim different things. Three patterns to compare:

• api-syncagent — automatic claims. Every APIExport managed by api-syncagent gets events and namespaces claims injected automatically. If a PublishedResource declares a related Secret (for example, for connection credentials), api-syncagent adds a secrets claim too. Providers using api-syncagent rarely write claim YAML themselves. (related resources)
• gardener-syncer — full-access claim on Secrets. Claims secrets with verbs: ["*"] because it both reads provider credentials and writes Shoot-related secrets. (apiexport-core.gardener.cloud.yaml)
• resource-broker — verb-scoped read-only claim. Claims secrets with verbs: [get, list, watch]. The provider can observe credentials but cannot mutate them — the kind of claim platform owners want to see when reviewing provider onboarding. (apiexport-acceptapis.yaml)

selector also accepts matchLabels and matchExpressions. Every accepted claim across the platform-mesh org today uses matchAll: true; selectors are available for restriction by label but not in production use yet.

Claims added to an existing APIExport do not retroactively apply — consumers must update the binding to accept new claims explicitly.

Related

• API sharing — Platform Mesh layering and design
• Workspaces — where APIExports live and how defaultAPIBindings create bindings
• Virtual workspaces — the read/write endpoint published per export
• api-syncagent — auto-generates APIResourceSchema and APIExport from CRDs

This site is open source. Improve this page.