Docs migration from XPK to CTK(1/5) - #5177
Conversation
|
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[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the MaxText documentation to transition from XPK to Cluster Toolkit (gcluster) as the recommended workflow for deploying and running workloads on Google Kubernetes Engine (GKE). The feedback suggests using the more generic --location flag instead of --zone for GKE cluster credentials to support regional clusters, and removing explicit configuration file paths (e.g., src/maxtext/configs/base.yml) from training commands since MaxText automatically infers configurations and these paths will fail in PyPI-based installations.
|
|
||
| ## Cluster Toolkit replacement | ||
|
|
||
| For new deployments, configure GKE access and submit the equivalent standard |
There was a problem hiding this comment.
Instead of putting the instructions here, can we just link to Cluster toolkit's instruction.
There was a problem hiding this comment.
Done replacing it with the link, thanks
|
@KevinYenky - can you please sign the CLA to unblock the CI? |
| @@ -84,7 +84,7 @@ First, ensure your local `kubectl` is authenticated with your target GKE cluster | |||
|
|
|||
| ```bash | |||
| gcloud container clusters get-credentials <GKE_CLUSTER_NAME> \ | |||
There was a problem hiding this comment.
Modify this command so that the command is editable:
gcloud container clusters get-credentials <CLUSTER_NAME> \
--location <ZONE> \
--project <PROJECT_ID>
Reference: https://github.com/AI-Hypercomputer/maxtext/blob/main/docs/_static/js/editable_commands.js
| @@ -53,19 +53,13 @@ export ZONE=<GCP location> # e.g., 'us-central1' | |||
| export GKE_CLUSTER=<cluster name> | |||
There was a problem hiding this comment.
Can you also make all these variables editable as mentioned in the above comment?
Added Kevin to the CLA group. |
4 participants
Description
This PR is the first part of decomposing XPK to Cluster Toolkit Migration. It initiates the transition of our documentation from the deprecated XPK launcher to Cluster Toolkit (CTK).
Specifically, this PR updates the core getting started and post-training guides:
xpk workload createandxpk workload create-pathwayscommands with theirgcluster job submitequivalents for SFT, LoRA, and Distillation workflows.XPK_CLUSTERtoGKE_CLUSTER).gcluster job list,gcluster job logs, etc.).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 (starting with these core guides) makes the migration significantly easier to review and test.
Tests
tested by scripts that run the gcluster command provided in the documents, results stored in gcs bucket.
Checklist
gemini-reviewlabel.