-
Notifications
You must be signed in to change notification settings - Fork 17
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
feat: Add configuration option to enable/disable Docker Scout #326
base: main
Are you sure you want to change the base?
Conversation
willis89pr
commented
Jan 21, 2025
- Integrated ConfigManager to retrieve 'enable_docker_scout' setting.
- Modified DockerScoutManager to respect the configuration option, allowing users to enable or disable Docker Scout functionality.
- Updated init_hook to conditionally check Docker Scout installation based on configuration.
- Added logic to short-circuit Docker Scout operations if disabled via configuration.
- Integrated ConfigManager to retrieve 'enable_docker_scout' setting. - Modified DockerScoutManager to respect the configuration option, allowing users to enable or disable Docker Scout functionality. - Updated init_hook to conditionally check Docker Scout installation based on configuration. - Added logic to short-circuit Docker Scout operations if disabled via configuration.
for more information, see https://pre-commit.ci
…L/Surfactant into cyt-1171-enable-docker-scout
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
surfactant/infoextractors/docker_image.py:27
- [nitpick] The variable name 'disable_docker_scout' is ambiguous. It should be renamed to 'docker_scout_enabled' for better clarity.
self.disable_docker_scout = not enable_docker_scout
surfactant/infoextractors/docker_image.py:45
- [nitpick] The error message could be clearer. Consider changing it to: 'You can also disable Docker Scout by running 'surfactant config docker.enable_docker_scout false'.'
You can also disable this check by running 'surfactant config docker.enable_docker_scout false'.
### Configuration Options | ||
|
||
- **docker.enable_docker_scout**: Controls whether Docker Scout is enabled. Default is `true`. To disable Docker Scout, run: | ||
|
||
```bash | ||
surfactant config docker.enable_docker_scout false | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add an entry for it to https://github.com/LLNL/Surfactant/blob/main/docs/settings.md?
I don't think we need an extensive list of options in the README since we link to the settings page, but since this might be a common setting users want to disable -- maybe we can remove the heading (so it is part of the "Command Line" section and reword it as being "another example of a setting to control information gathered is..."