You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: topics/admin/tutorials/surf-research-cloud-galaxy/tutorial.md
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,12 +17,12 @@ requirements:
17
17
- type: "none"
18
18
title: An SSH key connected to your account
19
19
- type: "none"
20
-
title: Have a basic understanding of how Galaxy works
20
+
title: Have a basic understanding of how Galaxy works
21
21
time_estimation: "30m"
22
22
level: Introductory
23
23
key_points:
24
-
- With SRC you can start your own Galaxy on-demand instance in a secure environment
25
-
- You can log in and use Galaxy via the SRC with your university credentials
24
+
- With SRC you can start your own Galaxy on-demand instance in a secure environment
25
+
- You can log in and use Galaxy via the SRC with your university credentials
26
26
contributions:
27
27
authorship:
28
28
- mirelaminkova
@@ -46,8 +46,11 @@ follow_up_training:
46
46
topic_name: admin
47
47
tutorials:
48
48
- surf-research-cloud-pulsar
49
+
50
+
subtopic: cloud
49
51
tags:
50
52
- deploying
53
+
51
54
---
52
55
53
56
Using Galaxy via the {SRC} allows researchers to start Galaxy instances on-demand and analyze their data in a secure environment following the {GDPR}. The instance provides secure authentication, where users must have a SURF Research account prior to this tutorial, have set the {SRAM} authentication method, and connect an SSH key to their accounts. In case you are not familiar with {SRC} and need help in setting up your accounts, please follow the instructions on the [SURF Knowledge Base](https://servicedesk.surf.nl/wiki/display/WIKI/SURF+Research+Cloud)
@@ -76,7 +79,7 @@ You must have previous experience working with data inside Galaxy.
76
79
# Starting a Galaxy instance inside SRC step-by-step
77
80
78
81
> <hands-on-title>Access the SRC</hands-on-title>
79
-
> 1. The first and most important step is to have access to the SURF Research Cloud.
82
+
> 1. The first and most important step is to have access to the SURF Research Cloud.
80
83
> 2. You will need to login to the [portal](https://portal.live.surfresearchcloud.nl).
81
84
> 
82
85
>
@@ -94,7 +97,7 @@ The purpose of the storage is to attach it to your workspace, where you will sav
94
97
95
98
96
99
> <hands-on-title>Create a Storage Volume</hands-on-title>
97
-
> 1. Locate the "Create new storage" option
100
+
> 1. Locate the "Create new storage" option
98
101
> 
99
102
> 2. Click on "Create new".
100
103
> 3. Select the collaborative organisation you want the storage to be part of.
@@ -104,12 +107,12 @@ The purpose of the storage is to attach it to your workspace, where you will sav
104
107
> {: .tip}
105
108
>
106
109
> 
107
-
>
110
+
>
108
111
> 6. Name your storage however you like and press on submit.
109
112
>
110
113
> 
111
114
>
112
-
> 7. You will be redirected to the main page, where you will be able to track the status of the storage creation.
115
+
> 7. You will be redirected to the main page, where you will be able to track the status of the storage creation.
113
116
>
114
117
> 
115
118
{: .hands_on}
@@ -130,32 +133,32 @@ Depending on user’s rights, you can create a new workspace for your collaborat
130
133
> 1. On the right side under the "Workspaces" click on the "Add" button.
131
134
>
132
135
> 
133
-
>
134
-
> 2. Then, you will be redirected to a new page, where you must first choose the collaborative organisation in which you want to create your workspace (in case you are a member of multiple organisations). Once chosen, you a new page will be loaded, where you will have access to all available catalog items.
136
+
>
137
+
> 2. Then, you will be redirected to a new page, where you must first choose the collaborative organisation in which you want to create your workspace (in case you are a member of multiple organisations). Once chosen, you a new page will be loaded, where you will have access to all available catalog items.
135
138
>
136
139
> 
137
-
>
140
+
>
138
141
> 3. Use the magnifying glass on the right side of the panel and search for Galaxy. Two catalog items will appear - the Galaxy instance designed for SURF and a Galaxy Pulsar node that can be connected to the instance. Select "Galaxy at SURF".
139
142
>
140
143
> 
141
-
>
142
-
> 4. SURF Research Cloud allows researchers to host their catalog items on different cloud providers. The Galaxy catalog item is currently supported only on the HPC Cloud and for Ubuntu 22.04. On this page, users can select the number of cores and RAM that they want on their machine. More sizes can be added in the future, and on request. Choose wisely and in case you are not certain contact your administrator!
144
+
>
145
+
> 4. SURF Research Cloud allows researchers to host their catalog items on different cloud providers. The Galaxy catalog item is currently supported only on the HPC Cloud and for Ubuntu 22.04. On this page, users can select the number of cores and RAM that they want on their machine. More sizes can be added in the future, and on request. Choose wisely and in case you are not certain contact your administrator!
143
146
>
144
147
> 
145
-
>
146
-
> 5. Select the storage you have created earlier so it is attached to the new workspace.
148
+
>
149
+
> 5. Select the storage you have created earlier so it is attached to the new workspace.
147
150
>
148
151
> 
149
-
>
150
-
> 6. Lastly, before the workspace is deployed, you need to choose for how long the machine will run.
152
+
>
153
+
> 6. Lastly, before the workspace is deployed, you need to choose for how long the machine will run.
151
154
>
152
155
> > <tip-title>Expiration Date</tip-title>
153
156
> > The standard life-time of the VM is 5 days. If you need it for longer, this option can be changed once the machine is running.
154
157
> > Note, that once the machine is expired and deleted it cannot be restored! Plan accordingly and migrate your data in time to prevent data loss!
155
158
> >
156
159
> > This is an incredibly useful feature as it saves you from forgetting to destroy a VM. Especially for GPU nodes it can help you ensure that they disappear after your computation is complete.
157
160
> {:.tip}
158
-
>
161
+
>
159
162
> 7. In this form, you can also select how to name your workspace, add a description (if you want) and specify the hostname. Then, scroll down and submit the workspace creation.
160
163
> 
Copy file name to clipboardExpand all lines: topics/admin/tutorials/surf-research-cloud-pulsar/tutorial.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,6 +42,8 @@ follow_up_training:
42
42
tutorials:
43
43
- surf-research-cloud-galaxy
44
44
subtopic: cloud
45
+
tags:
46
+
- deploying
45
47
---
46
48
47
49
@@ -95,7 +97,7 @@ You should have previous experience working with data inside Galaxy.
95
97
>
96
98
> 
97
99
>
98
-
> 6. Pick a name, it can be anything, it does not matter. Check the expiration date to ensure it is just enough time for your computation and no more.
100
+
> 6. Pick a name, it can be anything, it does not matter. Check the expiration date to ensure it is just enough time for your computation and no more.
99
101
>
100
102
> > <tip-title>Expiration Date</tip-title>
101
103
> > The standard life-time of the VM is 5 days. If you need it for longer, this option can be changed once the machine is running.
@@ -117,30 +119,30 @@ Once done, the workspace will be created for you. You'll need to wait ~5 minutes
117
119
## Using Pulsar on SRC
118
120
119
121
> <hands-on-title>Access the Information Page</hands-on-title>
120
-
>
122
+
>
121
123
> 1. Once the workspace is up, you'll see an **Access** link:
122
-
>
124
+
>
123
125
> 
124
-
>
126
+
>
125
127
> 2. Click that will show you a Pulsar information page. This page is running on your pulsar node itself, and is restricted to ensure only authorised members can access the contents. It includes some configuration you will need to copy to your Galaxy node in order to make use of the Pulsar node.
126
-
>
128
+
>
127
129
> 
128
130
{: .hands_on}
129
131
130
132
This information page should have more than enough information to connect this Pulsar instance to your Galaxy server. You will need to reference information from this page in the following steps:
131
133
132
134
> <hands-on-title>Configuring Galaxy to use SRC Pulsar</hands-on-title>
133
135
> 1. Collect the requirements for accessing the Galaxy machine. You will need:
134
-
>
136
+
>
135
137
> - your username from the first step
136
138
> - your SSH key that is associated with your SRAM account
137
-
>
139
+
>
138
140
> 2. SSH into your *Galaxy* machine (not pulsar!).
> 3. You will need to `sudo su` to do anything useful. Do that now.
145
147
> 4. `cd /srv/galaxy/` to move into the directory Galaxy configuration is stored.
146
148
> 5. The configuration is discussed fully in the Pulsar information, but it will be briefly covered here as well. Generally there are a few steps that must be followed:
@@ -150,8 +152,8 @@ This information page should have more than enough information to connect this P
150
152
> - Some tools should be redirected to this Pulsar
151
153
>
152
154
> Here is an example of what those changes *might* look like in your Galaxy node. In this example our pulsar node was called `p20` but that will be different for you.
153
-
>
154
-
> {% snippet topics/admin/faqs/diffs.md %}
155
+
>
156
+
> {% snippet topics/admin/faqs/diffs.md %}
155
157
>
156
158
>
157
159
> ```diff
@@ -212,9 +214,9 @@ You can find the tool ID from the dropdown at the top right, just to the left of
212
214

213
215
214
216
> <tip-title>An Easy Configuration Option: Send Every Job to Pulsar</tip-title>
215
-
>
217
+
>
216
218
> If you are running jobs for a limited period of time, you might consider making this pulsar node the default destination. Remember to use the `remote_...` name of your pulsar node, based on what you copied. Not `remote_p20`.
0 commit comments