Skip to content

docs: attached-executor deployment guide - #603

Merged
kartikeya-27 merged 4 commits into
ByteVeda:masterfrom
stromanni:docs/589-attached-executors
Aug 2, 2026
Merged

docs: attached-executor deployment guide#603
kartikeya-27 merged 4 commits into
ByteVeda:masterfrom
stromanni:docs/589-attached-executors

Conversation

@stromanni

@stromanni stromanni commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Two independent docs changes.

The attached-executor deployment guide

docs/content/docs/shared/guides/operations/executor.mdx, fanned out to Python, Node and Java and added to each SDK's operations nav. Covers the topology, the server-side environment, taskito executor per SDK, the security defaults, what a task can and cannot do on an executor, capability negotiation, and the trade-offs.

This is the operator-facing half of #589 — the SDK work landed in #599, #600 and #601.

One ordering note. The Java tab shows JobContext.current(), which is added by #602 and is not on master yet. Everything else on the page is live today. Merge after #602 if you want the page accurate on landing; merge before and the Java tab documents an API that is one PR away.

Landing-page SDK naming

The site still described itself as a queue for two SDKs, which stopped being true when Java shipped:

Where Was Now
Footer "Rust-powered, brokerless task queue for Python and Node.js. No Redis, no RabbitMQ." "A Rust-powered task queue with native SDKs. One engine, no broker required — just SQLite, Postgres, or Redis."
CTA "…watching the worker run it — in Python or Node" "…in the SDK you already use"
Architecture lead "Your Python or Node code enqueues a job" "Your application code enqueues a job … whichever SDK you called it from"
Feature card "One core, two SDKs" / PyO3 and napi-rs "One core, native SDKs" / PyO3, napi-rs and JNI

The CTA's install row also gained org.byteveda:taskito alongside the pip and pnpm pills, so the copy and the commands agree.

The page's <meta name="description"> already named all three, so it is unchanged.

Verification

pnpm typecheck, pnpm lint, pnpm check:parity and pnpm build are clean. The executor guide renders under all three SDKs (build/client/{python,node,java}/guides/operations/executor/index.html), and the new landing copy and the third install pill were checked in the built HTML.

Note for whoever runs this locally: pnpm build needs NODE_OPTIONS=--max-old-space-size=8192 or it OOMs on the default heap. Pre-existing, and what CI already sets.

Refs #589.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guidance for configuring and deploying attached executors, including environment setup, security, SDK commands, middleware, compatibility, and limitations.
    • Added executor documentation links to the Python, Node.js, and Java operations guides.
    • Updated landing-page messaging to highlight Rust-powered infrastructure, native Python, Node.js, and Java SDKs, flexible storage options, and SDK-agnostic job execution.
    • Added Maven installation instructions alongside existing package-manager options.

@github-actions github-actions Bot added the docs label Aug 2, 2026
@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@stromanni, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 44 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: a9c402df-45ad-4c72-9c23-27ea476cb99a

📥 Commits

Reviewing files that changed from the base of the PR and between e8056c0 and c4332d2.

📒 Files selected for processing (2)
  • docs/app/components/landing/sections.tsx
  • docs/content/docs/shared/guides/operations/executor.mdx
📝 Walkthrough

Walkthrough

The landing page now presents Taskito as Rust-powered with native Python, Node.js, and Java SDKs. Operations navigation now links to a new attached executors guide covering setup, security, reporting, limitations, compatibility, and deployment.

Changes

Documentation updates

Layer / File(s) Summary
Multi-language landing messaging
docs/app/components/landing/footer.tsx, docs/app/components/landing/sections.tsx, docs/app/lib/landing-content.ts
Landing copy now describes SDK-agnostic execution, Java support, native SDKs, JNI, Maven installation, and SQLite, Postgres, and Redis support.
Attached executor operations guide
docs/content/docs/shared/guides/operations/executor.mdx, docs/content/docs/*/guides/operations/meta.json
Added the attached executors guide and linked it from Java, Node, and Python Operations navigation.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

Possibly related PRs

  • ByteVeda/taskito#294 — Related landing and documentation updates for the Rust core and multi-language SDKs.
  • ByteVeda/taskito#345 — Introduces Java executor and autoscaling functionality covered by the new guide.
  • ByteVeda/taskito#595 — Implements executor subcommands and SDK attachment functionality documented here.

Suggested labels: deployment, python, node, java

Suggested reviewers: pratyush618

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the primary change: adding an attached-executor deployment guide.

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.

@coderabbitai coderabbitai Bot 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.

Actionable comments posted: 3

🤖 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.

Inline comments:
In `@docs/app/components/landing/sections.tsx`:
- Around line 409-415: Update the Java InstallPill entry alongside the existing
Python and pnpm commands to use a copyable Maven or Gradle dependency snippet,
or a valid versioned Maven install command, instead of the bare
org.byteveda:taskito coordinate; keep it compatible with InstallPill’s
shell-command rendering and copying behavior.

In `@docs/content/docs/shared/guides/operations/executor.mdx`:
- Around line 91-102: Update the Security guidance for non-loopback
TASKITO_LISTEN endpoints to require mTLS or an explicitly trusted encrypted
network, and document the supported configuration. Remove or qualify any wording
that presents token-only TCP as a strict security default, while preserving
token authentication and the Unix-socket guidance.
- Around line 31-40: Update the “Running the scheduler” documentation to replace
the unsupported `taskito executor ...` command examples with the published
executor entry points exposed by the Python, Node, and Java SDKs:
`Executor(...)`, `start_executor(...)`, and `Cli.executor`. Keep the existing
scheduler environment configuration unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 60b54c4a-6fe2-48c8-a609-612f76775292

📥 Commits

Reviewing files that changed from the base of the PR and between 99847e2 and e8056c0.

📒 Files selected for processing (7)
  • docs/app/components/landing/footer.tsx
  • docs/app/components/landing/sections.tsx
  • docs/app/lib/landing-content.ts
  • docs/content/docs/java/guides/operations/meta.json
  • docs/content/docs/node/guides/operations/meta.json
  • docs/content/docs/python/guides/operations/meta.json
  • docs/content/docs/shared/guides/operations/executor.mdx
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • ByteVeda/taskito (manual)

Comment thread docs/app/components/landing/sections.tsx Outdated
Comment thread docs/content/docs/shared/guides/operations/executor.mdx
Comment thread docs/content/docs/shared/guides/operations/executor.mdx
@kartikeya-27 kartikeya-27 changed the title docs: attached-executor deployment guide, and stop naming only two SDKs docs: attached-executor deployment guide Aug 2, 2026
@kartikeya-27
kartikeya-27 merged commit 34f9661 into ByteVeda:master Aug 2, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants