docs: fix the credential and external MongoDB examples - #162
Merged
Conversation
23 tasks
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
Two example files have three faults. A user who copies them gets a broken installation.
Details
examples/graylog-secret.yaml: usestringDatain place ofdata. The committed values decoded to 65 and 97 bytes, not 64 and 96. The hash kept a newline fromcut, and the pepper kept one frompwgen. The commands in the file made the same fault for every user. All credential values are now placeholders, and the hash command usesprintf.GRAYLOG_ROOT_USERNAMEkeeps the valueadmin, and the two MaxMind keys stay empty.examples/values-existing-secret-external-mongodb.yaml: delete the secondgraylog:key. YAML keeps the last duplicate, so the file discarded its ownreplicas: 3and its resource limits.GRAYLOG_MONGODB_URIthroughbase64before--from-literal.kubectlencodes the value, so Graylog got base64 text in place of a URI. The init container then stopped.docs/bring-your-own-mongo.md: the text said that the example uses base64 encoded variables. This is not correct.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 two examples and one document. The installation, functional, and upgrade tests did not run.
Specific to this PR
replicas=2and a memory limit of2Gi, which are the chart defaults. After:replicas=3and a memory limit of3Gi, which the file asks for.kubectl apply --dry-run=client -f examples/graylog-secret.yamlpasses.cutstill adds a newline, so the command writes 65 bytes. The digest that a reader copies is 64 characters.helm unittestpasses: 332 tests in 28 suites.Notes for reviewers