Skip to content

connect to vscode using a container #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 10, 2025
Merged

connect to vscode using a container #140

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe3637d
connect to vscode using a container
Jun 5, 2025
94d1a31
address review comments with better process clarification
Jun 5, 2025
b114f67
add info about the recent webinar with video/slide link of the setup …
Jun 5, 2025
fecf3f7
tweak formatting
bcumming Jun 10, 2025
2c08681
Merge branch 'main' into kanduri-patch-2
bcumming Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/access/vscode.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ There are two ways to set up the connection:
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.
Copy link
Member

@bcumming bcumming Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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&amp;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>


## Flexible method: remote server

The most flexible method for connecting VSCode is to log in to the Alps system, set up your environment (start a container or uenv, start a session on a compute node), and start the remote server in that environment pre-configured.
Expand Down Expand Up @@ -157,7 +159,9 @@ If you plan to do computation using your VSCode, then you should first allocate

### 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.
Copy link
Member

@bcumming bcumming Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the pedantry: https://docs.cscs.ch/contributing/#text-formatting


This will also use the Remote Tunnel extension and the VS Code connected to the GitHub account (see above).

#### TOML File with Image and Mount Paths

Expand Down