Skip to content

Commit

Permalink
Fix markdown style issues
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed May 15, 2024
1 parent 042a158 commit 2689769
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 10 deletions.
9 changes: 8 additions & 1 deletion docs/cluster_guides/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ As PI, you and your academic institution are ultimately responsible for your dat
While UPPMAX systems may have backup, these are not designed to act as the sole repository of primary data, e.g. raw data or originals.

## What does "backup" mean for my data?

The type of backup that is generally available for project storage at UPPMAX is incremental backup with 30 day retention. This means that any file that was deleted more than 30 days ago is irretrievably gone. Changes in a file are kept for 30 days, so we can potentially retrieve an old version up to a month after you edited it.

The backup service tries to backup all changes as often as they occur, but rapid changes will not register. Due to the large amounts of files in the file systems, a single backup session may take upwards of a week or more. This means that if you create a file and delete it the next day, it will probably not be backed up.
Expand All @@ -18,6 +19,7 @@ To ensure timely backups, it is very important to reduce the workload of the bac
- It is especially important that temporary files and files that are changed often are placed in nobackup directories.

## Which directories are backed up?

Backup is done on:

- Home directories (on Rackham these also have snapshots)
Expand All @@ -27,24 +29,29 @@ Backup is done on:
- UPPMAX Offload Storager projects (uppoff20YYXXX)
- SNIC projects (named snicYYYY-X-ZZZZ)

# What should I put in directories with backup?
## What should I put in directories with backup?

- In short, irreplaceable data should be placed there. This includes especially raw sequencing data and any other data that cannot be recreated by any effort. Scripts and other files that are needed to reproduce or repeat the analyses should also be placed on backup.

## What should I not put in directories with backup?

- Directories where you are actively working, especially if you are creating or modifying many files.
The backup mechanisms cannot keep up with large amounts of files changing on a rapid basis.

## How robust is uppmax storage?

- All UPPMAX storage systems use RAID technology to make storage more robust through redundancy.
- This means that two or more disks must fail in the same "RAID volume" before there is a risk of data loss.

- However, this technology does not protect against user error (e.g. "rm -rf * in your project directory) or in case of a significant disaster (e.g. fire in computer hall).
- Off-site backup is crucial.

## How can I access my backups?

You must contact UPPMAX support and ask for help. Provide as much information as possible, especially directory and file names.

## What about "snapshots"?

- In addition to the regular backup service, the home directories on Rackham have a feature called "snapshots".
- Snapshot makes a frozen "picture" of some file structure as it looks at the time the snapshot was taken.
- This allows you to restore a particular file as it was at some time point.
Expand Down
8 changes: 4 additions & 4 deletions docs/cluster_guides/bianca_file_transfer_using_filezilla.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,17 @@ In the 'Site Manager' dialog, click 'New site'

![](./img/filezilla_site_manager.png)

## 5. Create a name for the site, e.g. `bianca-sens123456`.
## 5. Create a name for the site, e.g. `bianca-sens123456`

In the 'New Site' dialog, create a name for the site, e.g. `bianca-sens123456`.

## 6. Configure site

In the 'New Site' dialog, use all standards, except:

* Set protocol to 'SFTP - SSH File Transfer Protocol'
* Set host to `bianca-sftp.uppmax.uu.se`
* Set user to `[username]-[project]`, e.g. `richel-sens123456`
- Set protocol to 'SFTP - SSH File Transfer Protocol'
- Set host to `bianca-sftp.uppmax.uu.se`
- Set user to `[username]-[project]`, e.g. `richel-sens123456`

???- tip "How does that look like?"

Expand Down
4 changes: 2 additions & 2 deletions docs/cluster_guides/bianca_file_transfer_using_gui.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ Here, we show how to transfer files using a graphical tool called FileZilla.

In general, one can pick any graphical tools with these constraints:

* the tool must support SFTP
* the tool must not store a password
- the tool must support SFTP
- the tool must not store a password

Whatever tool one picks, it must do secure file transfer.
For secure file transfer, Bianca supports the SFTP protocol.
Expand Down
7 changes: 4 additions & 3 deletions docs/cluster_guides/bianca_file_transfer_using_winscp.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ Start WinSCP.
In WinSCP, click on 'Create new site'.

For that site, use all standards, except:
* Set file protocol to 'SFTP'
* Set host name to `bianca-sftp.uppmax.uu.se`
* Set user name to `[username]-[project]`, e.g. `richel-sens123456`

- Set file protocol to 'SFTP'
- Set host name to `bianca-sftp.uppmax.uu.se`
- Set user name to `[username]-[project]`, e.g. `richel-sens123456`

???- tip "How does that look like?"

Expand Down

0 comments on commit 2689769

Please sign in to comment.