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

[BUG] wrong defaults in the helm chart docs #1032

Closed
1 task
sozercan opened this issue May 22, 2024 · 3 comments · Fixed by #1034
Closed
1 task

[BUG] wrong defaults in the helm chart docs #1032

sozercan opened this issue May 22, 2024 · 3 comments · Fixed by #1034
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@sozercan
Copy link
Member

sozercan commented May 22, 2024

Version of Eraser

n/a

Expected Behavior

runtimeConfig.components.collector | Settings for the collector component. | { enabled: true }
-- | -- | --
runtimeConfig.components.scanner | Settings for the scanner component. | { enabled: true }

https://github.com/eraser-dev/eraser/blob/main/charts/eraser/values.yaml#L39-L50

since this is generated actual change needs to be in: https://github.com/eraser-dev/eraser/blob/main/third_party/open-policy-agent/gatekeeper/helmify/static/README.md

Actual Behavior

helm chart docs have the wrong defaults for collector and scanner. we should also check if anything else has the wrong defaults
https://github.com/eraser-dev/eraser/blob/main/charts/eraser/values.yaml#L39-L50

runtimeConfig.components.collector | Settings for the collector component. | { enabled: false }
-- | -- | --
runtimeConfig.components.scanner | Settings for the scanner component. | { enabled: false }

Steps To Reproduce

No response

Are you willing to submit PRs to contribute to this bug fix?

  • Yes, I am willing to implement it.
@sozercan sozercan added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 22, 2024
@akhilsaivenkata
Copy link
Contributor

/assign

@akhilsaivenkata
Copy link
Contributor

Hi @sozercan , Its also mentioned that we need to check if anything else has the wrong defaults in that file. So what is the source of truth to validate? does official documentation works?

@sozercan
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants