everettraven / everettraven/telescopia

Allow `ScopedCache` to be configured with the controller-runtime `cache.Options`

Open
#4 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
0
Forks
2
PR merge metrics
No merged PRs in 30d

Description

## Description
Currently the `ScopedCache` can be partially configured with the [controller-runtime `cache.Options`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options).

The current logic for configuration can be found here: https://github.com/everettraven/telescopia/blob/c76339b193e66f424af9731b866c050b12169339/pkg/cache/cache.go#L82-L99

To help ease the transition from traditional controller-runtime caches, we should support as much configuration as possible via the [controller-runtime `cache.Options`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options).

To accomplish this we need to evaluate which options in the [controller-runtime `cache.Options`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options) can/can't be used for configuration and document it via comments above the [`ScopedCacheBuilder` function](https://github.com/everettraven/telescopia/blob/c76339b193e66f424af9731b866c050b12169339/pkg/cache/cache.go#L81). For any options the dynamic cache can support we should implement any necessary logic for applying the configuration.

## Acceptance Criteria
- Add logic for handling configuration options that the `ScopedCache` can use from the [controller-runtime `cache.Options`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options)
- Add comments above the [`ScopedCacheBuilder` function](https://github.com/everettraven/telescopia/blob/c76339b193e66f424af9731b866c050b12169339/pkg/cache/cache.go#L81) for options that the `ScopedCache` can not use from the [controller-runtime `cache.Options`](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options)
- Unit tests

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.