Fix README resource defaults to match values.yaml - #18
Open
chrisboyd-kentik wants to merge 1 commit into
Open
Conversation
The Resources section in the README listed incorrect default values (100m/128Mi/500m/512Mi) that don't match the actual chart defaults in values.yaml (1/1024Mi/2/4096Mi). Also removed the DaemonSet-specific values that aren't defined in the chart (the same resource values apply regardless of deployment pattern). Fixes: UA-440
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Helm chart documentation so the README’s documented default resource requests/limits match the actual defaults defined in values.yaml, avoiding confusion when users install the chart with no overrides.
Changes:
- Corrected the documented defaults for
resources.requests.*andresources.limits.*inREADME.mdto matchvalues.yaml. - Removed DaemonSet-specific “(X for DaemonSet)” notes since the chart uses the same
.Values.resourcesacross deployment types.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The Resources section in the README listed incorrect default values that don't match the actual chart defaults in
values.yaml.Problem
The README documented these resource defaults:
100m(50m for DaemonSet)128Mi(64Mi for DaemonSet)500m(200m for DaemonSet)512Mi(256Mi for DaemonSet)But the actual
values.yamldefaults are:11024Mi24096MiThis was confirmed by running an unmodified helm install to a local K8s cluster.
Changes
values.yamlFixes: UA-440