Skip to content

docs: correct stale rows in the values reference - #164

Merged
aaronmgn merged 1 commit into
mainfrom
doc-fixes-02
Aug 5, 2026
Merged

docs: correct stale rows in the values reference#164
aaronmgn merged 1 commit into
mainfrom
doc-fixes-02

Conversation

@aaronmgn

@aaronmgn aaronmgn commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

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 when graylog.image.repository is set.
  • mongodb.replicas: the documented default was 2. The value is 3.
  • mongodb.arbiters: the documented default was 1. The value is 0.
  • Deleted graylog.config.geolocation.maxmindGeoIp.cronSchedule and graylog.config.geolocation.maxmindGeoIp.postInstallRun. Neither key is in values.yaml or 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.
  • Added the sidecar rows that replaced the CronJob: sidecar.enabled, sidecar.schedule, sidecar.image.repository, sidecar.image.name, sidecar.image.tag, and maxmindGeoIp.editionIds. The README had none of them.
  • charts/graylog/values.yaml: the comment for datanode.enabled said 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.

  • Tests added/updated
  • Documentation updated
  • This PR includes a new feature
  • This PR includes a bugfix
  • This PR includes a refactor

Testing Checklist

Static Validation

  • Linter check passes: helm lint ./charts/graylog
  • Helm renders local template sucessfully: helm template graylog ./charts/graylog --validate

--validate needs the MongoDB Operator CRD. The test cluster does not have it. helm template without --validate passes.

Installation

  • Fresh installation completes successfully: helm install graylog ./charts/graylog
  • All pods reach Running state: kubectl rollout status statefulset/graylog
  • Helm tests pass: helm test graylog

Functional (if applicable)

  • Web UI accessible and login works
  • DataNodes visible in System > Cluster Configuration
  • Inputs can be created and receive data

Upgrade (if applicable)

  • Upgrade from previous release succeeds
  • Scaling up/down works correctly
  • Configuration changes apply correctly

This change edits documentation and one comment. The installation, functional, and upgrade tests did not run.

Specific to this PR

  • Compared every changed row against values.yaml. The key names and the defaults now agree: 0 differences.
  • cronSchedule and postInstallRun are no longer in the repository.
  • Both Data Node templates start with {{- if .Values.datanode.enabled }}.
  • helm lint passes. helm unittest passes: 332 tests in 28 suites.

Notes for reviewers

  • Verify all applicable tests above pass
  • Validate that the linked issues are no longer reproducible, if applicable
  • Sync up with the author before merging
  • The commit history should be preserved - use rebase-merge or standard merge options when applicable

Nobody checks the table against values.yaml, and a person keeps it by hand. That is why these rows went stale.

@CLAassistant

CLAassistant commented Aug 5, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@aaronmgn
aaronmgn force-pushed the doc-fixes-02 branch 2 times, most recently from b68c482 to 77fb4d0 Compare August 5, 2026 06:29
@aaronmgn
aaronmgn merged commit a81dd57 into main Aug 5, 2026
9 checks passed
@aaronmgn
aaronmgn deleted the doc-fixes-02 branch August 5, 2026 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants