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

Deprecated Insights v1 in Favour of Insights v2 #277

Open
abhisek opened this issue Nov 14, 2024 · 0 comments
Open

Deprecated Insights v1 in Favour of Insights v2 #277

abhisek opened this issue Nov 14, 2024 · 0 comments

Comments

@abhisek
Copy link
Member

abhisek commented Nov 14, 2024

This is a larger revamp and should have multiple PRs targeting this issue. We should not create one large PR which will be risky and hard to review.

#274 introduces integration with Insights v2 service with specifications available in https://buf.build/safedep/api. This is a completely revamped Insights Service with much richer metadata including our own metadata that we generate through our automation. Going forward, we will primarily support Insights v2 and slowly phase out Insights v1. This sunset window is required because Insights v1 data model is strongly coupled with analysers and reporters

The approach for this migration will be:

  • Revamp reporters to start using Insights V2 data model pkg.insightsv2
  • Revamp analysers to start using Insights V2 data model
  • Make Insights v2 as the default enricher in scan

To support this migration, we will also revamp the policy framework to support a spec driven Policy to be defined at https://buf.build/safedep/api/docs/main:safedep.messages.policy.v1 To complete migrations, we need to migrate our policies to leverage the Insights v2 model

Once this is done, we need to monitor Insights service logs and metrics for usage. Once the usage is below a threshold, we should inform the community about deprecation of Insights v1 and steps to completely migrate to Insights v2 compatibility. From a user perspective, this would involve

  1. Update to latest version of vet
  2. Update custom policies to use new specification
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant