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

Enable caching for plugin binary artifacts #1854

Open
ramizpolic opened this issue Jul 1, 2024 · 0 comments
Open

Enable caching for plugin binary artifacts #1854

ramizpolic opened this issue Jul 1, 2024 · 0 comments
Labels
enhancement New feature or request no-stale Marks an issue so that it never goes stale. scanners Issues related to adding new scanners

Comments

@ramizpolic
Copy link
Member

ramizpolic commented Jul 1, 2024

Problem Statement

The downloaded artifacts for binary mode are not cached between runs. It would be useful to allow caching to reduce time needed to setup and perform a scan using plugins.

Proposed Solution

Add two more config options for plugins to allow users to

  1. specify custom dir if they want the plugin data to be saved/loaded to allow caching via binary_artifacts_path which would default to ${HOME}/.vmclarity/plugins if not specified
  2. specify keep/clean option if they want to preserve artifacts pulled in in a given run via binary_artifacts_keep. Alternatively, binary_artifacts_clean config can be used that defaults to preserve behaviour when not specified.

For example

## reruns preserve new and reuse existing artifacts
binary_artifacts_path: /tmp/plugin-artifacts
binary_artifacts_keep: true
# or binary_artifacts_clean: false

## reruns reuse existing artifacts between runs but do not preserve the new artifacts
binary_artifacts_path: /tmp/plugin-artifacts
binary_artifacts_keep: false
# or binary_artifacts_clean: true

## reruns neither reuse nor preserve
# empty binary_artifact configs
# or binary_artifacts_clean: true
@ramizpolic ramizpolic added scanners Issues related to adding new scanners enhancement New feature or request no-stale Marks an issue so that it never goes stale. labels Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request no-stale Marks an issue so that it never goes stale. scanners Issues related to adding new scanners
Projects
None yet
Development

No branches or pull requests

1 participant