Skip to content

Commit 746c1c2

Browse files
committed
add notes for sudoless docker
1 parent b296e38 commit 746c1c2

4 files changed

Lines changed: 12 additions & 3 deletions

File tree

docs/run_maxtext/run_maxtext_via_pathways.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ Before you can run a MaxText workload, you must complete the following setup ste
3737

3838
3. **Build and upload a MaxText Docker image** to your project's Artifact Registry.
3939

40+
[Follow the steps to configure sudoless Docker](https://docs.docker.com/engine/install/linux-postinstall/) before running the commands below.
41+
4042
Step 1: Build the Docker image for a TPU device. This image contains MaxText and its dependencies.
4143

4244
```shell

docs/run_maxtext/run_maxtext_via_xpk.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Before you begin, you must have the necessary tools installed and permissions co
5151

5252
- **kubectl:** The Kubernetes command-line tool.
5353

54-
- **Docker:** Follow the [installation instructions](https://docs.docker.com/engine/install/) and complete the [post-install steps](https://docs.docker.com/engine/install/linux-postinstall/) to run Docker without `sudo`.
54+
- **Docker:** Follow the [installation instructions](https://docs.docker.com/engine/install/) and [follow the steps to configure sudoless Docker](https://docs.docker.com/engine/install/linux-postinstall/).
5555

5656
### GCP permissions
5757

@@ -118,6 +118,10 @@ ______________________________________________________________________
118118

119119
## 4. Build the MaxText Docker image
120120

121+
```{note}
122+
Ensure Docker is configured for sudoless use before running the build script. Follow the steps to [configure sudoless Docker](https://docs.docker.com/engine/install/linux-postinstall/).
123+
```
124+
121125
1. **Clone the MaxText repository**
122126

123127
```

docs/tutorials/posttraining/rl_on_multi_host.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Before starting, ensure you have:
6060
- Permissions for Google Artifact Registry (Artifact Registry Writer role).
6161
- XPK installed (follow [official documentation](https://github.com/AI-Hypercomputer/xpk/blob/main/docs/installation.md)).
6262
- A Pathways-ready GKE cluster (see [create GKE cluster](https://docs.cloud.google.com/ai-hypercomputer/docs/workloads/pathways-on-cloud/create-gke-cluster)).
63+
- **Docker** installed and configured for sudoless use. Follow the steps to [configure sudoless Docker](https://docs.docker.com/engine/install/linux-postinstall/).
6364

6465
## Setup Environment Variables
6566

@@ -106,7 +107,9 @@ export MAXTEXT_CKPT_PATH=<gcs path for MaxText checkpoint> # e.g., gs://my-bucke
106107

107108
## Build and upload MaxText Docker image with post-training dependencies
108109

109-
Before building the Docker image, authenticate to
110+
Before building the Docker image, follow the steps to [configure sudoless Docker](https://docs.docker.com/engine/install/linux-postinstall/).
111+
112+
Then, authenticate to
110113
[Google Artifact Registry](https://docs.cloud.google.com/artifact-registry/docs/docker/authentication#gcloud-helper)
111114
for permission to push your images and other access.
112115

docs/tutorials/posttraining/sft_on_multi_host.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ cd maxtext
3737

3838
### 1.2. Build MaxText Docker image
3939

40-
Before building the Docker image, authenticate to [Google Artifact Registry](https://docs.cloud.google.com/artifact-registry/docs/docker/authentication#gcloud-helper) for permission to push your images and other access.
40+
Before building the Docker image, follow the steps to [configure sudoless Docker](https://docs.docker.com/engine/install/linux-postinstall/). Then, authenticate to [Google Artifact Registry](https://docs.cloud.google.com/artifact-registry/docs/docker/authentication#gcloud-helper) for permission to push your images and other access.
4141

4242
```bash
4343
# Authenticate your user account for gcloud CLI access

0 commit comments

Comments
 (0)