feat: implement shared cache for bundle, git, and cluster resolvers by twoGiants · Pull Request #9051 · tektoncd/pipeline

twoGiants · 2025-09-30T14:11:32Z

Changes

This PR takes the state of PR #8825, starting from commit f817655 (actually 087c5a5 but the first is the big important one) and adds the re-work from the second review of @twoGiants on top of it.

All resolved comments are marked with a 👍 and a "resolved" comment.

What is left to do?

add back in InitializeFromConfigMap and implement functionality => maybe in Resolver.Initialize
- => comment from Vincent
add comment which test case covers cache misses implicitly: pkg/remoteresolution/resolver/cluster/resolver_test.go:TestResolve
encapsulate annotated resource => package scope
fix e2e tests
merge cache, cache/injection, framework/cache packages into => framework/cache/**
add/fix unit tests
resolve all of your TODO comments
implement config watching for cache

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
Has Tests included if any functionality added or changed
pre-commit Passed
Follows the commit message standard
Meets the Tekton contributor standards (including functionality, content, code)
Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

## Resolver Caching for Bundle, Git, and Cluster Resolvers
Support caching for bundle, git, and cluster resolvers, reducing redundant fetches and improving pipeline performance.

**Key Features:**
- **Automatic caching** for immutable references (digest-based bundles, git SHAs)
- **Three cache modes**: `always` (cache everything), `never` (disable caching),`auto` (cache only immutable references - default)
- **Configurable via ConfigMap**: Set cache size and TTL without restarting controllers
- **Per-task override**: Tasks can override global cache settings using the `cache` parameter
- **Observability**: Cache hits/misses and timestamps added to resource annotations

**Configuration:**
Control cache behavior via the `resolver-cache-config` ConfigMap with `max-size` (default: 1000) and `ttl` (default: 5m). Cache mode can be set globally in resolver ConfigMaps or per-task.

apiVersion: v1
kind: ConfigMap
metadata:
  name: resolver-cache-config
data:
  max-size: "1000"  # Maximum cache entries (default: 1000)
  ttl: "5m"         # Cache entry lifetime (default: 5m)

Set cache mode in resolver ConfigMaps (bundleresolver-config, git-resolver-config, cluster-resolver-config):

data:
  cache: "auto"  # Options: always, never, auto (default: auto)

Override cache behavior per-task using the cache parameter:

params:
  - name: cache
    value: "always"  # Force caching for this task

Cache annotations are added to resolved resources for observability.

This helps reduce external API calls, improves pipeline exec speed, and provides better resilience during remote resource resolution.

linux-foundation-easycla · 2025-09-30T14:11:38Z

The committers listed above are authorized under a signed CLA.

✅ login: waveywaves / name: Vibhav Bobade (1221ec3, 170f0a5, 401f09f, 76c2515, 9396379, 999fc78, bc192ae, ded85a8, e4f1f37)

tekton-robot · 2025-09-30T14:20:58Z

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/remoteresolution/cache/injection/cache.go	Do not exist	0.0%
pkg/remoteresolution/resolver/framework/cache.go	Do not exist	0.0%
pkg/remoteresolution/resolver/framework/reconciler.go	75.3%	73.8%	-1.6
pkg/remoteresolution/resolver/http/resolver.go	88.9%	100.0%	11.1
pkg/resolution/resolver/bundle/bundle.go	71.1%	71.4%	0.4
pkg/resolution/resolver/bundle/params.go	87.9%	86.1%	-1.8
pkg/resolution/resolver/cluster/resolver.go	80.4%	79.9%	-0.6
pkg/resolution/resolver/git/resolver.go	84.9%	84.3%	-0.6

waveywaves · 2025-09-30T14:31:30Z

@twoGiants I have been updating the original PR

waveywaves · 2025-10-01T06:40:55Z

I will contribute here instead

waveywaves · 2025-10-16T20:20:46Z

/retest

waveywaves · 2025-10-16T20:45:31Z

/retest

waveywaves · 2025-10-16T21:30:35Z

/retest

vdemeester

Looking good, still some questions/comments and todos

There is still some TODOs (the DEPRECATED functions in pkg/remoteresolution/cache package)
I am not a huge fan of loading the configmap when we start and not do anything else. I would prefer if we do the same as we do for the other configmap, we watch it from the controller, and we adapt from changes.
- As it is today, if you change the configuration for cache, you need to restart the deployment of resolvers
- If someone wants to enable cache on a running instance, same then, a manual intervention is needed

cmd/resolvers/main.go

pkg/remoteresolution/cache/injection/cache.go

pkg/remoteresolution/resolver/bundle/resolver.go

pkg/remoteresolution/resolver/cluster/resolver.go

vdemeester · 2025-10-17T08:07:14Z

pkg/remoteresolution/resolver/git/resolver.go

-			TTL:        r.ttl,
-			Params:     params,
+// IsImmutable implements ImmutabilityChecker.IsImmutable
+// Returns true if the revision parameter is a commit SHA (40-character hex string)


Quick note : as of today, a full git SHA is SHA-1, but tomorrow (git v3), it would/could but SHA-256, so we could try to take this case into account today already ? (or create a follow-up issue)

@waveywaves ☝️ 😸

pkg/remoteresolution/resolver/git/resolver.go

pkg/remoteresolution/resolver/framework/cache/configstore.go

vdemeester

I think we are good. There might be a few nits that we can do in a follow-up.
We will also need to stash some commits a bit, there is too much right now 🙃

tekton-robot · 2025-10-27T09:38:17Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [vdemeester]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

waveywaves · 2025-10-29T02:29:27Z

/retest

Implements a shared, thread-safe LRU cache with TTL expiration for Tekton resolvers (bundle, git, cluster). All resolvers share a single cache instance configured via ConfigMap with hot-reload support. Features: - Shared singleton cache across all resolver types - ConfigMap-based configuration (max-size, ttl) - Three cache modes: always, never, auto (immutability detection) - Thread-safe concurrent access with proper locking - Content-addressable keys using SHA-256 hashing - Observability via annotations (cache hit/miss, timestamps) - Clock interface for testable timestamp generation Testing: - Unit tests for cache operations, TTL, LRU eviction - Race detector tests for concurrent access - E2E tests for end-to-end cache behavior - High-load concurrency tests (1000 goroutines) Implementation uses k8s.io/apimachinery LRUExpireCache with ConfigMap watching for dynamic reconfiguration without restart. Co-authored-by: Brian Cook <[email protected]> Co-authored-by: Stanislav Jakuschevskij <[email protected]> Co-authored-by: Vibhav Bobade <[email protected]> Co-authored-by: AI Assistant <[email protected]>

…st.go

waveywaves · 2025-10-29T20:04:08Z

/retest

waveywaves · 2025-10-29T20:05:59Z

/retest

vdemeester · 2025-10-30T10:32:29Z

/lgtm

twoGiants · 2025-10-30T10:40:10Z

pkg/remoteresolution/resolver/framework/cache/configstore.go

This didn't change anything but make the cacheConfig and its properties public. @waveywaves

github-project-automation bot added this to Tekton Community Roadmap Sep 30, 2025

github-project-automation bot moved this to Todo in Tekton Community Roadmap Sep 30, 2025

tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Sep 30, 2025

tekton-robot requested review from jerop and pritidesai September 30, 2025 14:11

tekton-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Sep 30, 2025

vdemeester added this to the v1.6.0 (LTS) milestone Oct 7, 2025

waveywaves added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 13, 2025

waveywaves force-pushed the brianwcook-resolver-cache branch from 05fe2d2 to 4bc9258 Compare October 14, 2025 04:59

vdemeester requested changes Oct 17, 2025

View reviewed changes

twoGiants changed the title ~~🚧 👷 Re-work on "Add shared cache for resolvers" 🚧 🏗️~~ [WIP] 🚧 👷 Re-work on "Add shared cache for resolvers" 🚧 🏗️ [WIP] Oct 17, 2025

tekton-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 17, 2025

vdemeester reviewed Oct 20, 2025

View reviewed changes

pkg/remoteresolution/resolver/framework/cache/configstore.go Outdated Show resolved Hide resolved

waveywaves force-pushed the brianwcook-resolver-cache branch from 5ee1911 to f06cf00 Compare October 23, 2025 09:39

vdemeester approved these changes Oct 27, 2025

View reviewed changes

tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 27, 2025

waveywaves force-pushed the brianwcook-resolver-cache branch from 6aa0c9c to 0224721 Compare October 27, 2025 13:07

waveywaves changed the title ~~[WIP] 🚧 👷 Re-work on "Add shared cache for resolvers" 🚧 🏗️ [WIP]~~ feat: add shared cache for resolvers Oct 27, 2025

tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 27, 2025

waveywaves changed the title ~~feat: add shared cache for resolvers~~ feat: implement resolver caching for bundle, git, and cluster resolvers Oct 27, 2025

waveywaves changed the title ~~feat: implement resolver caching for bundle, git, and cluster resolvers~~ feat: implement shared cache for bundle, git, and cluster resolvers Oct 27, 2025

waveywaves force-pushed the brianwcook-resolver-cache branch from 0224721 to 23cba41 Compare October 27, 2025 18:54

waveywaves force-pushed the brianwcook-resolver-cache branch 2 times, most recently from 28ea88c to aa83b01 Compare October 29, 2025 09:28

waveywaves and others added 3 commits October 29, 2025 15:22

test: add verification to concurrent cache write and eviction tests

999fc78

test: merge resolver_cache_integration_test.go into resolver_cache_te…

170f0a5

…st.go

waveywaves force-pushed the brianwcook-resolver-cache branch 2 times, most recently from b6d58c3 to aefb3c1 Compare October 29, 2025 13:41

test: remove unnecessary tests in cache package

bc192ae

waveywaves force-pushed the brianwcook-resolver-cache branch from aefb3c1 to 97db47e Compare October 29, 2025 15:48

waveywaves added 2 commits October 29, 2025 21:34

test: add accessor methods and improve config change tests

1221ec3

test: fix TestCacheConcurrentWrites race detector flakiness

9396379

waveywaves force-pushed the brianwcook-resolver-cache branch from 97db47e to 9396379 Compare October 29, 2025 16:12

test: remove duplicate E2E tests and refactor common patterns

e4f1f37

waveywaves force-pushed the brianwcook-resolver-cache branch from 08e8c3a to 4b40ad4 Compare October 29, 2025 18:43

refactor: remove unused cacheConfigStore field from Reconciler

ded85a8

waveywaves force-pushed the brianwcook-resolver-cache branch from 4b40ad4 to ded85a8 Compare October 29, 2025 19:02

refactor: use knative configmap pattern for cache Config

401f09f

waveywaves force-pushed the brianwcook-resolver-cache branch from 991f504 to 401f09f Compare October 29, 2025 19:31

tekton-robot assigned vdemeester Oct 30, 2025

tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 30, 2025

tekton-robot merged commit 50999b6 into tektoncd:main Oct 30, 2025
57 of 63 checks passed

github-project-automation bot moved this from Todo to Done in Tekton Community Roadmap Oct 30, 2025

twoGiants commented Oct 30, 2025

View reviewed changes

vdemeester deleted the brianwcook-resolver-cache branch October 30, 2025 11:27

twoGiants mentioned this pull request Nov 15, 2025

refactor: add clock injection to cache for testing #9142

Merged

8 tasks

twoGiants mentioned this pull request Dec 13, 2025

TEP-161: Resolver cache implementation follow-up tasks #9228

Open

Conversation

twoGiants commented Sep 30, 2025 • edited by waveywaves Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

What is left to do?

Submitter Checklist

Release Notes

Uh oh!

linux-foundation-easycla bot commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tekton-robot commented Sep 30, 2025

Uh oh!

waveywaves commented Sep 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

waveywaves commented Oct 1, 2025

Uh oh!

waveywaves commented Oct 16, 2025

Uh oh!

waveywaves commented Oct 16, 2025

Uh oh!

waveywaves commented Oct 16, 2025

Uh oh!

vdemeester left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vdemeester Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

twoGiants Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vdemeester left a comment

Choose a reason for hiding this comment

Uh oh!

tekton-robot commented Oct 27, 2025

Uh oh!

waveywaves commented Oct 29, 2025

Uh oh!

waveywaves commented Oct 29, 2025

Uh oh!

waveywaves commented Oct 29, 2025

Uh oh!

vdemeester commented Oct 30, 2025

Uh oh!

Uh oh!

twoGiants Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

twoGiants commented Sep 30, 2025 •

edited by waveywaves

Loading

linux-foundation-easycla bot commented Sep 30, 2025 •

edited

Loading

waveywaves commented Sep 30, 2025 •

edited

Loading