Workload Characterization Key (WCKey) Management

A WCKey is an orthogonal way to do accounting against possibly unrelated accounts.
WCKeyは、おそらく無関係なアカウントに対してアカウンティングを行うための直交する方法です。
This can be useful where users from different accounts are all working on the same project.
これは、異なるアカウントのユーザーがすべて同じプロジェクトで作業している場合に役立ちます。

slurm(dbd).conf settings

Including "WCKey" in your AccountingStorageEnforce option in your slurm.conf file will enforce WCKeys per job.
slurm.confファイルのAccountingStorageEnforceオプションに「WCKey」を含めると、ジョブごとにWCKeyが適用されます。
This means only jobs with valid WCKeys (WCKeys previously added through sacctmgr) will be allowed to run.
これは、有効なWCKey（以前にsacctmgrを介して追加されたWCKey）を持つジョブのみが実行を許可されることを意味します。

If you wish to track the value of a jobs WCKey you must set the TrackWCKey option in both the slurm.conf as well as the slurmdbd.conf files.
ジョブのWCKeyの値を追跡する場合は、slurm.confファイルとslurmdbd.confファイルの両方でTrackWCKeyオプションを設定する必要があります。
This will assure the WCKey is tracked on each job.
これにより、WCKeyが各ジョブで確実に追跡されます。
If you set "WCKey" in your AccountingStorageEnforce line TrackWCKey is set automatically, it still needs to be added to your slurmdbd.conf file though.
AccountingStorageEnforce行で「WCKey」を設定した場合、TrackWCKeyは自動的に設定されますが、それでもslurmdbd.confファイルに追加する必要があります。

sbatch/salloc/srun

Each submitting tool has the --wckey= option that can set the WCKey for a job.
各送信ツールには、ジョブのWCKeyを設定できる--wckey =オプションがあります。
[SBATCH|SALLOC|SLURM]_WCKEY can also be set in the environment to set the WCKey.
[SBATCH | SALLOC | SLURM] _WCKEYを環境に設定して、WCKeyを設定することもできます。
If no WCKey is given the WCKey for the job will be set to the users default WCKey for the cluster, which can be set up with sacctmgr.
WCKeyが指定されていない場合、ジョブのWCKeyは、クラスターのユーザーのデフォルトWCKeyに設定されます。これは、sacctmgrで設定できます。
Also if no WCKey is specified the accounting record is appended with a '*' to signify the WCKey was not specified.
また、WCKeyが指定されていない場合は、WCKeyが指定されていないことを示すためにアカウンティングレコードに「*」が追加されます。
This is useful for a manager to determine if a user is specifying their WCKey or not.
これは、管理者がユーザーがWCKeyを指定しているかどうかを判断するのに役立ちます。

sacct

Sacct can be used to view the WCKey by adding "wckey" to the --format option.
--formatオプションに「wckey」を追加することにより、Sacctを使用してWCKeyを表示できます。
You can also single out jobs by using the --wckeys= option which would only send information about jobs that ran with specific WCKeys.
--wckeys =オプションを使用してジョブを選択することもできます。このオプションは、特定のWCKeyで実行されたジョブに関する情報のみを送信します。

sacctmgr

Sacctmgr is used to manage WCKeys.
Sacctmgrは、WCKeyを管理するために使用されます。
You can add and remove WCKeys from users or list them.
WCKeyをユーザーに追加したり、ユーザーから削除したり、リストしたりできます。

You add a user to a WCKey much like you do an account, only the WCKey doesn't need to be created before hand. i.e.
アカウントを作成するのと同じように、ユーザーをWCKeyに追加します。事前に作成する必要があるのは、WCKeyだけです。すなわち。

sacctmgr add user da wckey=secret_project

You can remove them from a WCKey in the same fashion.
同じ方法でWCKeyからそれらを削除できます。

sacctmgr del user da wckey=secret_project

To alter the users default WCKey you can run a line like
ユーザーのデフォルトのWCKeyを変更するには、次のような行を実行できます。

sacctmgr mod user da cluster=snowflake set defaultwckey=secret_project

Which will change the default WCKey for user "da" on cluster "snowflake" to be "secret_project".
これにより、クラスター「snowflake」のユーザー「da」のデフォルトのWCKeyが「secret_project」に変更されます。
If you want this for all clusters just remove the cluster= option.
すべてのクラスターでこれが必要な場合は、cluster =オプションを削除してください。

sreport

Information about reports available for WCKeys can be found on the sreport manpage.
WCKeysで利用可能なレポートに関する情報は、sreportのマンページにあります。

Last modified 14 November 2014