cgroup.conf

Section: Slurm Configuration File (5)
Updated: Slurm Configuration File
Index

 

NAME

cgroup.conf - Slurm configuration file for the cgroup support

 

DESCRIPTION

cgroup.conf is an ASCII file which defines parameters used by Slurm's Linux cgroup related plugins. The file location can be modified at system build time using the DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF environment variable. The file will always be located in the same directory as the slurm.conf file.
cgroup.confは、SlurmのLinux cgroup関連プラグインで使用されるパラメータを定義するASCIIファイルです。ファイルの場所は、システム構築時にDEFAULT_SLURM_CONFパラメータを使用して変更するか、実行時にSLURM_CONF環境変数を設定して変更できます。ファイルは常にslurm.confファイルと同じディレクトリにあります。

Parameter names are case insensitive. Any text following a "#" in the configuration file is treated as a comment through the end of that line. Changes to the configuration file take effect upon restart of Slurm daemons, daemon receipt of the SIGHUP signal, or execution of the command "scontrol reconfigure" unless otherwise noted.
パラメータ名は大文字と小文字を区別しません。構成ファイルで「#」に続くテキストは、その行の終わりまでコメントとして扱われます。特に明記されていない限り、構成ファイルへの変更は、Slurmデーモンの再起動、SIGHUPシグナルのデーモン受信、またはコマンド「scontrol reconfigure」の実行時に有効になります。

For general Slurm Cgroups information, see the Cgroups Guide at <https://slurm.schedmd.com/cgroups.html>.
Slurm Cgroupsの一般的な情報については、次のCgroups Guideを参照してください。 。

The following cgroup.conf parameters are defined to control the general behavior of Slurm cgroup plugins.
次のcgroup.confパラメータは、Slurm cgroupプラグインの一般的な動作を制御するために定義されています。

CgroupAutomount=<yes|no>
Slurm cgroup plugins require valid and functional cgroup subsystem to be mounted under /sys/fs/cgroup/<subsystem_name>. When launched, plugins check their subsystem availability. If not available, the plugin launch fails unless CgroupAutomount is set to yes. In that case, the plugin will first try to mount the required subsystems.
Slurm cgroupプラグインは、/ sys / fs / cgroup /の下にマウントされる有効で機能的なcgroupサブシステムを必要とします。起動すると、プラグインはサブシステムの可用性を確認します。使用できない場合、CgroupAutomountがyesに設定されていないと、プラグインの起動は失敗します。その場合、プラグインは最初に必要なサブシステムをマウントしようとします。

CgroupMountpoint=PATH
Specify the PATH under which cgroups should be mounted. This should be a writable directory which will contain cgroups mounted one per subsystem. The default PATH is /sys/fs/cgroup.
cgroupをマウントする必要があるPATHを指定します。これは、サブシステムごとに1つマウントされたcgroupを含む書き込み可能なディレクトリである必要があります。デフォルトのPATHは/ sys / fs / cgroupです。

 

TASK/CGROUP PLUGIN

The following cgroup.conf parameters are defined to control the behavior of this particular plugin:
次のcgroup.confパラメータは、この特定のプラグインの動作を制御するために定義されています。

AllowedKmemSpace=<number>
Constrain the job cgroup kernel memory to this amount of the allocated memory, specified in bytes. The AllowedKmemSpace must be between the upper and lower memory limits, specified by MaxKmemPercent and MinKmemSpace, respectively. If AllowedKmemSpace goes beyond the upper or lower limit, it will be reset to that upper or lower limit, whichever has been exceeded.
ジョブのcgroupカーネルメモリを、バイト単位で指定されたこの割り当てられたメモリ量に制限します。AllowedKmemSpaceは、MaxKmemPercentとMinKmemSpaceでそれぞれ指定されているメモリの上限と下限の間にある必要があります。AllowedKmemSpaceが上限または下限を超えると、上限または下限のどちらか大きい方にリセットされます。

AllowedRAMSpace=<number>
Constrain the job/step cgroup RAM to this percentage of the allocated memory. The percentage supplied may be expressed as floating point number, e.g. 101.5. Sets the cgroup soft memory limit at the allocated memory size and then sets the job/step hard memory limit at the (AllowedRAMSpace/100) * allocated memory. If the job/step exceeds the hard limit, then it might trigger Out Of Memory (OOM) events (including oom-kill) which will be logged to kernel log ringbuffer (dmesg in Linux). Setting AllowedRAMSpace above 100 may cause system Out of Memory (OOM) events as it allows job/step to allocate more memory than configured to the nodes. Reducing configured node available memory to avoid system OOM events is suggested. Setting AllowedRAMSpace below 100 will result in jobs receiving less memory than allocated and soft memory limit will set to the same value as the hard limit. Also see ConstrainRAMSpace. The default value is 100.
ジョブ/ステップのcgroup RAMを、割り当てられたメモリのこの割合に制限します。供給されるパーセンテージは、浮動小数点数、たとえば101.5として表すことができます。cgroupのソフトメモリ制限を割り当てられたメモリサイズに設定し、ジョブ/ステップのハードメモリ制限を(AllowedRAMSpace / 100)*割り当てられたメモリに設定します。ジョブ/ステップがハード制限を超えると、カーネルログリングバッファ(Linuxではdmesg)に記録されるメモリ不足(OOM)イベント(oom-killを含む)がトリガーされる可能性があります。AllowedRAMSpaceを100より大きい値に設定すると、ジョブ/ステップがノードに構成されているよりも多くのメモリを割り当てることができるため、システムのメモリ不足(OOM)イベントが発生する可能性があります。システムOOMイベントを回避するために、構成済みノードの使用可能なメモリを減らすことをお勧めします。AllowedRAMSpaceを100未満に設定すると、ジョブは割り当てられたメモリよりも少ないメモリを受け取り、ソフトメモリ制限はハード制限と同じ値に設定されます。ConstrainRAMSpaceも参照してください。デフォルト値は100です。

AllowedSwapSpace=<number>
Constrain the job cgroup swap space to this percentage of the allocated memory. The default value is 0, which means that RAM+Swap will be limited to AllowedRAMSpace. The supplied percentage may be expressed as a floating point number, e.g. 50.5. If the limit is exceeded, the job steps will be killed and a warning message will be written to standard error. Also see ConstrainSwapSpace. NOTE: Setting AllowedSwapSpace to 0 does not restrict the Linux kernel from using swap space. To control how the kernel uses swap space, see MemorySwappiness.
ジョブのcgroupスワップスペースを、割り当てられたメモリのこの割合に制限します。デフォルト値は0です。これは、RAM +スワップがAllowedRAMSpaceに制限されることを意味します。指定されたパーセンテージは、浮動小数点数、たとえば50.5として表すことができます。制限を超えると、ジョブステップが中止され、警告メッセージが標準エラーに書き込まれます。ConstrainSwapSpaceも参照してください。注:AllowedSwapSpaceを0に設定しても、Linuxカーネルによるスワップ領域の使用は制限されません。カーネルがスワップスペースを使用する方法を制御するには、MemorySwappinessを参照してください。

ConstrainCores=<yes|no>
If configured to "yes" then constrain allowed cores to the subset of allocated resources. This functionality makes use of the cpuset subsystem. Due to a bug fixed in version 1.11.5 of HWLOC, the task/affinity plugin may be required in addition to task/cgroup for this to function properly. The default value is "no".
「はい」に設定されている場合、許可されたコアを割り当てられたリソースのサブセットに制限します。この機能は、cpusetサブシステムを利用します。HWLOCのバージョン1.11.5で修正されたバグのため、これが正しく機能するには、task / cgroupに加えてtask / affinityプラグインが必要になる場合があります。デフォルト値は「いいえ」です。

ConstrainDevices=<yes|no>
If configured to "yes" then constrain the job's allowed devices based on GRES allocated resources. It uses the devices subsystem for that. The default value is "no".
「はい」に設定されている場合、GRES割り当てリソースに基づいて、ジョブの許可されたデバイスを制限します。そのためにデバイスサブシステムを使用します。デフォルト値は「いいえ」です。

ConstrainKmemSpace=<yes|no>
If configured to "yes" then constrain the job's Kmem RAM usage in addition to RAM usage. Only takes effect if ConstrainRAMSpace is set to "yes". The default value is "no". If set to yes, the job's Kmem limit will be set to AllowedKmemSpace if set; otherwise, the job's Kmem limit will be set to its RAM limit. Also see AllowedKmemSpace.
「はい」に設定されている場合は、RAM使用量に加えて、ジョブのKmem RAM使用量を制限します。ConstrainRAMSpaceが "yes"に設定されている場合にのみ有効です。デフォルト値は「いいえ」です。yesに設定すると、ジョブのKmem制限が設定されている場合はAllowedKmemSpaceに設定されます。それ以外の場合、ジョブのKmem制限はRAM制限に設定されます。AllowedKmemSpaceもご覧ください。

ConstrainRAMSpace=<yes|no>
If configured to "yes" then constrain the job's RAM usage by setting the memory soft limit to the allocated memory and the hard limit to the allocated memory * AllowedRAMSpace. The default value is "no", in which case the job's RAM limit will be set to its swap space limit if ConstrainSwapSpace is set to "yes". Also see AllowedSwapSpace, AllowedRAMSpace and ConstrainSwapSpace. NOTE: When enabled, ConstrainRAMSpace can lead to a noticeable decline in per-node job throughout. Sites with high-throughput requirements should carefully weigh the tradeoff between per-node throughput, versus potential problems that can arise from unconstrained memory usage on the node. See <https://slurm.schedmd.com/high_throughput.html> for further discussion.
「はい」に設定されている場合は、メモリのソフト制限を割り当てられたメモリに、ハード制限を割り当てられたメモリに* AllowedRAMSpaceに設定することにより、ジョブのRAM使用を制限します。デフォルト値は "no"です。この場合、ConstrainSwapSpaceが "yes"に設定されている場合、ジョブのRAM制限はスワップスペース制限に設定されます。AllowedSwapSpace、AllowedRAMSpace、およびConstrainSwapSpaceも参照してください。注:有効になっている場合、ConstrainRAMSpaceにより、ノードごとのジョブが全体的に著しく低下する可能性があります。高スループット要件のあるサイトでは、ノードごとのスループットと、ノードでの無制限のメモリ使用から発生する可能性がある潜在的な問題との間のトレードオフを慎重に比較検討する必要があります。見る さらなる議論のために。

ConstrainSwapSpace=<yes|no>
If configured to "yes" then constrain the job's swap space usage. The default value is "no". Note that when set to "yes" and ConstrainRAMSpace is set to "no", AllowedRAMSpace is automatically set to 100% in order to limit the RAM+Swap amount to 100% of job's requirement plus the percent of allowed swap space. This amount is thus set to both RAM and RAM+Swap limits. This means that in that particular case, ConstrainRAMSpace is automatically enabled with the same limit than the one used to constrain swap space. Also see AllowedSwapSpace.
「はい」に設定されている場合、ジョブのスワップ領域の使用を制限します。デフォルト値は「いいえ」です。「yes」に設定し、ConstrainRAMSpaceを「no」に設定すると、RAM + Swapの量をジョブの要件の100%と許可されたスワップスペースのパーセントに制限するために、AllowedRAMSpaceが自動的に100%に設定されることに注意してください。したがって、この量はRAMとRAM +スワップの両方の制限に設定されます。つまり、その特定のケースでは、ConstrainRAMSpaceは、スワップスペースを制限するために使用される制限と同じ制限で自動的に有効になります。AllowedSwapSpaceも参照してください。

MaxRAMPercent=PERCENT
Set an upper bound in percent of total RAM on the RAM constraint for a job. This will be the memory constraint applied to jobs that are not explicitly allocated memory by Slurm (i.e. Slurm's select plugin is not configured to manage memory allocations). The PERCENT may be an arbitrary floating point number. The default value is 100.
ジョブのRAM制約に合計RAMの上限をパーセントで設定します。これは、Slurmによってメモリが明示的に割り当てられていないジョブに適用されるメモリ制約になります(つまり、Slurmの選択プラグインはメモリ割り当てを管理するように構成されていません)。PERCENTは、任意の浮動小数点数にすることができます。デフォルト値は100です。

MaxSwapPercent=PERCENT
Set an upper bound (in percent of total RAM) on the amount of RAM+Swap that may be used for a job. This will be the swap limit applied to jobs on systems where memory is not being explicitly allocated to job. The PERCENT may be an arbitrary floating point number between 0 and 100. The default value is 100.
ジョブに使用できるRAM +スワップの量に上限(合計RAMのパーセント)を設定します。これは、メモリがジョブに明示的に割り当てられていないシステム上のジョブに適用されるスワップ制限です。PERCENTは、0〜100の任意の浮動小数点数にすることができます。デフォルト値は100です。

MaxKmemPercent=PERCENT
Set an upper bound in percent of total Kmem for a job. The PERCENT may be an arbitrary floating point number. The default value is 100.
ジョブの合計Kmemの上限をパーセントで設定します。PERCENTは、任意の浮動小数点数にすることができます。デフォルト値は100です。

MemorySwappiness=<number>
Configure the kernel's priority for swapping out anonymous pages (such as program data) verses file cache pages for the job cgroup. Valid values are between 0 and 100, inclusive. A value of 0 prevents the kernel from swapping out program data. A value of 100 gives equal priorioty to swapping out file cache or anonymous pages. If not set, then the kernel's default swappiness value will be used. Either ConstrainRAMSpace or ConstrainSwapSpace must be set to yes in order for this parameter to be applied.
匿名ページ(プログラムデータなど)とジョブcgroupのファイルキャッシュページをスワップアウトするためのカーネルの優先度を構成します。有効な値は0〜100です。値0は、カーネルがプログラムデータをスワップアウトしないようにします。値100は、ファイルキャッシュまたは匿名ページのスワップアウトに同じ優先度を与えます。設定されていない場合、カーネルのデフォルトのswappiness値が使用されます。このパラメーターを適用するには、ConstrainRAMSpaceまたはConstrainSwapSpaceをyesに設定する必要があります。

MinKmemSpace=<number>
Set a lower bound (in MB) on the memory limits defined by AllowedKmemSpace. The default limit is 30M.
AllowedKmemSpaceで定義されたメモリ制限の下限(MB)を設定します。デフォルトの制限は30Mです。

MinRAMSpace=<number>
Set a lower bound (in MB) on the memory limits defined by AllowedRAMSpace and AllowedSwapSpace. This prevents accidentally creating a memory cgroup with such a low limit that slurmstepd is immediately killed due to lack of RAM. The default limit is 30M.
AllowedRAMSpaceとAllowedSwapSpaceで定義されたメモリ制限の下限(MB)を設定します。これにより、RAMが不足しているためにslurmstepdがすぐに終了するような低い制限で誤ってメモリcgroupを作成するのを防ぎます。デフォルトの制限は30Mです。

TaskAffinity=<yes|no>
If configured to "yes" then set a default task affinity to bind each step task to a subset of the allocated cores using sched_setaffinity. The default value is "no". Note: This feature requires the Portable Hardware Locality (hwloc) library to be installed.
「はい」に設定されている場合、デフォルトのタスクアフィニティを設定して、sched_setaffinityを使用して、各ステップタスクを割り当てられたコアのサブセットにバインドします。デフォルト値は「いいえ」です。注:この機能を使用するには、ポータブルハードウェアローカリティ(hwloc)ライブラリがインストールされている必要があります。

 

DISTRIBUTION-SPECIFIC NOTES

Debian and derivatives (e.g. Ubuntu) usually exclude the memory and memsw (swap) cgroups by default. To include them, add the following parameters to the kernel command line: cgroup_enable=memory swapaccount=1
Debianと派生物(Ubuntuなど)は通常、デフォルトでメモリとmemsw(スワップ)cgroupを除外します。それらを含めるには、次のパラメーターをカーネルコマンドラインに追加します。cgroup_enable = memory swapaccount = 1

This can usually be placed in /etc/default/grub inside the GRUB_CMDLINE_LINUX variable. A command such as update-grub must be run after updating the file.
これは通常、GRUB_CMDLINE_LINUX変数内の/ etc / default / grubに配置できます。ファイルを更新した後、update-grubなどのコマンドを実行する必要があります。

 

EXAMPLE


###
# Slurm cgroup support configuration file
###
CgroupAutomount=yes
ConstrainCores=yes
#

 

COPYING

Copyright (C) 2010-2012 Lawrence Livermore National Security. Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
Copyright (C) 2010-2016 SchedMD LLC.

This file is part of Slurm, a resource management program. For details, see <https://slurm.schedmd.com/>.

Slurm is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Slurm is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

 

SEE ALSO

slurm.conf(5)


 

Index

NAME
DESCRIPTION
TASK/CGROUP PLUGIN
DISTRIBUTION-SPECIFIC NOTES
EXAMPLE
COPYING
SEE ALSO

This document was created by man2html using the manual pages.
Time: 22:00:05 GMT, April 09, 2020