Add a paginated endpoint for retrieving all Applications by rosstimothy · Pull Request #56324 · gravitational/teleport

rosstimothy · 2025-07-01T20:42:54Z

A new ListApps RPC has been added to the auth service to retrieve pages of applications and should be preferred over the existing GetApps RPC. The cache and tctl get have been updated to prefer using ListApps, but fallback to GetApps if the upstream does not yet implement the paginated API.

Changelog: Update Application APIs to use pagination to avoid exceeding message size limitations.

marcoandredinis

Just one comment on checking for NotFound instead of NotImplemented on tctl.
Everything else lgtm

espadolini · 2025-07-09T10:17:08Z

+			// TODO(tross): DELETE IN v21.0.0
+			if trace.IsNotImplemented(err) {


Can we have the client's GetApps method use Apps with the fallback to the old rpc instead so we don't have to add a million fallbacks from Collect(Apps) to GetApps everywhere? There's a precedent for this, the client's GetNodes also does this.

I don't know that I like that pattern too much though. I think it causes confusion around whether the API is paginated or not.

Should we deprecate the GetApps method then, at least in v19?

Is there any reason to use the unpaginated endpoint? Even with the deprecation warning, I wonder about existing code using the api module, it would be nice if we could transparently make it not die if there's too many apps in a cluster (and I'm not even sure if we should deprecate methods in the middle of a major).

What are our other options? Not populate the cache if the upstream doesn't support ListApps? Also, I don't plan on backporting the deprecation of the API beyond master.

Deprecate GetApps as a method and implement it using Collect+Resources+ListApps just for the transitional period, I guess?

espadolini · 2025-07-10T08:51:35Z

+			// TODO(tross): DELETE IN v21.0.0
+			if trace.IsNotImplemented(err) {


Is there any reason to use the unpaginated endpoint? Even with the deprecation warning, I wonder about existing code using the api module, it would be nice if we could transparently make it not die if there's too many apps in a cluster (and I'm not even sure if we should deprecate methods in the middle of a major).

A new ListApps RPC has been added to the auth service to retrieve pages of applications and should be preferred over the existing GetApps RPC. The cache and tctl get have been updated to prefer using ListApps, but fallback to GetApps if the upstream does not yet implement the paginated API.

backport-bot-workflows · 2025-07-11T15:51:19Z

@rosstimothy See the table below for backport results.

Branch	Result
branch/v16	Failed
branch/v17	Failed
branch/v18	Failed

…6727) A new ListApps RPC has been added to the auth service to retrieve pages of applications and should be preferred over the existing GetApps RPC. The cache and tctl get have been updated to prefer using ListApps, but fallback to GetApps if the upstream does not yet implement the paginated API.

A new ListApps RPC has been added to the auth service to retrieve pages of applications and should be preferred over the existing GetApps RPC. The cache and tctl get have been updated to prefer using ListApps, but fallback to GetApps if the upstream does not yet implement the paginated API.

…6949) A new ListApps RPC has been added to the auth service to retrieve pages of applications and should be preferred over the existing GetApps RPC. The cache and tctl get have been updated to prefer using ListApps, but fallback to GetApps if the upstream does not yet implement the paginated API.

…6954) A new ListApps RPC has been added to the auth service to retrieve pages of applications and should be preferred over the existing GetApps RPC. The cache and tctl get have been updated to prefer using ListApps, but fallback to GetApps if the upstream does not yet implement the paginated API.

This RPC was already previously deprecated in #56324, this commit updates the proto and the linter plugin to match.

rosstimothy force-pushed the tross/paginated_resource_apis branch from e8f7b37 to 2610982 Compare July 1, 2025 21:02

rosstimothy marked this pull request as ready for review July 2, 2025 11:56

github-actions bot added size/lg tctl tctl - Teleport admin tool labels Jul 2, 2025

github-actions bot requested review from fspmarshall and marcoandredinis July 2, 2025 11:56

marcoandredinis reviewed Jul 4, 2025

View reviewed changes

Comment thread lib/auth/auth_with_roles.go Outdated

Comment thread tool/tctl/common/resource_command.go Outdated

marcoandredinis approved these changes Jul 4, 2025

View reviewed changes

rosstimothy force-pushed the tross/paginated_resource_apis branch from 2610982 to 4a648a8 Compare July 7, 2025 12:17

rosstimothy requested a review from espadolini July 8, 2025 13:56

espadolini reviewed Jul 9, 2025

View reviewed changes

Comment thread api/client/client.go

espadolini reviewed Jul 9, 2025

View reviewed changes

rosstimothy force-pushed the tross/paginated_resource_apis branch from 4a648a8 to c07fd60 Compare July 9, 2025 15:13

rosstimothy requested a review from espadolini July 9, 2025 16:47

espadolini reviewed Jul 10, 2025

View reviewed changes

rosstimothy requested a review from espadolini July 11, 2025 11:59

espadolini approved these changes Jul 11, 2025

View reviewed changes

public-teleport-github-review-bot bot removed the request for review from fspmarshall July 11, 2025 12:36

rosstimothy force-pushed the tross/paginated_resource_apis branch from 177324d to 19cee39 Compare July 11, 2025 12:54

rosstimothy added backport/branch/v16 backport/branch/v17 backport/branch/v18 labels Jul 11, 2025

rosstimothy force-pushed the tross/paginated_resource_apis branch from 19cee39 to 63bb43c Compare July 11, 2025 14:00

rosstimothy enabled auto-merge July 11, 2025 14:01

rosstimothy added this pull request to the merge queue Jul 11, 2025

Merged via the queue into master with commit 7449994 Jul 11, 2025
44 of 45 checks passed

rosstimothy deleted the tross/paginated_resource_apis branch July 11, 2025 15:49

mjsmithnh mentioned this pull request Jul 16, 2025

[v18][17.5.4] bump cloud docs #56865

Merged

rosstimothy mentioned this pull request Jul 18, 2025

[v17] Add a paginated endpoint for retrieving all Applications #56949

Merged

rosstimothy mentioned this pull request Jul 18, 2025

[v16] Add a paginated endpoint for retrieving all Applications #56954

Merged

mjsmithnh mentioned this pull request Aug 7, 2025

[v18] Support cluster level KMS key filtering during deletion #57671

Merged

okraport added a commit that referenced this pull request Sep 22, 2025

Mark GetApps proto as deprecated

bd9ef90

This RPC was already previously deprecated in #56324, this commit updates the proto and the linter plugin to match.

okraport mentioned this pull request Sep 22, 2025

Mark GetApps proto as deprecated #59426

Merged

okraport added a commit that referenced this pull request Sep 26, 2025

Mark GetApps proto as deprecated

90a6433

This RPC was already previously deprecated in #56324, this commit updates the proto and the linter plugin to match.

github-merge-queue bot pushed a commit that referenced this pull request Sep 26, 2025

Mark GetApps proto as deprecated (#59426)

2a5ef5f

This RPC was already previously deprecated in #56324, this commit updates the proto and the linter plugin to match.

rhammonds-teleport pushed a commit that referenced this pull request Nov 6, 2025

Mark GetApps proto as deprecated (#59426)

da85d99

This RPC was already previously deprecated in #56324, this commit updates the proto and the linter plugin to match.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a paginated endpoint for retrieving all Applications#56324

Add a paginated endpoint for retrieving all Applications#56324
rosstimothy merged 1 commit intomasterfrom
tross/paginated_resource_apis

rosstimothy commented Jul 1, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

marcoandredinis left a comment

Uh oh!

Uh oh!

espadolini Jul 9, 2025

Uh oh!

rosstimothy Jul 9, 2025

Uh oh!

espadolini Jul 9, 2025

Uh oh!

rosstimothy Jul 9, 2025

Uh oh!

espadolini Jul 10, 2025

Uh oh!

rosstimothy Jul 10, 2025

Uh oh!

espadolini Jul 10, 2025

Uh oh!

Uh oh!

espadolini Jul 10, 2025

Uh oh!

Uh oh!

backport-bot-workflows bot commented Jul 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		// TODO(tross): DELETE IN v21.0.0
		if trace.IsNotImplemented(err) {

Conversation

rosstimothy commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marcoandredinis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

backport-bot-workflows bot commented Jul 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rosstimothy commented Jul 1, 2025 •

edited

Loading