Skip to content

docs(self-hosting): NodeLocal DNS and ClickHouse task events#3568

Open
isshaddad wants to merge 3 commits into
mainfrom
docs/self-hosting-dns-and-clickhouse-events
Open

docs(self-hosting): NodeLocal DNS and ClickHouse task events#3568
isshaddad wants to merge 3 commits into
mainfrom
docs/self-hosting-dns-and-clickhouse-events

Conversation

@isshaddad
Copy link
Copy Markdown
Collaborator

Summary

  • Recommend deploying NodeLocal DNS and lowering ndots to 1 in the Kubernetes self-hosting guide.
  • Recommend storing task events in ClickHouse (EVENT_REPOSITORY_DEFAULT_STORE=clickhouse_v2) in both the Docker and Kubernetes guides, plus a new row in the webapp env var reference.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 12, 2026

⚠️ No Changeset found

Latest commit: 2f0e3b1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 12, 2026

Review Change Stack

Walkthrough

This PR updates self-hosting documentation to explain task event storage configuration. The changes introduce a new "Task events" section across Docker and Kubernetes documentation that describes default PostgreSQL storage and how to configure ClickHouse as an alternative via the EVENT_REPOSITORY_DEFAULT_STORE environment variable. The webapp environment variable documentation is updated to include this new variable. Additional changes include Kubernetes DNS performance recommendations and minor formatting adjustments to spacing and warning blocks.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description is missing the required checklist and testing/changelog sections from the repository template, though it clearly summarizes the documentation changes made. Add the complete checklist from the contributing guide, include a Testing section describing validation steps, and flesh out the Changelog section with more detail about the changes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main documentation changes: adding NodeLocal DNS recommendations and ClickHouse task events configuration guidance to self-hosting guides.
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 docs/self-hosting-dns-and-clickhouse-events

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 12, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
trigger 🟢 Ready View Preview May 12, 2026, 10:19 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/self-hosting/kubernetes.mdx (1)

357-362: ⚡ Quick win

Add a concrete Helm snippet for ndots: 1 configuration.

This section explains what to change, but not how to apply it in this chart. Adding a short values.yaml example for webapp/supervisor pod dnsConfig.options would make the recommendation actionable.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/self-hosting/kubernetes.mdx` around lines 357 - 362, Add a concrete Helm
values example showing how to set ndots to 1 for the webapp and supervisor pods:
update the chart's values.yaml to include dnsConfig.options entries under the
webapp and supervisor keys (referencing webapp and supervisor and
dnsConfig.options) with an option name "ndots" and value "1", and mention that
this applies to the pods' spec.dnsConfig to lower ndots from 5 to 1; keep the
snippet minimal so readers can paste it into their values.yaml and deploy the
chart.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/self-hosting/kubernetes.mdx`:
- Around line 357-362: Add a concrete Helm values example showing how to set
ndots to 1 for the webapp and supervisor pods: update the chart's values.yaml to
include dnsConfig.options entries under the webapp and supervisor keys
(referencing webapp and supervisor and dnsConfig.options) with an option name
"ndots" and value "1", and mention that this applies to the pods' spec.dnsConfig
to lower ndots from 5 to 1; keep the snippet minimal so readers can paste it
into their values.yaml and deploy the chart.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 219fecd9-f520-4ae2-8c40-fbde86e90fd7

📥 Commits

Reviewing files that changed from the base of the PR and between 6b0e78f and 101afaf.

📒 Files selected for processing (3)
  • docs/self-hosting/docker.mdx
  • docs/self-hosting/env/webapp.mdx
  • docs/self-hosting/kubernetes.mdx
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Mintlify Deployment
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.mdx

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from @trigger.dev/sdk in code examples (never from @trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences: typescript, bash, json

Files:

  • docs/self-hosting/kubernetes.mdx
  • docs/self-hosting/env/webapp.mdx
  • docs/self-hosting/docker.mdx
🧠 Learnings (2)
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.

Applied to files:

  • docs/self-hosting/kubernetes.mdx
  • docs/self-hosting/env/webapp.mdx
  • docs/self-hosting/docker.mdx
📚 Learning: 2026-04-30T20:30:29.458Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3226
File: docs/ai-chat/quick-start.mdx:13-13
Timestamp: 2026-04-30T20:30:29.458Z
Learning: In this repo’s documentation MDX files (`docs/**/*.mdx`), use `ts` and `tsx` (not `typescript`) as the code-fence language tags for TypeScript/TSX snippets. Do not flag `ts`/`tsx` code-fence language tags as incorrect in any docs MDX file, since this is the site-wide Mintlify-compatible convention.

Applied to files:

  • docs/self-hosting/kubernetes.mdx
  • docs/self-hosting/env/webapp.mdx
  • docs/self-hosting/docker.mdx
🪛 LanguageTool
docs/self-hosting/kubernetes.mdx

[grammar] ~361-~361: Ensure spelling is correct
Context: ... hosts). Lowering ndots to 1 on the webapp and supervisor pods avoids those extra ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~367-~367: Ensure spelling is correct
Context: ...EVENT_REPOSITORY_DEFAULT_STORE on the webapp via extraEnvVars: ```yaml webapp: ...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

docs/self-hosting/docker.mdx

[grammar] ~349-~349: Ensure spelling is correct
Context: ...askEventtable. To enable, set on the webapp in your.env`: ```bash EVENT_REPOSITO...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

@isshaddad isshaddad marked this pull request as ready for review May 12, 2026 22:23
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 potential issue.

Open in Devin Review

Comment thread docs/self-hosting/env/webapp.mdx
@matt-aitken matt-aitken enabled auto-merge (squash) May 13, 2026 16:58
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