chore: updated k8s base64 strings to remove newlines#8714
chore: updated k8s base64 strings to remove newlines#8714wiersgallak merged 5 commits intomasterfrom
Conversation
|
Newest code from mattermost has been published to preview environment for Git SHA 842752b |
1 similar comment
|
Newest code from mattermost has been published to preview environment for Git SHA 842752b |
|
Newest code from mattermost has been published to preview environment for Git SHA 1accb86 |
|
@angeloskyratzakos Can you give this the 2nd review it needs to merge? |
|
Newest code from mattermost has been published to preview environment for Git SHA 66b9d81 |
|
Newest code from mattermost has been published to preview environment for Git SHA 9fa27e7 |
📝 WalkthroughWalkthroughThree base64-encoded PostgreSQL connection strings in a Kubernetes secret manifest were updated by removing trailing newline characters. The values ending with "MTAK" were changed to end with "MTA=" to correct invalid control character parsing errors. No structural or control flow modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment Tip CodeRabbit can use Trivy to scan for security misconfigurations and secrets in Infrastructure as Code files.Add a .trivyignore file to your project to customize which findings Trivy reports. |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
source/deployment-guide/server/kubernetes/deploy-k8s.rst (1)
133-135: Add explicit encoding guidance to prevent newline regressions.Nice fix on Line 133, Line 134, and Line 135. To make this durable for readers, please add a short note near this example showing how to generate base64 without trailing newline (for example,
printf %s ... | base64orecho -n ... | base64), so users don’t reintroduce the issue when creating their own secrets.Suggested docs patch
Example for AWS Aurora with PostgreSQL: .. code-block:: yaml @@ type: Opaque + + .. note:: + + When generating secret values, avoid trailing newlines before base64 encoding. + Use commands like ``printf %s 'value' | base64`` (or ``echo -n 'value' | base64``) + so Kubernetes doesn’t decode an extra ``\n`` into the secret value.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@source/deployment-guide/server/kubernetes/deploy-k8s.rst` around lines 133 - 135, Add a short note next to the shown secret values (DB_CONNECTION_CHECK_URL, DB_CONNECTION_STRING, MM_SQLSETTINGS_DATASOURCEREPLICAS) explaining how to generate base64 without a trailing newline (e.g., use printf %s 'value' | base64 or echo -n 'value' | base64) so readers don’t accidentally include a newline when creating their own secrets; place this guidance immediately above or below the example lines so it’s visible when copying the commands.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@source/deployment-guide/server/kubernetes/deploy-k8s.rst`:
- Around line 133-135: Add a short note next to the shown secret values
(DB_CONNECTION_CHECK_URL, DB_CONNECTION_STRING,
MM_SQLSETTINGS_DATASOURCEREPLICAS) explaining how to generate base64 without a
trailing newline (e.g., use printf %s 'value' | base64 or echo -n 'value' |
base64) so readers don’t accidentally include a newline when creating their own
secrets; place this guidance immediately above or below the example lines so
it’s visible when copying the commands.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 47142f1c-9db8-4723-8a57-b4258b44dc30
📒 Files selected for processing (1)
source/deployment-guide/server/kubernetes/deploy-k8s.rst
|
Newest code from mattermost has been published to preview environment for Git SHA 11a892f |
Summary
Updated the base64 strings from the deploy to kubernetes example to remove newlines
Closes mattermost/mattermost-operator#342 (comment)
Summary by CodeRabbit