Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New file transfer guide #824

Merged
merged 26 commits into from
Mar 4, 2025
Merged

New file transfer guide #824

merged 26 commits into from
Mar 4, 2025

Conversation

xamberl
Copy link
Contributor

@xamberl xamberl commented Oct 18, 2024

Major changes

  • Added guide on using osdf:// and file:/// syntax, including mentions of caching (https://chtc.github.io/web-preview/preview-xalim-osdf-guide/uw-research-computing/htc-job-file-transfer)
  • Archived file transfer guide for small files and for SQUID
  • Changed language on large file transfer guide to use osdf:// or file:///. Removed references to copying to and from /staging in the executable script. I can put it back if we want to keep it.
  • Changed the file_avail layout (it puts a table on top of these data guides) to reflect our current file systems and the new file transfer syntax.

I'm planning to test osdf:// file transfer, so don't merge this yet until it's confirmed to work.

@xamberl
Copy link
Contributor Author

xamberl commented Oct 21, 2024

Confirmed that osdf:// for file transfer and caching works.

Copy link
Contributor

@ChristinaLK ChristinaLK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! I like the structure and information. :D

I may try to whip together a rewrite of the "checking your quotas" guide so we can have that all in one place and you can remove it from the large-data guide and link it from the main one.

Copy link
Contributor

@ChristinaLK ChristinaLK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me! will just need to coordinate a date to switch over + how to communicate to users.

Copy link
Contributor

@aowen-uwmad aowen-uwmad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Finally got around to this.
Suggest we run this by Christina &/or Ops team before merging.

Comment on lines +16 to +17
The default quota allotment in your `/home` directory is 20 GB with a hard
limit of 30 GB (at which point you cannot write more files).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this got upped when we were upgrading the OS last spring.

Suggested change
The default quota allotment in your `/home` directory is 20 GB with a hard
limit of 30 GB (at which point you cannot write more files).
The default quota allotment in your `/home` directory is 40 GB with a hard
limit of 50 GB (at which point you cannot write more files).

Comment on lines +44 to +46
be allowed to save data. Each value is given in 1-kilobyte
blocks, so you can divide each number by 1024 to get megabytes (MB), and
again for gigabytes (GB). (It also lists information for ` files`, but
we don\'t typically allocate disk space by file count.)
again for gigabytes (GB). (It also lists information for number of `files`, but
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The -s option for quotas should return mebibytes, not kibibytes.

Also, bytes are multiples of 1000 while bibytes are multiples of 1024 (bi is used to denote that the unit is a power of 2; 1024 = 2^10).
We use bibytes for setting quotas.

In general, I think that we use bytes when communicating with users, but if math is involved for getting their quota values, will need to use bibytes instead..


To transfer a file or folder back to `/staging`, you will need an additional line in your HTCondor submit file:
```
transfer_output_remaps = "file1.txt = file:///staging/NetID/output1.txt; file2.txt = /home/NetId/outputs/output2.txt"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest to omit file going to home, for clarity.

```
{:.sub}

In this example above, `file1.txt` is remapped to the staging directory using the `file:///` transfer protocol and simultaneously renamed `output1.txt`. In addition, `file2.txt` is renamed to `output2.txt`and will be transferred to a different directory on `/home`. Ensure you have the right file transfer syntax (`osdf:///` or `file:///` depending on the anticipated file size).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition, file2.txt is renamed to output2.txtand will be transferred to a different directory on /home. Ensure you have the right file transfer syntax (osdf:/// or file:/// depending on the anticipated file size).

A version of this should be moved to after the next example.

Comment on lines 45 to 50
| Input Sizes | File Location | Submit File Syntax to Transfer to Jobs |
| ----------- | ----------- | ----------- | ----------- |
| 0 - 100 MB | `/home` | `transfer_input_files = input.txt` |
| 100 MB - 30 GB | `/staging` | `transfer_input_files = osdf:///chtc/staging/NetID/input.txt` |
| > 30 GB | `/staging` | `transfer_input_files = file:///staging/NetID/input.txt` |
| > 100 GB | | For larger datasets (100GB+ per job), contact the facilitation team about the best strategy to stage your data |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May want to include /projects in here as well

{:.sub}

Ensure you are using the correct file transfer protocol for efficiency. Failure to use the right protocol can result in slow file transfers or overloading the system.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest adding a couple subsections here to expound upon the syntax, i.e., ### file:/// Syntax and ### osdf:/// Syntax.

@xamberl xamberl merged commit baca254 into master Mar 4, 2025
0 of 3 checks passed
@xamberl xamberl deleted the preview-xalim-osdf-guide branch March 4, 2025 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants