Skip to content

Docs migration from XPK to CTK(4/5) - #5187

Draft
KevinYenky wants to merge 14 commits into
AI-Hypercomputer:mainfrom
KevinYenky:docs/ctk-migration-checkpointing
Draft

KevinYenky wants to merge 14 commits into
AI-Hypercomputer:mainfrom
KevinYenky:docs/ctk-migration-checkpointing

Conversation

@KevinYenky

Copy link
Copy Markdown

Description

This PR is the fourth part of decomposing the XPK to Cluster Toolkit document migration. It focuses on updating our documentation regarding Checkpointing Solutions to use Cluster Toolkit (CTK) instead of the deprecated XPK launcher.

Specifically, this PR updates the following guides:

  • Multi-Tier Checkpointing: Replaces XPK-specific deployment and recovery commands with their gcluster equivalents, updating environment variables and volume mount instructions as necessary.
  • Emergency Checkpointing: Updates the workflow and script references for handling emergency saves and preemptions to align with CTK's job lifecycle management.

Why this is being made:
CTK is replacing XPK as the primary submission mechanism for Google Kubernetes Engine (GKE) workloads. Breaking down the massive PR #5175 into smaller, logical chunks makes the migration significantly easier to review and test.

Tests

Tested by scripts that run the gcluster commands provided in the documents, with results stored in a GCS bucket.

Checklist

  • I have performed a self-review of my code. For an optional AI review, add the gemini-review label.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed, including adding new documentation pages to the relevant Table of Contents.

@google-cla

google-cla Bot commented Sep 10, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the documentation for emergency and multi-tier checkpointing to transition from XPK-based instructions to Cluster Toolkit (gcluster) workflows. It includes detailed steps for configuring GKE clusters, setting up Cloud Storage buckets with Hierarchical Namespace (HNS), granting necessary IAM permissions, and submitting workloads. The review comments correctly identify that the documented commands for setting gcluster configuration defaults are incorrect and should be updated from gcluster job config set to gcluster config set to prevent command execution errors.

Comment thread docs/guides/checkpointing_solutions/emergency_checkpointing.md
Comment thread docs/guides/checkpointing_solutions/multi_tier_checkpointing.md
KevinYenky and others added 5 commits September 10, 2026 16:30
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@KevinYenky KevinYenky mentioned this pull request Sep 10, 2026
4 tasks
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