connect to vscode using a container #140
Conversation
|
preview available: https://docs.tds.cscs.ch/140 |
docs/access/vscode.md
Outdated
|
|
||
| ### Using with containers | ||
|
|
||
| This will use CSCS's custom **Container Engine** which can easily pull a container from a registry like DockerHub. Same setup process as earlier with GitHub. |
There was a problem hiding this comment.
| This will use CSCS's custom **Container Engine** which can easily pull a container from a registry like DockerHub. Same setup process as earlier with GitHub. | |
| This uses [Container Engine][ref-container-engine]. | |
| First, use the same setup process as earlier with GitHub. |
There was a problem hiding this comment.
Also "Same setup process as earlier with GitHub" is a bit vague.
Maybe something like "Note that this process also requires that you have a GitHub account, and that VS Code on your laptop has been connected to it (see above)."
docs/access/vscode.md
Outdated
| ``` | ||
| The `uname -m` command will print `aarch64` or `x86_64`, according to the microarchitecture of the node it is run on. | ||
|
|
||
There was a problem hiding this comment.
please remove whitespace that was introduced on these lines.
docs/access/vscode.md
Outdated
|
|
||
| start tunnel | ||
|
|
||
| cd /path/to/code/executable |
There was a problem hiding this comment.
It is implicit that the VS Code executable is either
- already in the container image
- in a path that has been mounted in the image
Can you add some information about how to do this?
|
preview available: https://docs.tds.cscs.ch/140 |
|
preview available: https://docs.tds.cscs.ch/140 |
1 similar comment
|
preview available: https://docs.tds.cscs.ch/140 |
docs/access/vscode.md
Outdated
| The main challenge with using VSCode is that the most convenient method for starting a remote session is to start a remote tunnel from the VS Code GUI. | ||
| This approach starts a session in the standard login environment on that node, however this won't work if you want to be developing in a container, in a uenv, or on a compute node. | ||
|
|
||
| This process is also demonstrated in a webinar on [Interactive computing on "Alps"](https://www.cscs.ch/publications/tutorials/2025/video-of-the-webinar-interactive-computing-on-alps). Video and slides accessible. |
There was a problem hiding this comment.
How about directly embedding the video, at the time stamp where VS Code is discussed?
Here is an example of embedding a video:
https://docs.cscs.ch/storage/longterm/#further-documentation
I think it should be enough to embed this:
<iframe width="100%"
height="315"
src="https://www.youtube.com/embed/cLVpJO_fE6I?si=bTmmsS_9QvTHpUqK&start=2257"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerpolicy="strict-origin-when-cross-origin"
allowfullscreen>
</iframe>
docs/access/vscode.md
Outdated
| ### Using with containers | ||
|
|
||
| This will use CSCS's **[Container Engine][ref-container-engine]**. Using this workflow, one can pull a container from a registry like DockerHub. Note that this process also requires that you have a GitHub account, with an authentication and authorization step as described earlier. | ||
| This will use CSCS's **[Container Engine][ref-container-engine]**. Using this workflow, one can pull a container from a registry like DockerHub. Note that this process also requires that you have a GitHub account, with an authentication and authorization step as described earlier. |
There was a problem hiding this comment.
Sorry for the pedantry: https://docs.cscs.ch/contributing/#text-formatting
|
preview available: https://docs.tds.cscs.ch/140 |
|
preview available: https://docs.tds.cscs.ch/140 |
Added a small section to help users connect to VS code with a container image using CSCS's container engine (CE)