Skip to content

Commit 298c22b

Browse files
xamberlChristinaLK
andauthored
New pages for checking quotas (#910)
* Update htc quota guide * New hpc quota page; remove broken link * Apply suggestions from code review Change "more" to "higher" Co-authored-by: Christina K. <[email protected]> --------- Co-authored-by: Christina K. <[email protected]>
1 parent 5f64354 commit 298c22b

File tree

4 files changed

+269
-56
lines changed

4 files changed

+269
-56
lines changed

_data/hpc-guide-menu.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
- text: "Manage data"
2828
icon: "bi bi-file-earmark-text"
2929
links:
30+
- text: "Check disk quota and usage"
31+
url: "/uw-research-computing/hpc-check-quota"
32+
icon: ""
3033
- text: "Transfer files to/from CHTC"
3134
icon: ""
3235
links:

_uw-research-computing/check-quota.md

Lines changed: 129 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,96 +8,171 @@ guide:
88
- htc
99
---
1010

11-
The following commands will allow you to monitor the amount of disk
12-
space you are using in your home directory on the access point and to determine the
13-
amount of disk space you have been allotted (your quota).
11+
## Introduction
12+
13+
This guide shows you how to check the amount of disk space and number of files you are using on the Access Point in your `/home` and `/staging` directories. You can also check your limit on your disk space and number of files (i.e., your "quota"). This guide will help you manage your disk space and give tips on what do when you've reached your quota.
14+
15+
{% capture content %}
16+
- [Introduction](#introduction)
17+
- [Default quotas](#default-quotas)
18+
- [Check your quota](#check-your-quota)
19+
- [Other ways to check your quota](#other-ways-to-check-your-quota)
20+
- [Check the size of a directory and its contents](#check-the-size-of-a-directory-and-its-contents)
21+
- [What to do when you've reached your quota](#what-to-do-when-youve-reached-your-quota)
22+
- [Related pages](#related-pages)
23+
{% endcapture %}
24+
{% include /components/directory.html title="Table of Contents" %}
25+
26+
## Default quotas
27+
28+
| Data location | **`/home`** | **`/staging`** |
29+
| ----------- | ----------- |
30+
| Default quota (disk) | 40 GB | 100 GB |
31+
| Default quota (number of items) | none | 1000 items |
32+
| Purpose | Default file system, handles most files | Stages large files/containers for file transfer into jobs |
33+
| Recommended location for | Many, small files (<1 GB) | Few, large files (>1 GB) |
34+
35+
Read more about the differences between the `/home` and `/staging` file system in [this guide](htc-job-file-transfer#data-storage-locations).
36+
37+
<p style="text-align: center; margin-bottom: 0; font-weight: bold;">Need a <code>/staging</code> directory? Need a higher quota?</p>
38+
<div class="d-flex mb-3">
39+
<div class="p-3 m-auto">
40+
<a class="btn btn-primary" style="text-align: center" href="quota-request">Fill out our quota request form</a>
41+
</div>
42+
</div>
43+
44+
## Check your quota
45+
46+
For the most up-to-date information about your quota, use the `get_quotas` command on the Access Point.
47+
```
48+
get_quotas
49+
```
50+
{:.term}
1451

15-
The default quota allotment in your `/home` directory is 20 GB with a hard
16-
limit of 30 GB (at which point you cannot write more files).
52+
This will print a table with your `/home` and `/staging` quotas. An example output is shown below.
1753

18-
**Note: The CHTC access points are not backed up, so you should
19-
copy completed jobs to a secure location as soon as a batch completes,
20-
and then delete them on the submit node in order to make room for future
21-
jobs.** Disk space provided is intended for *active* calculations only, not permanent storage.
22-
If you need more disk space to run a single batch or concurrent
23-
batches of jobs, please contact us ([Get Help!](get-help.html)). We have multiple ways of dealing with large disk space requirements to make things easier for you.
54+
```
55+
[user@ap2002 ~]$ get_quotas
56+
Path Disk_Used(GB) Disk_Limit(GB) Files_Used File_Limit
57+
/home/user 16.0711 40 8039 N/A
58+
/staging/user 13.4731 100 12 1000
59+
```
60+
{:.term}
2461

25-
If you wish to change your quotas, please see [Request a Quota Change](quota-request).
62+
To print the quota for any path in `/staging`, `/software`, and `/projects` that you have access to, (i.e., a group directory), use the `-p` option:
2663

27-
**1. Checking Your `/home` Quota and Usage**
28-
-------------------------------------
64+
```
65+
get_quotas -p <path to directory>
66+
```
67+
{:.term}
68+
69+
An example output of the `get_quotas` command with the `-p` option is shown below:
70+
71+
```
72+
[user@ap2002 ~]$ get_quotas -p /staging/groups/example_group
73+
Path Disk_Used(GB) Disk_Limit(GB) Files_Used File_Limit
74+
/staging/groups/example_group 0.000433144 100 3 1000
75+
```
76+
{:.term}
77+
78+
## Other ways to check your quota
79+
80+
### Option 1: Check your `/home` quota with `quota -vs`
2981

3082
From any directory location within your `/home` directory, use the command
3183
`quota -vs`. See the example below:
3284

3385
```
34-
[alice@submit]$ quota -vs
35-
Disk quotas for user alice (uid 20384):
86+
[user@ap2002 ~]$ quota -vs
87+
Disk quotas for user user (uid 20384):
3688
Filesystem space quota limit grace files quota limit grace
37-
/dev/sdb1 12690M 20480M 30720M 161k 0 0
89+
/dev/md9 16457M 40960M 51200M 8039 0 0
3890
```
3991
{:.term}
4092

4193
The output will list your total data usage under `space`, your soft
4294
`quota`, and your hard `limit` at which point your jobs will no longer
43-
be allowed to save data. Each value is given in 1-kilobyte
44-
blocks, so you can divide each number by 1024 to get megabytes (MB), and
45-
again for gigabytes (GB). (It also lists information for number of `files`, but
46-
we don't typically allocate disk space in `/home` by file count.)
95+
be allowed to save data. It also lists information for number of `files`, but
96+
there is no quota for number of files in `/home`.
4797

48-
**2. Checking Your `/staging` Quota and Usage**
49-
------------------------------------------------
50-
Users may have a `/staging` directory, meant for staging large files and data intended for
51-
job submission. See our [Managing Large Data in HTC Jobs](file-avail-largedata) guide for
52-
more information.
98+
### Option 2: Check your Message of the Day (MOTD)
5399

54-
To check your `/staging` quota, use the command `get_quotas /staging/username`.
100+
Your quota is also printed upon the first time you log on to the Access Point that day. See below for an example:
55101

56102
```
57-
[alice@submit]$ get_quotas /staging/alice
58-
Path Quota(GB) Items Disk_Usage(GB) Items_Usage
59-
/staging/alice 20 5 3.18969 5
103+
_____________________________________________________________________
104+
##### # # ####### ##### Issues? Email [email protected]
105+
# # # # # # # Unauthorized use prohibited by:
106+
# # # # # WI Statutes: s. 947.0125
107+
# ####### # # U.S. Code: 18 USC 1030
108+
# # # # # U.S. Code: 18 USC 2510-2522
109+
# # # # # # # U.S. Code: 18 USC 2701-2712
110+
##### # # # ##### U.S. Code: 18 USC § 1831
111+
For off campus ssh access use https://www.doit.wisc.edu/network/vpn/
112+
_____________________________________________________________________
113+
114+
Online office hours are available twice a week:
115+
Tuesdays, 10:30am - 12pm (Central time)
116+
Thursdays, 3:00 - 4:30pm (Central time)
117+
118+
IMPORTANT: CHTC does NOT back up any user data. Remember to back up your data regularly!
119+
== NOTICE: THIS NODE IS ON PUPPET ENVIRONMENT "puppet8" ==
120+
121+
Filesystem quota report (last updated 10:33 AM)
122+
Storage Used (GB) Limit (GB) Files (#) File Cap (#) Quota (%)
123+
------------------ ----------- ------------ ----------- -------------- -----------
124+
/home/user 29.38 40 94 0 73.46
125+
/staging/user 50.23 1000 110 10000 5.02
60126
```
61127
{:.term}
62128

63-
Your `/staging` directory has a disk and item quota. In the example above, the disk quota is
64-
20 GB, and the items quota is 5 items. The current usage is printed in the following columns;
65-
in the example, the user has used 3.19 GB and 5 items.
129+
However, we recommend [using the `get_quotas` command](#check-your-quota) for the most up-to-date information.
66130

67-
To request a quota increase, [fill out our quota request form](quota-request).
131+
## Check the size of a directory and its contents
68132

69-
**3. Checking the Size of Directories and Contents**
70-
------------------------------------------------
133+
If you want to check the size of specific directories and their contents, you can do this with the `du` command.
71134

72-
Move to the directory you'd like to check and type `du` . After several
135+
Move to the directory you'd like to check and type `du`. After several
73136
moments (longer if the contents of your directory are large), the command
74137
will add up the sizes of directory contents and output the total size of
75-
each contained directory in units of kilobytes with the total size of
138+
each contained directory in units of kilobytes (KB) with the total size of
76139
that directory listed last. See the example below:
77140

78141
```
79-
[alice@submit]$ du ./
142+
[user@ap2002 ~]$ du ./
80143
4096 ./dir/subdir/file.txt
81144
4096 ./dir/subdir
82145
7140 ./dir
83146
74688 .
84147
```
85148
{:.term}
86149

87-
As for quota usage above, you can divide each value by 1024 to get
88-
megabytes, and again for gigabytes.
150+
You can divide each value by 1024 to get megabytes, and again for gigabytes. Below are extra options for the `du` command.
89151

90-
Using `du` with the `-h` or `--human-readable` flags will display the
91-
same values with only two significant digits and a K, M, or G to denote
92-
the byte units. The `-s` or `--summarize` flags will total up the size
93-
of the current directory without listing the size of directory contents
94-
. You can also specify which directory you\'d like to query, without
95-
moving to it, by adding the relative filepath after the flags. See the
96-
below example from the `home` directory which contains the directory
97-
`dir`:
152+
| Command | Usage |
153+
| --- | --- |
154+
| `du -h` or `du --human-readable` | Prints disk usage in a human-readable format.<br>(K, M, G denote kilo-, mega-, and gigabytes, respectively.)
155+
| `du -s` or `du --summarize` | Prints total disk usage of the directory without printing its contents. |
156+
| `du <path/to/directory>` | Prints disk usage of the specified directory. |
98157

99-
```
100-
[alice@submit]$ du -sh dir
101-
7.1K dir
102-
```
103-
{:.term}
158+
## What to do when you've reached your quota
159+
160+
When you've reached your quota, you may encounter error messages such as `Disk quota exceeded`. When you encounter the error message, we recommend the following steps:
161+
162+
1. Check your quota with `get_quotas`. At which data location did you reach your quota? Did you reach your disk quota or your items quota?
163+
1. If possible, remove any files you no longer need from the system.
164+
1. If you've reached your quota for the **number of files** in `/staging`, we recommend compressing your dataset into zip files or tarballs, because `/staging` is intended for storing few, large files. [Read more about this here.](file-avail-largedata#reduce-file-counts)
165+
1. If you still need more disk space, [request a higher quota.](quota-request)
166+
167+
> ### ⚠️ CHTC is not a storage service
168+
{:.tip-header}
169+
170+
> CHTC data locations are intended for temporarily storing files used in **active calculations only**. Once you are done with the files, please remove them from the system to clear disk space.<br><br>
171+
> **We do not back up any of the data you place on our system. It is your responsibility to back up your own files.**
172+
{:.tip}
173+
174+
## Related pages
175+
176+
* [Use and transfer data in jobs on the HTC system](htc-job-file-transfer)
177+
* [Manage large data in `/staging`](file-avail-largedata)
178+
* [Request a Quota Change](quota-request)
Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
highlighter: none
3+
layout: guide
4+
title: Check Disk Quota and Usage
5+
guide:
6+
category: Manage data
7+
tag:
8+
- hpc
9+
---
10+
11+
## Introduction
12+
13+
This guide shows you how to check the amount of disk space and number of files you are using in your `/home` and `/scratch` directories. You can also check your limit on your disk space and number of files (i.e., your "quota"). This guide will help you manage your disk space and give tips on what do when you've reached your quota.
14+
15+
{% capture content %}
16+
- [Introduction](#introduction)
17+
- [Default quotas](#default-quotas)
18+
- [Check your quota](#check-your-quota)
19+
- [Check your Message of the Day (MOTD)](#check-your-message-of-the-day-motd)
20+
- [Check the size of a directory and its contents](#check-the-size-of-a-directory-and-its-contents)
21+
- [What to do when you've reached your quota](#what-to-do-when-youve-reached-your-quota)
22+
- [Related pages](#related-pages)
23+
{% endcapture %}
24+
{% include /components/directory.html title="Table of Contents" %}
25+
26+
## Default quotas
27+
28+
| Data location | **`/home`** | **`/scratch`** |
29+
| ----------- | ----------- |
30+
| Default quota (disk) | 30 GB | 100 GB |
31+
| Default quota (number of items) | 250,000 items | 250,000 items |
32+
| Purpose | Repeatedly used files<br>(templates, source code, software, reference data) | Working data<br>(inputs, outputs, logs, stderr, stdout) |
33+
34+
<p style="text-align: center; margin-bottom: 0; font-weight: bold;">Need more quota?</p>
35+
<div class="d-flex mb-3">
36+
<div class="p-3 m-auto">
37+
<a class="btn btn-primary" style="text-align: center" href="quota-request">Fill out our quota request form</a>
38+
</div>
39+
</div>
40+
41+
## Check your quota
42+
43+
For the most up-to-date information about your quota, use the `get_quotas` command.
44+
```
45+
get_quotas
46+
```
47+
{:.term}
48+
49+
This will print a table with your `/home` and `/scratch` quotas. An example output is shown below.
50+
51+
```
52+
[user@spark-login ~]$ get_quotas
53+
Path Disk_Used(GB) Disk_Limit(GB) Files_Used File_Limit
54+
/home/user 6.08254 30 150372 250000
55+
/scratch/user 2.33743 100 22 250000
56+
```
57+
{:.term}
58+
59+
To print the quota for a path in `/home`, `/scratch`, and `/software` that you have access to, (i.e., a group directory), use the `-p` option:
60+
61+
```
62+
get_quotas -p <path to directory>
63+
```
64+
{:.term}
65+
66+
An example output of the `get_quotas` command with the `-p` option is shown below:
67+
68+
```
69+
[user@spark-login ~]$ get_quotas -p /software/groups/example_group
70+
Path Disk_Used(GB) Disk_Limit(GB) Files_Used File_Limit
71+
/software/groups/example_group 0.000433144 100 3 1000
72+
```
73+
{:.term}
74+
75+
## Check your Message of the Day (MOTD)
76+
77+
Your quota is also printed upon login. See below for an example:
78+
79+
```
80+
_____________________________________________________________________
81+
##### # # ####### ##### Issues? Email [email protected]
82+
# # # # # # # Unauthorized use prohibited by:
83+
# # # # # WI Statutes: s. 947.0125
84+
# ####### # # U.S. Code: 18 USC 1030
85+
# # # # # U.S. Code: 18 USC 2510-2522
86+
# # # # # # # U.S. Code: 18 USC 2701-2712
87+
##### # # # ##### U.S. Code: 18 USC § 1831
88+
For off campus ssh access use https://www.doit.wisc.edu/network/vpn/
89+
_____________________________________________________________________
90+
91+
Online office hours are available twice a week:
92+
Tuesdays, 10:30am - 12pm (Central time)
93+
Thursdays, 3:00 - 4:30pm (Central time)
94+
95+
== NOTICE: THIS NODE IS ON PUPPET ENVIRONMENT "puppet8" ==
96+
97+
Filesystem quota report (last updated 01:01 PM)
98+
Storage Used (GB) Limit (GB) Files (#) File Cap (#) Quota (%)
99+
-------------- ----------- ------------ ----------- -------------- -----------
100+
/home/user 6.08 30 150372 250000 20.28
101+
/scratch/user 2.34 100 22 250001 2.34
102+
```
103+
{:.term}
104+
105+
However, we recommend [using the `get_quotas` command](#check-your-quota) for the most up-to-date information.
106+
107+
## Check the size of a directory and its contents
108+
109+
If you want to check the size of specific directories and their contents, you can do this with the `ncdu` utility.
110+
111+
```
112+
[user@spark-login ~]$ ncdu /home/username
113+
[user@spark-login ~]$ ncdu /scratch/username
114+
```
115+
{:.term}
116+
117+
When `ncdu` has finished running, the output will give you a total file count and allow you to navigate between subdirectories for even more details. Type `q `when you're ready to exit the output viewer.
118+
119+
## What to do when you've reached your quota
120+
121+
When you've reached your quota, you may encounter error messages such as `Disk quota exceeded`. When you encounter the error message, we recommend the following steps:
122+
123+
1. Check your quota with `get_quotas`. At which data location did you reach your quota? Did you reach your disk quota or your items quota?
124+
1. If possible, remove any files you no longer need from the system.
125+
1. If you still need more disk space, [request more quota.](quota-request)
126+
127+
> ### ⚠️ CHTC is not a storage service
128+
{:.tip-header}
129+
130+
> CHTC data locations are intended for temporarily storing files used in **active calculations only**. Once you are done with the files, please remove them from the system to clear disk space.<br><br>
131+
> **We do not back up any of the data you place on our system. It is your responsibility to back up your own files.**
132+
{:.tip}
133+
134+
## Related pages
135+
136+
* [HPC System Overview](hpc-overview)

_uw-research-computing/hpc-overview.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,5 +191,4 @@ files and directories are contained in a given path:
191191

192192
When `ncdu` has finished running, the output will give you a total file
193193
count and allow you to navigate between subdirectories for even more
194-
details. Type `q` when you\'re ready to exit the output viewer. More
195-
info here: <https://lintut.com/ncdu-check-disk-usage/>
194+
details. Type `q` when you\'re ready to exit the output viewer.

0 commit comments

Comments
 (0)