Skip to content

Commit 5477a0a

Browse files
authored
Revise Docker image build instructions for RCP
Updated instructions for building Docker images for RCP, including clarifications on project creation and user ID retrieval.
1 parent 3a66189 commit 5477a0a

1 file changed

Lines changed: 20 additions & 12 deletions

File tree

docs/clusters/rcp/rcp_docker.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# (Optional) Building Docker image for the RCP
1+
# Building Docker image for the RCP
22

33

44
To build a Docker image for the RCP, we will use the [LiGHT cluster template](https://github.com/EPFLiGHT/LiGHT-cluster-template).
@@ -31,13 +31,11 @@ This folder contains a `template.sh` file which contains all the available funct
3131

3232
### Creating a project on the EPFL registry (Optional)
3333

34-
EPFL has a registry of docker images which works in a similar way to the Docker hub. This registry is used to store docker images and is only accessible through the [EPFL VPN](https://www.epfl.ch/campus/services/ressources-informatiques/network-services-reseau/acces-intranet-a-distance/clients-vpn-disponibles/).
34+
EPFL has a registry of docker images which works in a similar way to the Docker hub. This registry is used to store docker images and is only accessible through the EPFL network (you may use the [EPFL VPN](https://www.epfl.ch/campus/services/ressources-informatiques/network-services-reseau/acces-intranet-a-distance/clients-vpn-disponibles/)).
3535

36-
Connect to registry.rcp.epfl.ch with the VPN. To push new docker images, you need to create a Project. At the time of this tutorial, some projects have already been created like [multimeditron](https://registry.rcp.epfl.ch/harbor/projects/316/members/summary) and you can ask Michael to add you to the project so that you can also push Docker images to this project.
36+
Connect to [registry.rcp.epfl.ch](https://registry.rcp.epfl.ch) with the VPN. To push new docker images, you need to create a project, by clicking on "New project".
3737

38-
You also have the possibility of creating your own project by clicking on "New project".
39-
40-
__IMPORTANT__: Beware that if you choose to create your own project, you will have to change the link of the docker images in the scripts accordingly (mainly replacing multimeditron/basic by the right path)
38+
__IMPORTANT__: Beware that you will have to change the link of the docker images in the scripts according to the actual path of your project (mainly replacing multimeditron/basic by the right path).
4139

4240
### Generating the .env file
4341

@@ -94,15 +92,15 @@ IMAGE_PLATFORM=amd64-cuda
9492
# You can also add a suffix to the platform e.g. -jax or -pytorch if you use different images for different environments/models etc.
9593
```
9694

97-
Edit this file by setting `LAB_NAME` to the name of the project you have given in the previous step (multimeditron if you choose to push your docker images there).
95+
Edit this file by setting `LAB_NAME` to the name of the project you have given in the previous step, and USR and PASSWD accordingly.
9896
Set the `PROJECT_NAME` to a meaningful name to group the docker images that belong to the same project. Here we will choose to set it up to `basic`. Docker images with the same `PROJECT_NAME` will appear together in the `registry.rcp.epfl.ch` interface.
9997

10098
We also change the `IMAGE_NAME` to another template for organization purpose.
10199

102100
Edit the corresponding lines to the following lines:
103101

104102
```
105-
LAB_NAME=multimeditron # Or the name you have chosen
103+
LAB_NAME=multimeditron # Replace it with the name of your project
106104
PROJECT_NAME=basic # Optional: Change this to a more meaningful name (e.g. vllm or axolotl for instance)
107105
IMAGE_NAME=${LAB_NAME}/${PROJECT_NAME}
108106
```
@@ -131,17 +129,27 @@ Useful commands:
131129

132130
### Building the user docker images
133131

134-
Connect to people.epfl.ch and search for the user you want to build an image. You need the `Username` and the `UID` fields to build the user docker image
132+
Find your user id:
133+
134+
```sh
135+
ssh $GASPAR@haas001.rcp.epfl.ch
136+
```
137+
138+
Then use your EPFL password to log in, then find your UID by checking at the beginning of the output of this command:
139+
140+
```sh
141+
id $GASPAR
142+
```
135143

136-
Connect to groups.epfl.ch and search for light-scratch in "All groups". You need the `GID` field.
144+
Connect to [groups.epfl.ch](https://groups.epfl.ch), "Groups I'm member of" and search for light-scratch. You need the `GID` field.
137145

138146
To build user docker images, you need to edit the `.env` file. You need to change the following attributes:
139147

140148
```
141149
GRPID=<GID of the light-scratch>
142150
143151
USRID=<UID of the user>
144-
USR=<Username of the user>
152+
USR=<Username of the user, the GASPAR>
145153
PASSWD=<Username of the user>
146154
```
147155

@@ -160,7 +168,7 @@ Login to the registry:
160168
docker login
161169
```
162170

163-
The login informations are your EPFL login
171+
The login informations are your EPFL credentials
164172

165173
```
166174
./template.sh push_generic RCP

0 commit comments

Comments
 (0)