Skip to content

docs(billing): genericize prod namespace + mongo pod in runbooks (OSS hygiene) - #3893

Merged
PierreBrisorgueil merged 1 commit into
masterfrom
chore/oss-genericize-billing-runbook-namespace
Jun 17, 2026
Merged

PierreBrisorgueil merged 1 commit into
masterfrom
chore/oss-genericize-billing-runbook-namespace

Conversation

@PierreBrisorgueil

@PierreBrisorgueil PierreBrisorgueil commented Jun 17, 2026 •

Copy link
Copy Markdown
Contributor

The billing runbooks + cron README hardcoded a specific Kubernetes namespace and a specific Mongo pod name inside copy-paste operational examples. A consumer pasting these would target the wrong namespace/pod.

Replaced with placeholders consistent with the rest of the docs (which already use <your-db> / your-org):

  • RUNBOOKS.md — kubectl logs -n <your-namespace> … and kubectl exec -n <your-namespace> <your-mongo-pod> …
  • crons/README.md — namespace: your-namespace # replace with your namespace

Docs-only, no behavior change.

Summary by CodeRabbit

  • Documentation
    • Updated billing module runbook and configuration examples to use parameterized placeholders instead of hardcoded environment values, enabling easier customization across different environments and setups.

Copilot AI review requested due to automatic review settings June 17, 2026 10:15
@coderabbitai

coderabbitai Bot commented Jun 17, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 99fb577d-976f-49c9-9ffe-510c924ad4af

📥 Commits

Reviewing files that changed from the base of the PR and between e4d7241 and 671589b.

📒 Files selected for processing (2)
  • modules/billing/RUNBOOKS.md
  • modules/billing/crons/README.md

Walkthrough

Two billing documentation files are updated to replace hardcoded Kubernetes namespace and pod names with generic placeholders. RUNBOOKS.md updates two kubectl command examples, and crons/README.md updates the metadata.namespace field in a CronJob manifest example.

Changes

Billing Docs Placeholder Cleanup

Layer / File(s) Summary
Namespace placeholder updates in runbooks and cron README
modules/billing/RUNBOOKS.md, modules/billing/crons/README.md
kubectl logs and kubectl exec commands in runbooks #3 and #6 now use <your-namespace> and <your-mongo-pod> placeholders; the CronJob manifest example namespace is updated from pierreb-projects to your-namespace with an inline comment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • pierreb-devkit/Node#3688: Introduced the distributed cron lock runbook and concurrency-control documentation that this PR's namespace placeholder edits directly refine.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: genericizing hardcoded production namespace and Mongo pod references in billing documentation for improved OSS usability.
Description check ✅ Passed The description adequately explains what changed, why (to prevent users from targeting wrong infrastructure), and provides specific examples of the placeholder replacements used.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/oss-genericize-billing-runbook-namespace

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates billing operational documentation to avoid hardcoding a specific Kubernetes namespace and MongoDB pod name, reducing the risk of consumers copy/pasting commands that target the wrong cluster resources.

Changes:

  • Replaced kubectl logs -n pierreb-projects ... with kubectl logs -n <your-namespace> ... in the billing runbooks.
  • Replaced kubectl exec -n pierreb-projects mongo-0 ... with kubectl exec -n <your-namespace> <your-mongo-pod> ... for the Mongo shell example.
  • Updated the CronJob YAML example to use namespace: your-namespace # replace with your namespace.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
modules/billing/RUNBOOKS.md Genericized kubectl namespace + mongo pod placeholders in runbook command examples.
modules/billing/crons/README.md Genericized the CronJob manifest example namespace to a placeholder value.

@PierreBrisorgueil
PierreBrisorgueil merged commit f9fbedd into master Jun 17, 2026
4 checks passed
@PierreBrisorgueil
PierreBrisorgueil deleted the chore/oss-genericize-billing-runbook-namespace branch June 17, 2026 10:18
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.

2 participants