Skip to content

Commit 50cb94a

Browse files
committed
Merge remote-tracking branch 'origin/master' into software-catalog
2 parents 1861649 + a13cafe commit 50cb94a

17 files changed

+255
-132
lines changed

docs/apps/lastools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ tags:
1313

1414
LAStools is included in following modules:
1515

16-
* lastools: 2025 (more exactly 250219), 2023 (230914) and 2022 (220613)
16+
* lastools: 2025 (more exactly 250304), 2023 (230914) and 2022 (220613)
1717
* geoconda: 3.11.9, 3.10.9 and 3.10.6 (all with older 20171231)
1818

1919
Load one of these modules, for example the newest version (default):

docs/apps/python.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,19 @@ with the command `python3 --version`, and the full path of the command with
8888
`which python3` (to see if you are using the system Python or one from the
8989
modules listed above).
9090

91+
!!! info ""
92+
93+
Note that most of the pre-installed Python environment modules are
94+
self-contained and mutually exclusive environments, so it does not
95+
make sense to for example load both python-data and pytorch
96+
modules. The module loaded last will be the only active one, and
97+
the module load command will warn about this, for example:
98+
99+
```
100+
Lmod is automatically replacing "python-data/3.10-24.04" with "pytorch/2.5".
101+
```
102+
103+
91104
### Custom Python environments
92105

93106
While the pre-installed Python environments suffice for many applications,

docs/cloud/pouta/multiattach.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,49 @@ You can enable them if you wish with `pcs`:
440440
$> pcs resource create sharedfs1 --group shared_vg1 ocf:heartbeat:Filesystem device="/dev/shared_vg1/shared_lv1" directory="/mnt/gfs" fstype="gfs2" options=noatime op monitor interval=10s on-fail=fence
441441
```
442442

443+
* **How to extend my GFS2 volume?**
444+
445+
The GFS2 volume was configured using LVM ([Logical Volume Manager](https://en.wikipedia.org/wiki/Logical_volume_management)) that enhance the management and flexibility of physical storage.
446+
447+
a. Create a new multiattach volume and attach it to your instances. Check that the volume is well attached by running the command `sudo parted -l`
448+
449+
b. On one node, add the new volume in the Volume Group:
450+
451+
```sh
452+
sudo vgextend VolumeGroupName /dev/vdX
453+
```
454+
455+
c. Still on one node, extend the Logical Volume:
456+
457+
```sh
458+
sudo lvextend -l +100%FREE /dev/VolumeGroupName/LogicalVolumeName
459+
```
460+
461+
d. Check that the Logical Volume has been extended by running the command `sudo lvs`
462+
463+
e. Before extending the GFS2 volume, check on the other nodes that you don't have error messages. Run `sudo pvs`. If you see something like:
464+
465+
```
466+
WARNING: Couldn't find device with uuid JuoyG2-ftdd-U9xm-LLei-VrY7-4GZz-FgC2dr.
467+
WARNING: VG shared_vg1 is missing PV JuoyG2-ftdd-U9xm-LLei-VrY7-4GZz-FgC2dr (last written to /dev/vdX)
468+
```
469+
You must add the device by running the command:
470+
471+
```
472+
sudo lvmdevices --adddev /dev/vdX
473+
```
474+
475+
Check again with the command `sudo pvs`. The warning message shouldn't appear.
476+
477+
f. If everything's ok, you can grow your GFS2 volume by typing:
478+
479+
```sh
480+
sudo gfs2_grow <YourGFS2MountVolume>
481+
```
482+
483+
!!! warning
484+
You cannot decrease the size of a GFS2 file system
485+
443486
* **What happens if a VM gets disconnected?**
444487
445488
This covers two different use cases, a temporal and/or unexpected disconnection, and a permanent one.
@@ -484,6 +527,8 @@ You can enable them if you wish with `pcs`:
484527
- [Getting start with Pacamaker](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_high_availability_clusters/assembly_getting-started-with-pacemaker-configuring-and-managing-high-availability-clusters#proc_learning-to-use-pacemaker-getting-started-with-pacemaker)
485528
- [Configuring a Red Hat High Availability cluster on Red Hat OpenStack Platform](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_a_red_hat_high_availability_cluster_on_red_hat_openstack_platform/index)
486529
- [GFS2 file systems in a cluster](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_gfs2_file_systems/assembly_configuring-gfs2-in-a-cluster-configuring-gfs2-file-systems#proc_configuring-gfs2-in-a-cluster.adoc-configuring-gfs2-cluster)
530+
- [Growing a GFS2 file system](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_gfs2_file_systems/assembly_creating-mounting-gfs2-configuring-gfs2-file-systems#proc_growing-gfs2-filesystem-creating-mounting-gfs2)
531+
- [Managing LVM volume groups](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/managing-lvm-volume-groups_configuring-and-managing-logical-volumes#managing-lvm-volume-groups_configuring-and-managing-logical-volumes)
487532
488533
## OCFS2 as a second example
489534

docs/cloud/rahti/images/Using_Rahti_integrated_registry.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,29 @@ The process is simple:
1111

1212
1. With a terminal, connect to the Rahti registry:
1313
```sh
14-
docker login -p $(oc whoami -t ) -u unused image-registry.apps.2.rahti.csc.fi
14+
sudo docker login -p $(oc whoami -t ) -u unused image-registry.apps.2.rahti.csc.fi
1515
```
16-
16+
1717
_Alternatively, you can access to this address: <https://oauth-openshift.apps.2.rahti.csc.fi/oauth/token/display> to request
1818
a token. Once connected, display and copy the token. The command will be:_
1919

2020
```sh
21-
docker login -p <YOUR_TOKEN> -u unused image-registry.apps.2.rahti.csc.fi
21+
sudo docker login -p <YOUR_TOKEN> -u unused image-registry.apps.2.rahti.csc.fi
2222
```
2323

2424
!!! info
2525
If you get any error, make sure you are logged in. If you run `oc whoami`, the command should return your username.
2626

2727
2. Tag the image you want to push:
2828
```sh
29-
docker tag centos:7 image-registry.apps.2.rahti.csc.fi/{YOUR_RAHTI_PROJECT_NAME}/centos:<tag>
29+
sudo docker tag centos:7 image-registry.apps.2.rahti.csc.fi/{YOUR_RAHTI_PROJECT_NAME}/centos:<tag>
3030
```
3131
_Replace {YOUR_RAHTI_PROJECT_NAME} by the name of your project._
3232
_Please note that YOUR_RAHTI_PROJECT_NAME here is the Rahti project name (AKA namespace name), and does not refer to CSC project._
3333

3434
4. Push your image:
3535
```sh
36-
docker push image-registry.apps.2.rahti.csc.fi/{YOUR_RAHTI_PROJECT_NAME}/centos:<tag>
36+
sudo docker push image-registry.apps.2.rahti.csc.fi/{YOUR_RAHTI_PROJECT_NAME}/centos:<tag>
3737
```
3838

3939
You should be able to see your images in your project:

docs/cloud/rahti/usage/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ Rahti also offers the opportunity of using an internal service account to intera
8080

8181
```sh
8282
oc create serviceaccount pusher
83-
oc policy add-role-to-user system:image-pusher pusher
84-
docker login -p $(oc sa get-token pusher) -u unused image-registry.apps.2.rahti.csc.fi
83+
oc policy add-role-to-user system:image-pusher -z pusher
84+
docker login -p $(oc create token pusher) -u unused image-registry.apps.2.rahti.csc.fi
8585
```
8686

8787
This service account token, the one you get with `oc sa get-token pusher` does not expire.

docs/data/sensitive-data/sd-connect-command-line-interface.md

Lines changed: 25 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
# Command Line Interface and automated key management
22

3-
The new SD Connect command line tools, available from February 2025, support file upload, download (with a-commands) and automated key management (with lock-unlock) during encryption and decryption. After programmatic encryption and upload, data can be viewed through the SD Connect user interface and SD Desktop. Coding skills are required to use the tools effectively, below is a step by step guide to get started. In contrast, files have been uploaded before February 2025, were manually encrypted using your encryption key and will need to be decrypted manually after download.
3+
The new SD Connect command line tools, available from February 2025, support file upload, download (with a-commands) and automated key management (with lock-unlock) during encryption and decryption. After programmatic encryption and upload, data can be viewed through the SD Connect user interface and SD Desktop. Coding skills are required to use the tools effectively, below is a step by step guide to get started. In contrast, files have been uploaded before February 2025, were manually encrypted using your encryption key and will need to be decrypted manually after download.
44

55
- [Background information](#background-information)
66
- [Command line tools and automated key management](#command-line-tools-and-automated-key-management)
77
- [Command line tools and manual encryption](#command-line-tools-and-manual-encryption)
88
- [Tutorials](#tutorials)
99

10-
1110
## Background information
1211

1312
SD Connect is part of CSC's Sensitive Data Services, offering a free and secure data processing environment for academic research projects at Finnish universities and research institutes. SD Connect enhances the Allas object storage system by adding an automatic encryption layer, enabling secure storage of sensitive data. Data stored in SD Connect can also be accessed through SD Desktop for secure virtual desktops. While SD Connect is typically accessed via the SD Connect Web interface, command-line tools may offer a more efficient way to manage data in certain situations.
1413

15-
This document provides instructions on how you can install on your local environment (Linux, Mac) and how you can use the a-commands from the allas-cli-utils package to upload and download with automated key management via command line with SD Connect.
14+
This document provides instructions on how you can install on your local environment (Linux, Mac) and how you can use the a-commands from the allas-cli-utils package to upload and download with automated key management via command line with SD Connect.
1615

1716
!!! Note
1817
Allas itself does not differentiate between data uploaded via SD Connect (user interface or commandline tools) and data uploaded to Allas using different methods. Data buckets may contain a mix of SD Connect data, other encrypted data, and regular data. It is the user's responsibility to manage data types within the buckets. However, it is recommended to store SD Connect data in separate buckets and folders to avoid mixing different data types.
@@ -23,7 +22,7 @@ This document provides instructions on how you can install on your local environ
2322

2423
To upload and automatically encrypt sensitive data to SD Connect programmatically, you need to install the command-line tools, which require root access to your laptop or local environment (Mac or Linux). For this reason, you might need support from your organization’s IT unit.
2524

26-
Here you can find step-by-step instructions: https://github.com/CSCfi/allas-cli-utils. This guide provides installation instructions for the a-commands (used to upload and download files) as well as the lock and unlock commands (used to automatically encrypt and decrypt files via automated key management).
25+
[Here you can find step-by-step instructions](https://github.com/CSCfi/allas-cli-utils). This guide provides installation instructions for the a-commands (used to upload and download files) as well as the lock and unlock commands (used to automatically encrypt and decrypt files via automated key management).
2726

2827
!!! Note
2928
If you need to upload non-sensitive data (such as scripts, containers, or software for use in SD Desktop), note that these tools are also available on CSC's supercomputers (Puhti, Mahti, and Lumi). However, these systems are restricted to non-sensitive data only. Sensitive data must be uploaded to SD Connect through the appropriate channels.
@@ -36,27 +35,29 @@ To open SD Connect compatible Allas connection you must add option *--sdc* the c
3635
module load allas
3736
allas-conf --sdc
3837
```
38+
3939
In local installations the connection is typically opened with commands like
4040

4141
```bash
4242
export PATH=/some-local-path/allas-cli-utils:$PATH
4343
source /some-local-path/allas-cli-utils/allas_conf -u your-csc-account --sdc
4444
```
4545

46-
The set up process asks first your CSC passwords (Haka or Virtu passwords can't be used here).
47-
After that you will select the CSC project to be used. This is the normal login process for Allas.
48-
However, when SD Connect is enabled, the process asks you to give the *SD Connect API token*. This
49-
token must be retrieved from the [SD Connect web interface](https://sd-connect.csc.fi). Note that the tokens
50-
are project specific. Make sure you have selected the same SD Connect project in both command line and in web
51-
interface.
46+
- The set up process asks first your CSC passwords (Haka or Virtu passwords can't be used here). After that you will select the CSC project to be used. This is the normal login process for Allas.
47+
- However, when SD Connect is enabled, the process asks you to give the *SD Connect API token*.
48+
49+
To retrieve the temporary SD Connect API token:
5250

53-
In the web interface the token can be created using dialog that opens by selecting *Create API tokens* from the *Support* menu.
51+
- Login to the [SD Connect web interface](https://sd-connect.csc.fi). If you have multiple CSC projects, make sure you have selected the same SD Connect project in both the command line and the web interface (top left corner).
52+
- In the top right corner of the web interface, click on Support, then select Select API Token from the dropdown menu.
53+
- In the new dialog, enter a name for your temporary token. Note: Tokens are project-specific, so the name must be unique. Avoid using special characters in the name.
54+
- Click on Create Token. The token will be displayed only once. Once you see the token, copy it (click the icon to the left of the token). Important: make sure to store it securely, as it will not be retrievable later.
5455

55-
Copy the token, paste into to command line and press enter.
56+
![API token](https://a3s.fi/docs-files/sensitive-data/SD_Connect/SDConnect_APItoken.png)
5657

57-
The SD Connect compatible Allas connection is now valid for next eight hours. And you can use commands like
58-
*a-list* and *a-delete* to manage both normal Allas objects and SD Connect objects.
58+
- The token will be valid for 24 hours and will be automatically deleted after this period. Paste the token into the command line and press Enter to use it.
5959

60+
The SD Connect compatible Allas connection is now valid for next eight hours. And you can use commands like *a-list* and *a-delete* to manage both normal Allas objects and SD Connect objects.
6061

6162
### Step 3: Data upload and automated encryption
6263

@@ -72,7 +73,7 @@ This will produce SD Connect object: 2000123-sens/dataset2/my-secret-table.csv.c
7273
All other a-put options and features can be used too. For example directories are
7374
stored as tar files, if --asis option is not used.
7475

75-
Command:
76+
Command:
7677

7778
```bash
7879
a-put --sdc my-secret-directory -b 2000123-sens/dataset2
@@ -94,13 +95,11 @@ The command above will copy all the files from directory my-secret-directory to
9495
!!! Note
9596
Since SD Connect was updated in October 2024, it is no longer straightforward to determine which encryption method was used for an encrypted .c4gh file stored in Allas/SD Connect. If you are now using a new encryption method to upload files to an existing CSC project, please ensure you add a note to your folders indicating that the encryption protocol has changed. You can either share this information with your colleagues or clearly include it in the folder name. As a good practice, we advise creating a new folder and avoiding mixing files encrypted with different methods.
9697

97-
98-
9998
### Step 4: Data download and automated decryption
10099

101100
Data can be downloaded from Allas with command a-get. If SD Connect connection is enabled, a-get will automatically try to decrypt objects with suffix *.c4gh*.
102101

103-
So for example command:
102+
So for example command:
104103

105104
```bash
106105
a-get 2000123-sens/dataset2/my-secret-table.csv.c4gh
@@ -114,7 +113,7 @@ And similarly command:
114113
a-get 2000123-sens/dataset2/my-secret-directory.tar.c4gh
115114
```
116115

117-
Will produce local directory: my-secret-directory
116+
Will produce local directory: my-secret-directory
118117

119118
Note that this automatic decryption works only for the files that have
120119
been stored using the new SD Connect that was taken in use in October 2024.
@@ -127,8 +126,7 @@ a-get --sk my-key.sec 2000123-sens/old-date/sample1.txt.c4gh
127126
```
128127

129128
Unfortunately there is no easy way to know, which encryption method has been used in
130-
a .c4gh file stored in Allas.
131-
129+
a .c4gh file stored in Allas.
132130

133131
## Command line tools and manual encryption
134132

@@ -197,7 +195,7 @@ In this example, we first generate your key pair (a password-protected private k
197195
C4GH_SECRET_KEY If defined, it will be used as the default secret key (ie --sk ${C4GH_SECRET_KEY})
198196
```
199197
200-
You may notice that crypt4gh uses `--sk` option for the private key. This might seem odd but apparently, crypt4gh uses term _secure key_ for private key, hence `sk`, and consequently `pk` refers to public key instead of the private key.
198+
You may notice that crypt4gh uses `--sk` option for the private key. This might seem odd but apparently, crypt4gh uses term *secure key* for private key, hence `sk`, and consequently `pk` refers to public key instead of the private key.
201199
202200
### 2.2 Decrypt a file
203201
@@ -216,22 +214,16 @@ The command will ask the user to enter the password (passphrase) of your private
216214
217215
Additional information about [data encryption](./sd-connect-introduction-to-data-encryption.md).
218216
219-
220-
221217
## Tutorials
222218
223219
- [Tools for client side encryption for Allas](../Allas/allas_encryption.md)
224-
225220
- [Decrypting all files in a directory](../sensitive-data/tutorials/decrypt-directory.md)
226-
227221
- [Using Allas storage service to receive sensitive research data](../sensitive-data/sequencing_center_tutorial.md)
228222
229-
230-
231223
## Features in SD Connect
232224
233-
* [Upload](./sd-connect-upload.md)
234-
* [Share](./sd-connect-share.md)
235-
* [Download](./sd-connect-download.md)
236-
* [Delete](./sd-connect-delete.md)
237-
* [Troubleshooting](./sd-connect-troubleshooting.md)
225+
- [Upload](./sd-connect-upload.md)
226+
- [Share](./sd-connect-share.md)
227+
- [Download](./sd-connect-download.md)
228+
- [Delete](./sd-connect-delete.md)
229+
- [Troubleshooting](./sd-connect-troubleshooting.md)

0 commit comments

Comments
 (0)