docs: correct stale rows in the values reference - #164
Merged
Conversation
22 tasks
aaronmgn
force-pushed
the
doc-fixes-02
branch
2 times, most recently
from
August 5, 2026 06:29
b68c482 to
77fb4d0
Compare
alix-graylog
approved these changes
Aug 5, 2026
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 values reference has rows for keys that do not exist, and defaults that do not agree with
values.yaml. This change corrects them.Details
graylog.enterprise: the row said that the key turns on enterprise features. The key selects the Enterprise image as the default repository. The chart ignores the key whengraylog.image.repositoryis set.mongodb.replicas: the documented default was2. The value is3.mongodb.arbiters: the documented default was1. The value is0.graylog.config.geolocation.maxmindGeoIp.cronScheduleandgraylog.config.geolocation.maxmindGeoIp.postInstallRun. Neither key is invalues.yamlor in a template. The README was the only place in the repository with these names.graylog.config.geolocation.maxmindGeoIp.enabled: the row described a CronJob. The key puts the MaxMind credentials into the chart Secret.sidecar.enabled,sidecar.schedule,sidecar.image.repository,sidecar.image.name,sidecar.image.tag, andmaxmindGeoIp.editionIds. The README had none of them.charts/graylog/values.yaml: the comment fordatanode.enabledsaid that the flag does not gate the Data Node ConfigMap and Secret. The flag gates both templates.Linked issues
None.
PR Checklist
Please check the items that apply to your change.
Testing Checklist
Static Validation
helm lint ./charts/grayloghelm template graylog ./charts/graylog --validate--validateneeds the MongoDB Operator CRD. The test cluster does not have it.helm templatewithout--validatepasses.Installation
helm install graylog ./charts/graylogkubectl rollout status statefulset/grayloghelm test graylogFunctional (if applicable)
Upgrade (if applicable)
This change edits documentation and one comment. The installation, functional, and upgrade tests did not run.
Specific to this PR
values.yaml. The key names and the defaults now agree: 0 differences.cronScheduleandpostInstallRunare no longer in the repository.{{- if .Values.datanode.enabled }}.helm lintpasses.helm unittestpasses: 332 tests in 28 suites.Notes for reviewers
Nobody checks the table against
values.yaml, and a person keeps it by hand. That is why these rows went stale.