From 8bc9c2b8ceed15e76631a6ecd2031be73ff711e4 Mon Sep 17 00:00:00 2001 From: Hans-Nikolai Viessmann Date: Thu, 30 Jul 2026 13:32:12 +0200 Subject: [PATCH] add vscode and agentic connection docs, first go --- .../agentic-tools-bridges.md | 27 +++++++++++++++++++ .../connecting-with-vscode-remote.md | 22 +++++++++++++++ mkdocs.yml | 3 +++ 3 files changed, 52 insertions(+) create mode 100644 docs/merlin7/02-connecting-to-merlin/agentic-tools-bridges.md create mode 100644 docs/merlin7/02-connecting-to-merlin/connecting-with-vscode-remote.md diff --git a/docs/merlin7/02-connecting-to-merlin/agentic-tools-bridges.md b/docs/merlin7/02-connecting-to-merlin/agentic-tools-bridges.md new file mode 100644 index 0000000..677257f --- /dev/null +++ b/docs/merlin7/02-connecting-to-merlin/agentic-tools-bridges.md @@ -0,0 +1,27 @@ +# Agentic Tools and Bridges + +!!! note + We're still investigate the impact of using AI agents and similar services + on the Merlin cluster. The following documentation can change at any time. + Please keep an eye on are [news posts](../../news/index.md) or check out + out [mailing lists](../../support/introduction.md) to keep up-to-date + with latest developments in this space. + +!!! danger "BEWARE" + You **MUST NOT DISCLOSE OR UPLOAD** data that is no explicitly for public + use. AI tools can not distinguish between private and public data, that is + **YOUR RESPONSIBILITY**. + +AI tools and services are proliferating rapidly, and are becoming easier to +use. Tools like ClaudeCode and CoPilot provide a nice way of orchestrating +agentic tasks and possibly automatic certain actions and operations. We know +that some users are interested in using these on a regular basis, and might +possibly integrate them into their workflows. + +Please have a look at some of the guidelines from PSI: + +- AIT CoPilot Guide: , please take + note of the data security concerns. **You must not disclose any data or other + PSI documentation unless it is explicit marks as 'public'!** +- PSI AI Initiative (RAG chatbot) documentation: + diff --git a/docs/merlin7/02-connecting-to-merlin/connecting-with-vscode-remote.md b/docs/merlin7/02-connecting-to-merlin/connecting-with-vscode-remote.md new file mode 100644 index 0000000..980e03c --- /dev/null +++ b/docs/merlin7/02-connecting-to-merlin/connecting-with-vscode-remote.md @@ -0,0 +1,22 @@ +# Visual Studio Code Remote + +The Visual Studio Code editor supports ["remote +development"](https://code.visualstudio.com/docs/remote/remote-overview) over +SSH. This lets users develop and run code on remote systems through their +local installation of VSCode. The "remote" extension will connect to the remote +machine over SSH and will install and use the VSCode Server service. This +service runs in the background and keeps the session alive and responsive. It +will also perform various other tasks, not limited to checking out projects, +updating search and code indices, and running user issued remote commands (over +the terminal in VSCode). + +Using VSCode Remote is very useful but it can cause issues on remote systems +that are shared by multiple users, like the login nodes. Per the [VSCode +documentation](../07-software-support/vscode.md) we **strongly** ask that **you +do not connect to the login nodes using VSCode remote** and instead use an +[interactive SLURM +session](../07-software-support/vscode.md#vs-code-via-interactive-sessions). + +Additionally we provide some +[Tips](../07-software-support/vscode.md#tips-and-other-suggestions) on +improving performance and preventing issues to the cluster. diff --git a/mkdocs.yml b/mkdocs.yml index 67a1cab..ade48fc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -125,6 +125,9 @@ nav: - merlin7/02-connecting-to-merlin/connect-from-macos.md - SSH Key-pairs: merlin7/02-connecting-to-merlin/ssh-keys.md - Remote Desktop: merlin7/02-connecting-to-merlin/nomachine.md + - Other Clients: + - merlin7/02-connecting-to-merlin/connecting-with-vscode-remote.md + - merlin7/02-connecting-to-merlin/agentic-tools-bridges.md - How To Use Merlin7: - merlin7/03-how-to-use-merlin/storage.md - merlin7/03-how-to-use-merlin/transfer-data.md