kcp-operator Documentation

Warning

While kcp-operator is usable, the project is still in an early state. Please only use it if you know what you are doing. We recommend against using it in production setups right now.

kcp-operator is a Kubernetes operator to deploy and run kcp instances on a Kubernetes cluster. kcp is a horizontally scalable control plane for Kubernetes-like APIs.

Features

• Create and update core components of a kcp setup (root shard, additional shards, front proxy)
• Support for multi-shard deployments of kcp
• Generate and refresh kubeconfigs for accessing kcp instances or specific shards

Support Matrix

The table below marks known support of a kcp version in kcp-operator versions.

kcp	main	0.1.x
main
0.28.x
0.27.x

Explanation:

• : This combination is actively tested in CI and is supported.
• : While we try to support kcp's main branch, this support is best effort and should not be used for deploying actual kcp instances.
• : While this could work, it is not actively validated by CI pipelines. Support for it is limited.

Contributing

We ❤️ our contributors! If you're interested in helping us out, please head over to our Contributing guide.

Getting in touch

There are several ways to communicate with us:

• The #kcp-dev channel in the Kubernetes Slack workspace.
• Our mailing lists:
  • kcp-dev for development discussions.
  • kcp-users for discussions among users and potential users.
• By joining the kcp-dev mailing list, you should receive an invite to our bi-weekly community meetings.
• See recordings of past community meetings on YouTube.
• The next community meeting dates are available via our CNCF community group.
• Check the community meeting notes document for future and past meeting agendas.
• Browse the shared Google Drive to share design docs, notes, etc.
  • Members of the kcp-dev mailing list can view this drive.