Skip to content

Commit 8ba56c9

Browse files
update ubuntu manual + observable (#129)
* include ubuntu manual * Update docs/manuals/data-transfer-options.qmd * Update docs/workspaces/plain/ubuntu.qmd * Update docs/workspaces/plain/ubuntu.qmd --------- Co-authored-by: Jelle Treep <40466121+jelletreep@users.noreply.github.com>
1 parent 8cbf593 commit 8ba56c9

2 files changed

Lines changed: 68 additions & 5 deletions

File tree

docs/manuals/data-transfer-options.qmd

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ html`
4343
4444
// Input: Workspace type
4545
viewof workspaceType = Inputs.select(
46-
["Python Workbench (Desktop)", "Python Workbench (CLI)", "Jupyter Notebook", "VRE Lab", "Windows"],
46+
["Python Workbench (Desktop)", "Python Workbench (CLI)", "Jupyter Notebook", "VRE Lab", "Ubuntu (Desktop)", "Ubuntu (CLI)", "Windows"],
4747
{label: "What workspace are you using?", value: "Python Workbench (Desktop)", width: "auto"}
4848
)
4949
@@ -66,12 +66,14 @@ viewof skillLevel = Inputs.radio(
6666
)
6767
6868
// Helper to check workspace type
69-
isDesktop = workspaceType === "Python Workbench (Desktop)" || workspaceType === "Windows"
69+
isDesktop = workspaceType === "Python Workbench (Desktop)" || workspaceType === "Windows" || workspaceType === "Ubuntu (Desktop)"
7070
isPythonDesktop = workspaceType === "Python Workbench (Desktop)"
7171
isPythonCLI = workspaceType === "Python Workbench (CLI)"
7272
isJupyter = workspaceType === "Jupyter Notebook"
7373
isVRELab = workspaceType === "VRE Lab"
7474
isWindows = workspaceType === "Windows"
75+
isUbuntuDesktop = workspaceType === "Ubuntu (Desktop)"
76+
isUbuntuCLI = workspaceType === "Ubuntu (Server/CLI)"
7577
7678
// Get all applicable tools based on selections
7779
allOptions = {
@@ -83,6 +85,8 @@ allOptions = {
8385
if (isDesktop) {
8486
let ibridgesNote = isWindows ?
8587
'Pre-installed on "Windows with iBridges" flavor' :
88+
(isUbuntuDesktop || isUbuntuCLI) ?
89+
'iBridges needs to be installed' :
8690
'Pre-installed';
8791
8892
options.push({
@@ -100,7 +104,7 @@ allOptions = {
100104
tool: "iBridges CLI",
101105
link: "ibridges.html",
102106
skillLevel: "Intermediate (CLI)",
103-
pros: ["Pre-installed", "Works on all workspaces", "Supports all file sizes"],
107+
pros: ["Pre-installed on most workspaces", "Works on all workspaces", "Supports all file sizes"],
104108
cons: ["Requires command line knowledge"],
105109
bestFor: ["Users with CLI experience", "All file sizes"]
106110
});

docs/workspaces/plain/ubuntu.qmd

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ login:
77
- cli
88
os_flavor: linux
99
os:
10-
- Ubuntu 20.04
1110
- Ubuntu 22.04
11+
- Ubuntu 24.04
1212
data:
1313
- ResearchDrive
1414
- irods-icommands
@@ -19,11 +19,27 @@ packages:
1919
gpu: true
2020
admin: true
2121
support: SURF
22-
workspace_cuda: Ubuntu 2204 with CUDA
22+
workspace_cuda: Ubuntu 22.04 with CUDA/Ubuntu Desktop 22.04 CUDA
2323
---
2424

2525
## Description
2626

27+
Surf Research Cloud allows you to use Ubuntu workspaces with various configurations:
28+
29+
**Command-line interface:**
30+
31+
- Ubuntu 22.04 - SUDO enabled
32+
- Ubuntu 24.04 - SUDO enabled
33+
- Ubuntu 22.04 with CUDA (GPU support)
34+
35+
**Desktop (Graphical interface):**
36+
37+
- Ubuntu Desktop 22.04
38+
- Ubuntu Desktop 24.04
39+
- Ubuntu Desktop 22.04 CUDA (GPU support)
40+
41+
Simply choose one of these [catalog items](../../glossary.qmd#catalog-item) in the workspace creation wizard.
42+
2743
{{< include ../partials/_cuda.qmd >}}
2844

2945

@@ -33,9 +49,52 @@ workspace_cuda: Ubuntu 2204 with CUDA
3349

3450
## Access
3551

52+
**Command Line only workspaces:** Access via [SSH](../../first-steps.qmd#ssh). By clicking the yellow Access button for the workspace in the dashboard of SURF Research Cloud, you will be prompted to open a command line interface on your local pc/laptop to connect to your workspace via SSH. If you already have an ssh key pair set up, type `yes` to trust the workspace and you will be connected to your SURF Ubuntu workspace.
53+
54+
To set up an ssh key pair for the first time, see the [setting up SSH access manual](https://servicedesk.surf.nl/wiki/spaces/WIKI/pages/195854434/Workspace+access+with+SSH).
55+
56+
**Desktop workspaces:** You can [access Ubuntu Desktop workspaces as a remote desktop in your browser](../../first-steps.qmd#browser-access-to-a-desktop-environment), authenticating via Single-Sign On with your institutional login details.
57+
3658
## Data transfer options
3759

60+
Use this table to find the appropriate data transfer method for your situation:
61+
62+
| Data Source | Recommended Tool | Best For | Skill Level |
63+
|------------|------------------|----------|-------------|
64+
| Yoda/iRODS | [iBridges](../../manuals/ibridges.qmd) | All file sizes, GUI (Desktop) and CLI access | Beginner to Intermediate |
65+
| Yoda/iRODS | [iCommands](../../manuals/icommands.qmd) | Large datasets, transfer automation, CLI | Intermediate (CLI) |
66+
| SURFdrive, ResearchDrive| [rclone](../../manuals/rclone-researchcloud.qmd) | Cloud storage sync, scheduled transfers | Intermediate (CLI) |
67+
| Your PC/laptop | [scp](../../manuals/ssh-data-transfer-methods.qmd) | Direct one-time transfers | Intermediate (CLI) |
68+
| Your PC/laptop | [rsync](../../manuals/ssh-data-transfer-methods.qmd) | Sync or repeated transfers | Intermediate (CLI) |
69+
| Your PC/laptop (Windows only) | [MobaXterm](https://mobaxterm.mobatek.net/) | Graphical SSH/SFTP client | Intermediate |
70+
| Your PC/laptop | [Cyberduck](https://servicedesk.surf.nl/wiki/spaces/WIKI/pages/112592488/Upload+data+to+a+workspace+with+Cyberduck)| Graphical SFTP client | Intermediate |
71+
| GitHub/GitLab | [git clone](../../manuals/git-clone.qmd) | Code repositories, version control | Intermediate (CLI) |
72+
73+
74+
::: {.callout-note collapse = "true"}
75+
## Transferring from OneDrive
76+
OneDrive is currently not directly supported with rclone for UU accounts. To transfer files from OneDrive:
77+
78+
1. Download (preferably compress/zip) files from OneDrive to your local PC
79+
2. Transfer from your PC to the workspace using one of the methods above
80+
:::
81+
82+
{{< include ../partials/_data_transfer.qmd >}}
83+
3884
## Usage
3985

86+
**Installing software packages**
87+
88+
You can install system packages by running the following command in the terminal:
89+
90+
```bash
91+
# Update package lists
92+
sudo apt update
93+
94+
# Install a package
95+
sudo apt install package-name
96+
```
97+
4098
## Tips
4199

100+
[Contact us](../../contact.qmd) if you have any questions or need help with your workspace and with installing additional software packages.

0 commit comments

Comments
 (0)