<primary>Quotas</primary>
<secondary>configuring</secondary>
</indexterm>Working with Quotas</title>
- <para>Quotas allow a system administrator to limit the amount of disk space
- a user or group can use. Quotas are set by root, and can be specified for
- individual users and/or groups. Before a file is written to a partition
- where quotas are set, the quota of the creator's group is checked. If a
- quota exists, then the file size counts towards the group's quota. If no
- quota exists, then the owner's user quota is checked before the file is
- written. Similarly, inode usage for specific functions can be controlled if
- a user over-uses the allocated space.</para>
+ <para>Quotas allow a system administrator to limit the amount of disk
+ space a user, group, or project can use. Quotas are set by root, and can
+ be specified for individual users, groups, and/or projects. Before a file
+ is written to a partition where quotas are set, the quota of the creator's
+ group is checked. If a quota exists, then the file size counts towards
+ the group's quota. If no quota exists, then the owner's user quota is
+ checked before the file is written. Similarly, inode usage for specific
+ functions can be controlled if a user over-uses the allocated space.</para>
<para>Lustre quota enforcement differs from standard Linux quota
enforcement in several ways:</para>
<itemizedlist>
this, it is necessary to begin enabling quotas by enabling quotas on the
back-end disk system. Because quota setup is dependent on the Lustre
software version in use, you may first need to run
- <literal>lfs get_param version</literal> to identify
+ <literal>lctl get_param version</literal> to identify
<xref linkend="whichversion"/> you are currently using.
</para>
<section>
<title>Enabling Disk Quotas (Lustre Software Release 2.4 and
later)</title>
<para>Quota setup is orchestrated by the MGS and <emphasis>all setup
- commands in this section must be run on the MGS</emphasis>. Once setup,
- verification of the quota state must be performed on the MDT. Although
- quota enforcement is managed by the Lustre software, each OSD
- implementation relies on the back-end file system to maintain
- per-user/group block and inode usage. Hence, differences exist
- when setting up quotas with ldiskfs or ZFS back-ends:</para>
+ commands in this section must be run on the MGS and project quotas need
+ lustre Relase 2.10 and later</emphasis>. Once setup, verification of the
+ quota state must be performed on the MDT. Although quota enforcement is
+ managed by the Lustre software, each OSD implementation relies on the
+ back-end file system to maintain per-user/group/project block and inode
+ usage. Hence, differences exist when setting up quotas with ldiskfs or
+ ZFS back-ends:</para>
<itemizedlist>
<listitem>
<para>For ldiskfs backends,
<literal>mkfs.lustre</literal> now creates empty quota files and
enables the QUOTA feature flag in the superblock which turns quota
accounting on at mount time automatically. e2fsck was also modified
- to fix the quota files when the QUOTA feature flag is present.</para>
+ to fix the quota files when the QUOTA feature flag is present. The
+ project quota feature is disabled by default, and
+ <literal>tune2fs</literal> needs to be run to enable every target
+ manually.</para>
</listitem>
<listitem>
- <para>For ZFS backend, accounting ZAPs are created and maintained by
- the ZFS file system itself. While ZFS tracks per-user and group block
- usage, it does not handle inode accounting. The ZFS OSD implements
- its own support for inode tracking. Two options are available:</para>
+ <para>For ZFS backend, <emphasis>the project quota feature is not
+ supported yet.</emphasis> Accounting ZAPs are created and maintained
+ by the ZFS file system itself. While ZFS tracks per-user and group
+ block usage, it does not handle inode accounting for ZFS versions
+ prior to zfs-0.7.0. The ZFS OSD implements its own support for inode
+ tracking. Two options are available:</para>
<orderedlist>
<listitem>
<para>The ZFS OSD can estimate the number of inodes in-use based
can be enabled by running the following command on the server
running the target:
<literal>lctl set_param
- osd-zfs.${FSNAME}-${TARGETNAME}.quota_iused_estimate=1</literal>.</para>
+ osd-zfs.${FSNAME}-${TARGETNAME}.quota_iused_estimate=1</literal>.
+ </para>
</listitem>
<listitem>
<para>Similarly to block accounting, dedicated ZAPs are also
<literal>tunefs.lustre --quota</literal> is run against all targets. This
command sets the QUOTA feature flag in the superblock and runs e2fsck (as
a result, the target must be offline) to build the per-UID/GID disk usage
- database. See <xref linkend="quota_interoperability"/> for further
- important considerations.</para>
+ database.</para>
+ <para condition="l2A">Lustre filesystems formatted with a Lustre release
+ prior to 2.10 can be still safely upgraded to release 2.10, but will not
+ have project quota usage reporting functional until
+ <literal>tune2fs -O project</literal> is run against all ldiskfs backend
+ targets. This command sets the PROJECT feature flag in the superblock and
+ runs e2fsck (as a result, the target must be offline). See
+ <xref linkend="quota_interoperability"/> for further important
+ considerations.</para>
</note>
<caution>
<para>Lustre software release 2.4 and later requires a version of
- e2fsprogs that supports quota (i.e. newer or equal to 1.42.3.wc1) to be
- installed on the server nodes using ldiskfs backend (e2fsprogs is not
- needed with ZFS backend). In general, we recommend to use the latest
- e2fsprogs version available on
- <link xl:href="http://downloads.hpdd.intel.com/e2fsprogs/">
- http://downloads.hpdd.intel.com/public/e2fsprogs/</link>.</para>
+ e2fsprogs that supports quota (i.e. newer or equal to 1.42.13.wc5,
+ 1.42.13.wc6 or newer is needed for project quota support) to be
+ installed on the server nodes using ldiskfs backend (e2fsprogs is not
+ needed with ZFS backend). In general, we recommend to use the latest
+ e2fsprogs version available on
+ <link xl:href="http://downloads.whamcloud.com/e2fsprogs/">
+ http://downloads.whamcloud.com/public/e2fsprogs/</link>.</para>
<para>The ldiskfs OSD relies on the standard Linux quota to maintain
accounting information on disk. As a consequence, the Linux kernel
running on the Lustre servers using ldiskfs backend must have
<literal>lctl conf_param</literal> on the MGS via the following
syntax:</para>
<screen>
-lctl conf_param <replaceable>fsname</replaceable>.quota.<replaceable>ost|mdt</replaceable>=<replaceable>u|g|ug|none</replaceable>
+lctl conf_param <replaceable>fsname</replaceable>.quota.<replaceable>ost|mdt</replaceable>=<replaceable>u|g|p|ugp|none</replaceable>
</screen>
<itemizedlist>
<listitem>
</listitem>
<listitem>
<para>
- <literal>ug</literal> -- to enable quota enforcement for both users
- and groups</para>
+ <literal>p</literal> -- to enable quota enforcement for projects
+ only</para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>ugp</literal> -- to enable quota enforcement for all users,
+ groups and projects</para>
</listitem>
<listitem>
<para>
- <literal>none</literal> -- to disable quota enforcement for both users
- and groups</para>
+ <literal>none</literal> -- to disable quota enforcement for all users,
+ groups and projects</para>
</listitem>
</itemizedlist>
<para>Examples:</para>
- <para>To turn on user and group quotas for block only on file system
+ <para>To turn on user, group, and project quotas for block only on
+ file system
<literal>testfs1</literal>, <emphasis>on the MGS</emphasis> run:</para>
- <screen>$ lctl conf_param testfs1.quota.ost=ug
+ <screen>$ lctl conf_param testfs1.quota.ost=ugp
</screen>
<para>To turn on group quotas for inodes on file system
<literal>testfs2</literal>, on the MGS run:</para>
<screen>$ lctl conf_param testfs2.quota.mdt=g
</screen>
- <para>To turn off user and group quotas for both inode and block on file
- system
+ <para>To turn off user, group, and project quotas for both inode and block
+ on file system
<literal>testfs3</literal>, on the MGS run:</para>
<screen>$ lctl conf_param testfs3.quota.ost=none
</screen>
<secondary>creating</secondary>
</indexterm>Quota Administration</title>
<para>Once the file system is up and running, quota limits on blocks
- and inodes can be set for both user and group. This is <emphasis>
- controlled entirely from a client</emphasis> via three quota
+ and inodes can be set for user, group, and project. This is <emphasis>
+ controlled entirely from a client</emphasis> via three quota
parameters:</para>
<para>
<emphasis role="bold">Grace period</emphasis>-- The period of time (in
seconds) within which users are allowed to exceed their soft limit. There
- are four types of grace periods:</para>
+ are six types of grace periods:</para>
<itemizedlist>
<listitem>
<para>user block soft limit</para>
<listitem>
<para>group inode soft limit</para>
</listitem>
+ <listitem>
+ <para>project block soft limit</para>
+ </listitem>
+ <listitem>
+ <para>project inode soft limit</para>
+ </listitem>
</itemizedlist>
<para>The grace period applies to all users. The user block soft limit is
for all users who are using a blocks quota.</para>
<para>
<emphasis role="bold">Soft limit</emphasis> -- The grace timer is started
- once the soft limit is exceeded. At this point, the user/group can still
- allocate block/inode. When the grace time expires and if the user is still
- above the soft limit, the soft limit becomes a hard limit and the
- user/group can't allocate any new block/inode any more. The user/group
- should then delete files to be under the soft limit. The soft limit MUST be
- smaller than the hard limit. If the soft limit is not needed, it should be
- set to zero (0).</para>
+ once the soft limit is exceeded. At this point, the user/group/project
+ can still allocate block/inode. When the grace time expires and if the
+ user is still above the soft limit, the soft limit becomes a hard limit
+ and the user/group/project can't allocate any new block/inode any more.
+ The user/group/project should then delete files to be under the soft limit.
+ The soft limit MUST be smaller than the hard limit. If the soft limit is
+ not needed, it should be set to zero (0).</para>
<para>
<emphasis role="bold">Hard limit</emphasis> -- Block or inode allocation
will fail with
one can exceed the soft limit within the grace period if under the hard
limit.</para>
<para>Due to the distributed nature of a Lustre file system and the need to
- mainain performance under load, those quota parameters may not be 100%
+ maintain performance under load, those quota parameters may not be 100%
accurate. The quota settings can be manipulated via the
<literal>lfs</literal> command, executed on a client, and includes several
options to work with quotas:</para>
</itemizedlist>
<para>Usage:</para>
<screen>
-lfs quota [-q] [-v] [-h] [-o obd_uuid] [-u|-g <replaceable>uname|uid|gname|gid</replaceable>] <replaceable>/mount_point</replaceable>
-lfs quota -t <replaceable>-u|-g</replaceable> <replaceable>/mount_point</replaceable>
-lfs setquota <replaceable>-u|--user|-g|--group</replaceable> <replaceable>username|groupname</replaceable> [-b <replaceable>block-softlimit</replaceable>] \
+lfs quota [-q] [-v] [-h] [-o obd_uuid] [-u|-g|-p <replaceable>uname|uid|gname|gid|projid</replaceable>] <replaceable>/mount_point</replaceable>
+lfs quota -t {-u|-g|-p} <replaceable>/mount_point</replaceable>
+lfs setquota {-u|--user|-g|--group|-p|--project} <replaceable>username|groupname</replaceable> [-b <replaceable>block-softlimit</replaceable>] \
[-B <replaceable>block_hardlimit</replaceable>] [-i <replaceable>inode_softlimit</replaceable>] \
[-I <replaceable>inode_hardlimit</replaceable>] <replaceable>/mount_point</replaceable>
</screen>
<screen>
$ lfs quota -u bob -v /mnt/testfs
</screen>
+ <para>To display general quota information for a specific project ("
+ <literal>1</literal>" in this example), run:</para>
+ <screen>
+$ lfs quota -p 1 /mnt/testfs
+</screen>
<para>To display general quota information for a specific group ("
<literal>eng</literal>" in this example), run:</para>
<screen>
$ lfs quota -g eng /mnt/testfs
</screen>
+ <para>To limit quota usage for a specific project ID on a specific
+ directory ("<literal>/mnt/testfs/dir</literal>" in this example), run:</para>
+ <screen>
+$ chattr +P /mnt/testfs/dir
+$ chattr -p 1 /mnt/testfs/dir
+$ lfs setquota -p 1 -b 307200 -B 309200 -i 10000 -I 11000 /mnt/testfs
+</screen>
+ <para>Please note that if it is desired to have
+ <literal>lfs quota -p</literal> show the space/inode usage under the
+ directory properly (much faster than <literal>du</literal>), then the
+ user/admin needs to use different project IDs for different directories.
+ </para>
<para>To display block and inode grace times for user quotas, run:</para>
<screen>
$ lfs quota -t -u /mnt/testfs
</screen>
<para>Global quota limits are stored in dedicated index files (there is one
such index per quota type) on the quota master target (aka QMT). The QMT
- runs on MDT0000 and exports the global indexes via /proc. The global
- indexes can thus be dumped via the following command:
+ runs on MDT0000 and exports the global indices via <replaceable>lctl
+ get_param</replaceable>. The global indices can thus be dumped via the
+ following command:
<screen>
# lctl get_param qmt.testfs-QMT0000.*.glb-*
</screen>The format of global indexes depends on the OSD type. The ldiskfs OSD
modified. This glimpse callback includes information about the identifier
subject to the change. If the global index on the QMT is modified while a
slave is disconnected, the index version is used to determine whether the
- slave copy of the global index isn't uptodate any more. If so, the slave
+ slave copy of the global index isn't up to date any more. If so, the slave
fetches the whole index again and updates the local copy. The slave copy of
- the global index is also exported via /proc and can be accessed via the
- following command:
+ the global index can also be accessed via the following command:
<screen>
lctl get_param osd-*.*.quota_slave.limit*
</screen></para>
may experience unnecessary failures. The file system block quota is divided
up among the OSTs within the file system. Each OST requests an allocation
which is increased up to the quota limit. The quota allocation is then
- <emphasis role="italic">quantized</emphasis>to reduce the number of
+ <emphasis role="italic">quantized</emphasis> to reduce the number of
quota-related request traffic.</para>
<para>The Lustre quota system distributes quotas from the Quota Master
Target (aka QMT). Only one QMT instance is supported for now and only runs
responsible for releasing quota space above the new qunit value. The qunit
size isn't shrunk indefinitely and there is a minimal value of 1MB for
blocks and 1,024 for inodes. This means that the quota space rebalancing
- process will stop when this mininum value is reached. As a result, quota
+ process will stop when this minimum value is reached. As a result, quota
exceeded can be returned while many slaves still have 1MB or 1,024 inodes
of spare quota space.</para>
<para>If we look at the
<literal>lctl get_param *.*.filestotal</literal>). For more information on
using the
<literal>lfs df -i</literal> command and the command output, see
- <xref linkend="dbdoclet.50438209_35838" />.</para>
+ <xref linkend="dbdoclet.checking_free_space" />.</para>
<para>Unfortunately, the
<literal>statfs</literal> interface does not report the free inode count
directly, but instead reports the total inode and used inode counts. The
<secondary>Interoperability</secondary>
</indexterm>Quotas and Version Interoperability</title>
<para>The new quota protocol introduced in Lustre software release 2.4.0
- <emphasis role="bold">is not compatible</emphasis>with previous
+ <emphasis role="bold">is not compatible</emphasis> with previous
versions. As a consequence,
<emphasis role="bold">all Lustre servers must be upgraded to release 2.4.0
for quota to be functional</emphasis>. Quota limits set on the Lustre file
<literal>tunefs.lustre --quota</literal> against all targets. It is worth
noting that running
<literal>tunefs.lustre --quota</literal> is
- <emphasis role="bold">mandatory</emphasis>for all targets formatted with a
+ <emphasis role="bold">mandatory</emphasis> for all targets formatted with a
Lustre software release older than release 2.4.0, otherwise quota
enforcement as well as accounting won't be functional.</para>
<para>Besides, the quota protocol in release 2.4 takes for granted that the
<para>Release 2.1 clients newer or equal to release 2.1.4</para>
</listitem>
</itemizedlist>
+ <para condition="l2A">To use the project quota functionality introduced in
+ Lustre 2.10, <emphasis role="bold">all Lustre servers and clients must be
+ upgraded to Lustre release 2.10 or later for project quota to work
+ correctly</emphasis>. Otherwise, project quota will be inaccessible on
+ clients and not be accounted for on OSTs.</para>
</section>
<section xml:id="granted_cache_and_quota_limits">
<title>
git://git.whamcloud.com / doc / manual.git / blobdiff