Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Agent Debug GetInfo method returns only count of cached X.509-SVIDs in svids_count field #3256

Closed
rturner3 opened this issue Jul 15, 2022 · 5 comments · Fixed by #5352
Closed
Assignees
Labels
priority/backlog Issue is approved and in the backlog

Comments

@rturner3
Copy link
Collaborator

rturner3 commented Jul 15, 2022

Agent Debug GetInfo API definition

The comment for the response field svids_count says:

// Number of SVIDs cached in memory
int32 svids_count = 3;

There is no specificity in the API documentation about what types of cached SVIDs are included in this count.

The SPIRE implementation of the Debug GetInfo method currently only returns the number X.509-SVIDs in the primary cache. It does not include other SVIDs cached, such as:

  • JWT-SVIDs
  • X.509-SVIDs in the svidstore cache

There appear to be a few high-level ways to rectify this inconsistency:

  1. Start including all cached SVIDs in svids_count
  2. Clarify the comment in the API proto to mention the count is only of X.509-SVIDs in the primary cache
  3. Deprecate the svids_count field in favor of more scoped fields, such as x509_svids_count and jwt_svids_count.

I would propose some version of option 3 for the long-term fix, as #3181 is attempting to rely on svids_count in an integration test to verify the number of X.509-SVIDs in the primary cache. Option 2 may optionally be done as well to address the immediate inconsistency.

@rturner3 rturner3 added the priority/backlog Issue is approved and in the backlog label Jul 15, 2022
@MarcosDY
Copy link
Collaborator

I agree with option 3 looks like the more natural and useful solution

@github-actions
Copy link

This issue is stale because it has been open for 365 days with no activity.

@github-actions github-actions bot added the stale label Jul 18, 2023
@rturner3 rturner3 removed the stale label Jul 25, 2023
Copy link

This issue is stale because it has been open for 365 days with no activity.

@github-actions github-actions bot added the stale label Jul 24, 2024
@azdagron azdagron removed the stale label Jul 25, 2024
@azdagron
Copy link
Member

The API changes have been made, just looking for someone to pick this up.

@azdagron azdagron added the help wanted Issues with this label are ready to start work but are in need of someone to do it label Jul 25, 2024
@FedeNQ
Copy link
Contributor

FedeNQ commented Aug 1, 2024

I can take this one ☝️

@MarcosDY MarcosDY removed the help wanted Issues with this label are ready to start work but are in need of someone to do it label Aug 1, 2024
@FedeNQ FedeNQ mentioned this issue Aug 2, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/backlog Issue is approved and in the backlog
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants