kcp-operator

module
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 12, 2026 License: Apache-2.0

README

kcp-dev/kcp-operator

Go Report Card GitHub GitHub release (latest SemVer)

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
  • Support for a dedicated cache-server deployment not embedded in the root shard
  • Generate and refresh kubeconfigs for accessing kcp instances or specific shards
  • Cross-namespace/-cluster setups of a multi-shard kcp deployment

Support Matrix

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

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

[^1]: While we try to support kcp's main branch, this support is best effort and should not be used for deploying actual kcp instances.

Feature Gates

kcp-operator supports Kubernetes-style feature gates to enable or disable experimental features. Feature gates can be configured using the --feature-gates flag when starting the operator.

Available Feature Gates
Feature Default Stage Description
ConfigurationBundle false Alpha Enable the configuration bundle feature for managing bundled kcp configurations and resources
Usage

Enable feature gates when starting the operator:

# Enable a single feature
./operator --feature-gates=ConfigurationBundle=true

# Enable multiple features
./operator --feature-gates=ConfigurationBundle=true,AnotherFeature=true

For more details on feature gates, see the feature gates documentation.

Contributing

Thanks for taking the time to start contributing! Please check out our contributor documentation.

Before You Start
Pull Requests
  • We welcome pull requests. Feel free to dig through the issues and jump in.

Changelog

See the list of releases to find out about feature changes.

License

This project is licensed under Apache-2.0.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL