cachedresources

package

v0.32.0 Latest Latest Go to latest Published: Jun 15, 2026 License: Apache-2.0 Imports: 44 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kcp-dev/kcp

Links

README ¶

CachedResources controller

This controller acts on CachedResources objects and based on configured GroupVersionKind - replicated them into cache server. To replicate objects 'wrapper' object is used CachedObject. Objects are named based on the original gvr. Example:

Object targeted by CachedResource bellow:

apiVersion: machines.svm.io/v1alpha1
kind: Instance
metadata:
  name: web-server-1

would be replicated into cache server:

apiVersion: cache.kcp.io/v1alpha1
Kind: CachedObject
metadata:
  name: v1alpha1.instances.machines.svm.io.web-server-1
  labels:
    cache.kcp.io/object-schema: v1alpha1.instances.machines.svm.io
    cache.kcp.io/object-group: machines.svm.io
    cache.kcp.io/object-version: v1alpha1
    cache.kcp.io/object-resource: instances
    cache.kcp.io/object-original-name: web-server-1
    cache.kcp.io/object-original-namespace: <empty>

Labels are used to filter object based on group, schema, etc. This way we can get individual object by knowing full gvr + name or just schema.

Main controller (CachedResources) for each CachedResource starts child replication controller with 2 informers:

Local - targeting native type (in example instances) to get every change for it.
Global - targeting CachedObject from the cache server

It will observe both cache and local states and makes sure object are replicated. On deletion of CachedResources cache is purged and controller stopped after purge is done.

Delete flow:

CachedResource is deleted
Root controller sets phase to Deleting
Root controller gives signal to child controller as its deleted so its stops replicating
Replication root controller will purge the selected resources and flips the status to Deleted
Once it flips status to Deleted - finalizer is removed and controller stopped.

TODO

Make global informer filtered, so it filters only its own schema. Else, with multiple objects in the API it will get everything.
Add secrets reference for Identity hash
Potentially see if we can remove roundtripping to unstructured in the child replication controller.

Documentation ¶

Index ¶

Constants
func GVRAndLogicalClusterKey(gvr schema.GroupVersionResource, cluster logicalcluster.Name) string
func GenerateIdentitySecret(ctx context.Context, ns string, name string) (*corev1.Secret, error)
func GroupResourceKey(gr schema.GroupResource) string
func IdentityAndGroupResourceKey(identity string, gr schema.GroupResource) string
func IndexByGVRAndLogicalCluster(obj interface{}) ([]string, error)
func IndexByGroupResource(obj interface{}) ([]string, error)
func IndexByIdentityAndGroupResource(obj interface{}) ([]string, error)
type CachedResourceResource
type Controller
- func NewController(shardName string, kcpClusterClient kcpclientset.ClusterInterface, ...) (*Controller, error)
- func (c *Controller) Start(ctx context.Context, numThreads int)

Constants ¶

View Source

const (
	ControllerName = "kcp-cached-resources-controller"

	DefaultIdentitySecretNamespace = "kcp-system"
)

This Controller starts 1 published resource controller per shard. This is bit wasteful for now. We can optimize this by starting a single controller per logical cluster. But this required stopping and starting the controller when a new published resource is created. This would be fist optimization we need todo as follow-up before removing feature flag and making it enabled by default.

View Source

const (
	// AnnotationResourceKind is set on CachedResource objects to record the Kind of the cached resource.
	AnnotationResourceKind = "cache.kcp.io/resource-kind"

	// AnnotationResourceScope records the REST scope of the cached resource: "Namespaced" or "Cluster".
	AnnotationResourceScope = "cache.kcp.io/resource-scope"
)

View Source

const (
	// ByGVRAndLogicalCluster is the name for the index that indexes by an object's gvr and logical cluster.
	ByGVRAndLogicalCluster = "kcp-byGVRAndLogicalCluster"

	// ByIdentityAndGroupResource is the name for the index that indexes by an object's identity hash and group/resource.
	ByIdentityAndGroupResource = "kcp-byIdentityAndGroupResource"

	ByGroupResource = "kcp-byGroupResource"
)

Variables ¶

This section is empty.

Functions ¶

func GVRAndLogicalClusterKey ¶

func GVRAndLogicalClusterKey(gvr schema.GroupVersionResource, cluster logicalcluster.Name) string

GVRAndShardAndLogicalClusterAndNamespaceKey creates an index key from the given parameters. Key will be in the form of version.resource.group|cluster.

func GenerateIdentitySecret ¶

func GenerateIdentitySecret(ctx context.Context, ns string, name string) (*corev1.Secret, error)

TODO: This is copy from apiexport controller. We should move it to a shared location.

func GroupResourceKey ¶ added in v0.32.0

func GroupResourceKey(gr schema.GroupResource) string

GroupResourceKey creates an index key from an identity hash and group/resource.

func IdentityAndGroupResourceKey ¶ added in v0.32.0

func IdentityAndGroupResourceKey(identity string, gr schema.GroupResource) string

IdentityAndGroupResourceKey creates an index key from an identity hash and group/resource.

func IndexByGVRAndLogicalCluster ¶

func IndexByGVRAndLogicalCluster(obj interface{}) ([]string, error)

IndexByShardAndLogicalClusterAndNamespace is an index function that indexes by an object's gvr and logical cluster.

func IndexByGroupResource ¶ added in v0.32.0

func IndexByGroupResource(obj interface{}) ([]string, error)

IndexByGroupResource is an index function that indexes by an object's group/resource.

func IndexByIdentityAndGroupResource ¶ added in v0.32.0

func IndexByIdentityAndGroupResource(obj interface{}) ([]string, error)

IndexByIdentityAndGroupResource is an index function that indexes by an object's identity hash and group/resource. Objects with an empty identity hash are not indexed.

Types ¶

type CachedResourceResource ¶

type CachedResourceResource = committer.Resource[*cachev1alpha1.CachedResourceSpec, *cachev1alpha1.CachedResourceStatus]

type Controller ¶

type Controller struct {
	CachedResourceIndexer cache.Indexer
	CachedResourceLister  cachev1alpha1listers.CachedResourceClusterLister

	CachedResourceEndpointSliceInformer cacheinformers.CachedResourceEndpointSliceClusterInformer
	// contains filtered or unexported fields
}

func NewController ¶

func NewController(
	shardName string,
	kcpClusterClient kcpclientset.ClusterInterface,
	kcpCacheClient kcpclientset.ClusterInterface,
	localDynamicClient kcpdynamic.ClusterInterface,
	globalDynamicClient kcpdynamic.ClusterInterface,

	kubeClusterClient kcpkubernetesclientset.ClusterInterface,
	namespaceInformer kcpcorev1informers.NamespaceClusterInformer,
	secretInformer kcpcorev1informers.SecretClusterInformer,

	cacheApiExtensionsClusterClient kcpapiextensionsclientset.ClusterInterface,
	cacheApiExtensionsClusterInformer kcpapiextensionsinformers.SharedInformerFactory,

	dynRESTMapper *dynamicrestmapper.DynamicRESTMapper,

	localDiscoveringDynamicKcpInformers *informer.DiscoveringDynamicSharedInformerFactory,
	globalDiscoveringDynamicKcpInformers *informer.DiscoveringDynamicSharedInformerFactory,

	cachedResourceInformer cacheinformers.CachedResourceClusterInformer,
	cachedResourceEndpointSliceInformer cacheinformers.CachedResourceEndpointSliceClusterInformer,
) (*Controller, error)

NewController returns a new controller for CachedResource objects.

func (*Controller) Start ¶

func (c *Controller) Start(ctx context.Context, numThreads int)

Start starts the controller, which stops when ctx.Done() is closed.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
replication

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