Skip to content

docs: add JobSet intro, install, and quickstart#213

Open
luohua13 wants to merge 2 commits into
masterfrom
jcwang/add-jobset-doc
Open

docs: add JobSet intro, install, and quickstart#213
luohua13 wants to merge 2 commits into
masterfrom
jcwang/add-jobset-doc

Conversation

@luohua13
Copy link
Copy Markdown
Contributor

@luohua13 luohua13 commented May 13, 2026

Summary

  • Add docs/en/jobset/ with index.mdx, intro.mdx, install.mdx, and quickstart.mdx.
  • Introduction covers JobSet (kubernetes-sigs/jobset) — what it is and the main features: multi-template Jobs, headless Service + stable hostnames, success/failure policies, startup sequencing, exclusive topology placement, fast recovery, Kueue integration.
  • Installation follows the existing Operator Hub flow (matching feast / llama_stack): upload the operator package with violet, install Alauda Build of JobSet from Marketplace / Operator Hub, controller runs in jobset-system, verify via the controller pod and the jobsets.jobset.x-k8s.io CRD.
  • Quickstart runs a minimal two-group (leader + workers) JobSet to confirm the operator works end-to-end and to introduce the most common CR fields.

Test plan

  • yarn lint (or doom lint) passes locally.
  • Local doom preview renders the new JobSet section in navigation.
  • Verify the quickstart manifest on a real cluster: controller in jobset-system, JobSet reports Completed, child Jobs reach 1/1 and 4/4.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive JobSet docs: overview, introduction, installation guide for Alauda Container Platform, and a quickstart tutorial with an example demo manifest and verification steps.
    • Documents JobSet capabilities (CRD, multi-template jobs, headless services, policies, sequencing, placement, recovery, Kueue integration) and links to next-step concepts and resources.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: bd89e3f8-7a71-47e4-995e-0d3becf46ab6

📥 Commits

Reviewing files that changed from the base of the PR and between 785da85 and 3a2c366.

📒 Files selected for processing (2)
  • docs/en/jobset/install.mdx
  • docs/en/jobset/intro.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/en/jobset/install.mdx
  • docs/en/jobset/intro.mdx

Walkthrough

This PR introduces a complete JobSet documentation suite for Alauda Container Platform. Four new MDX documentation pages are added covering feature overview, installation procedures, and a practical quickstart guide to help users understand and deploy JobSet.

Changes

JobSet User Documentation

Layer / File(s) Summary
Index and Feature Overview
docs/en/jobset/index.mdx, docs/en/jobset/intro.mdx
Index page with weight: 101 and an <Overview /> include; introduction describes JobSet as a Kubernetes-native API and lists key capabilities: multi-template jobs, headless services with stable hostnames, failure and success policies, startup sequencing, exclusive topology placement, fast failure recovery, and Kueue integration.
Installation Guide
docs/en/jobset/install.mdx
Step-by-step instructions for deploying the JobSet Operator on Alauda Container Platform via Operator Hub, including uploading the operator package with violet push, installing into the jobset-system namespace, creating and applying a JobSetOperatorCtl manifest to deploy the controller/webhook, verifying the jobset-operator pod, and confirming the jobsets.jobset.x-k8s.io CRD is registered.
Quickstart Walkthrough
docs/en/jobset/quickstart.mdx
Hands-on guide with a minimal JobSet manifest example, demonstrating prerequisite checks, CR field explanations, resource deployment, inspection of created objects (JobSet, child Jobs, pods, headless Service), status verification via .status.conditions, and cleanup procedures, with links to advanced topics.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through docs so bright,
JobSet's path is now in sight,
From index down to quickstart flow,
Four pages help the knowledge grow! 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding JobSet documentation (intro, install, and quickstart pages).
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 jcwang/add-jobset-doc

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.

Copy link
Copy Markdown

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

Actionable comments posted: 1

🤖 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/en/jobset/intro.mdx`:
- Line 20: Reword the "Fast Failure Recovery" line so it does not imply JobSet
performs automatic checkpoint restoration: change the sentence that currently
reads "On failure, JobSet recreates the child Jobs to resume from the last
checkpoint" to make clear JobSet only recreates Jobs and that checkpointing and
state restoration are the responsibility of the workload; reference the "Fast
Failure Recovery" heading and the sentence about recreating child Jobs when
updating the docs text to say something like "On failure, JobSet recreates the
child Jobs, allowing workloads that implement checkpointing to resume from their
last checkpoint" so the workload responsibility is explicit.
🪄 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

Run ID: 6fd63a68-a934-47a9-a990-a41466053205

📥 Commits

Reviewing files that changed from the base of the PR and between 3f3c1ae and 785da85.

📒 Files selected for processing (4)
  • docs/en/jobset/index.mdx
  • docs/en/jobset/install.mdx
  • docs/en/jobset/intro.mdx
  • docs/en/jobset/quickstart.mdx

Comment thread docs/en/jobset/intro.mdx Outdated
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 13, 2026

Deploying alauda-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: 3a2c366
Status: ✅  Deploy successful!
Preview URL: https://f53666ba.alauda-ai.pages.dev
Branch Preview URL: https://jcwang-add-jobset-doc.alauda-ai.pages.dev

View logs

intro.mdx: reword "Fast Failure Recovery" so it doesn't imply JobSet itself
restores application state — the workload owns checkpointing; JobSet only
recreates child Jobs. Addresses CodeRabbit review on PR #213.

install.mdx:
- update verify-step pod name from the stale `jobset-controller-manager-…`
  to `jobset-operator-…`, matching the OperatorBundle rename that
  collapses operator-sdk's namePrefix'd controller-manager names down to
  the bare `jobset-operator` SA / Deployment / ClusterRole.
- add the missing `JobSetOperatorCtl` instance step. JobSet ships as a
  helm-based operator: installing the bundle alone only deploys the
  operator reconciler; the JobSet controller and webhook are only
  created once a `JobSetOperatorCtl` resource exists. Without this step
  users see "no JobSet controller pod" after install and a confusing
  CRD-but-no-controller state.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.

1 participant