Houdini 20.0 HQueue

設定

HQueueサーバーとクライアントのオプションを設定する方法。

On this page

サーバーの設定

HQueueサーバー設定ファイルは、HQueueサーバーインストールディレクトリの直下にあります。

Linux

/opt/hqueue/hqserver.ini

Mac

/Library/HQueueServer/hqserver.ini

Windows

C:/HQueueServer/hqserver.ini

そのファイル内のオプションを編集して、HQueueサーバーを再起動することで、そのHQueueサーバーの挙動を変更することができます。

Linux

Linuxのサーバーを再起動するには、以下のコマンドを実行します:

cd /opt/hqueue
sudo ./scripts/hqserverd restart

Mac

MacOSのサーバーを再起動するには、以下のコマンドを実行します:

sudo launchctl unload -F /Library/LaunchDaemons/com.sidefx.hqserver.plist
sudo launchctl load -F /Library/LaunchDaemons/com.sidefx.hqserver.plis

Windows

Windowsのサーバーを再起動するには、 コントロールパネル ▸ 管理ツール ▸ サービス でHQueueServerサービスを再起動します。

サーバー設定オプション

Tip

オプション値に%(here)s文字列を使えば、その部分がhqserver.iniファイルを含んだディレクトリのパスに置換されます。 これを使用することで、例えば、job_logs_dirオプションのようにファイル/ディレクトリパス系オプションでコンフィグファイルの場所を基準としたパスを指定することができます。

以下は、利用可能なサーバー設定オプションのリストです。これらのオプションは、コンフィグファイル内の[main]セクション下になければなりません。

オプション

説明

active_timeout

HQueueがクライアントを非アクティブで反応なしと見なすそのクライアントの最後の心拍からの経過時間(分)。 クライアントが非アクティブな時、そのクライアントはHQueueで利用不可としてマークされ、そのクライアントに現在割り当てられているすべてのジョブがAbandoned(中断)としてマークされます。

非アクティブだったクライアントがアクティブになり、再び心拍が確認されると、そのクライアントはHQueueで利用可能としてマークされ、そのクライアントがまだ実行中だったすべてのジョブがAbandoned(中断)からRunning(実行中)としてマークされます。

email_to

システムエラーや通知が発生した時にメッセージを受信する電子メールアドレス。 smtp_serverも設定する必要があります。

Note

現在のところ、HQueueの電子メール機能は、認証を必要とする電子メール設定に対応していません。

error_email_from

システムエラーが発生したり、ジョブ通知が送信されるようにスケジュールが組まれている時にメッセージを送信する電子メールアドレス。 ジョブ通知の電子メール送信に関する詳細は、HQueue RenderノードとHQueue Simulationノードの電子メールオプションを参照してください。

このオプションの効果を出すには、smtp_serverサーバーオプションも設定する必要があります。

Note

現在のところ、HQueueの電子メール機能は、認証を必要とする電子メール設定に対応していません。

expire_jobs_days

ジョブが完了してからHQueueがそのジョブをファームから永久に削除するまでの日数。 ジョブのログは削除され、ジョブの情報はサーバーデータベースから削除されます。

job_logs_dir

ジョブのログの保存先のディレクトリ。 ディレクトリパス内に%(here)sを使用することで、HQueueサーバーインストール先のルートディレクトリを参照することができます。

max_fails_allowed

1台のクライアントが同じルートジョブ下のジョブの実行に失敗するのを許容するジョブの最大数で、この回数だけ失敗すると、HQueueは、そのクライアントがルートジョブ下の他のジョブを実行できないという条件をそのルートジョブに追加します。 例えば、max_fails_allowedが3で、machineAがMy Jobルートジョブ下の3個の子ジョブに失敗した場合、 HQueueは、My Jobに対して、machineAがMy Job下のどの子ジョブも実行できないという条件を追加します。

max_fails_allowedにはプラスの整数値を設定してください。 ゼロの値を設定すると、HQueueが特定のクライントをジョブの実行対象から排除しなくなります。

port

HQueueサーバーがListenするポート番号。 HQueueクライアントは、このポート番号でサーバーに接続し、HQueueウェブサイトはこのポート番号でサーバーが立ち上げられます。

scheduling_algorithm

HQueueジョブスケジューラは、アルゴリズムに従って、次に利用可能なクライアントをどのジョブに割り当てるのか決定します。指定可能な値はsharecpuとfifoです。

sharecpu - (デフォルト) スケジューラは、クライアントCPUリソースがキュー内のすべてのジョブに対してほぼ均一に分布するようにクライアントを割り当てます。

fifo - スケジューラは、古いジョブ投入時刻を優先してクライアントをキュー内のジョブに割り当てます。

smtp_server

システムエラーが発生したり、ジョブ通知が送信されるようにスケジュールが組まれている時にメッセージを配達する電子メールサーバー。 ジョブ通知の電子メール送信に関する詳細は、HQueue RenderノードとHQueue Simulationノードの電子メールオプションを参照してください。

Note

現在のところ、HQueueの電子メール機能は、認証を必要とする電子メール設定に対応していません。

upgrade_priority

クライアントをアップグレードするシステム系ジョブのジョブ優先度。 アップグレードを要するクライアントは、HQueueウェブインターフェースのClientsウェブページにはNEEDS UPGRADEとマークされます。

以下は、サーバーログ設定オプションのリストです。これらのオプションは、コンフィグファイル内の[logging]セクション下になければなりません。

オプション

説明

file

サーバーログファイルの場所。 ディレクトリパス内に%(here)sを使用することで、HQueueサーバーインストール先のルートディレクトリを参照することができます。 stdoutまたはstderrを使用すれば、ファイルの代わりにログ出力をそれぞれ標準出力または標準エラーのストリームにリダイレクトすることができます。

level

HQueueサーバーログのメッセージの詳細度。HQueueは以下のログレベルに対応しています:

  • DEBUG: デバッグ用途のローレベルなシステム情報。

  • INFO: (デフォルト) 一般的なシステム情報。

  • WARNING: 小さな問題が発生したことを示した情報。

  • ERROR: 大きな問題が発生したことを示した情報。

  • CRITICAL: 緊急を要する不具合が発生したことを示した情報。致命的な不具合が発生した場合、サーバーはシャットダウンした方が良いです。

max_file_size

ログファイルは、この最大ファイルサイズ(MB)に到達するとバックアップファイルに移されます。 バックアップログファイルは、アクティブログファイルと同じディレクトリ内に作成されます。

max_backup_files

ディスク上に残すバックアップファイルの数。 この最大数を超えると、最も古いバックアップファイルが削除されます。

以下は、サーバーのwaitress設定オプションのリストです。 waitressは、入力のネットワークコネクションを制御するウェブサーバーコンポーネントです。 waitress設定オプションは、コンフィグファイル内の[waitress]セクション下になければなりません。

オプション

説明

ignore_logging

1に設定すると、waitressから報告されたログメッセージはHQueueサーバーログファイルに出力されなくなります。 1以外の値に設定すると、waitressから報告されたログメッセージはHQueueサーバーログファイルに出力されます。 デフォルト値は0です。

threads

アプリケーションロジックを処理するためにwaitressによって開始されるスレッドの数。 HQueueサーバーログファイルに“Task queue depth”という警告が頻繁に出ていれば、waitressで作成されるスレッドの数を増やすことを検討してください。 デフォルト値は4です。

クライアント設定

HQueueクライアント設定ファイルは、HQueueクライアントのインストールディレクトリの直下にあります。

Linux

/home/hquser/hqclient/hqnode.ini

Mac

/Library/HQueueClient/hqnode.ini

Windows

C:/HQueueClient/hqnode.ini

そのファイル内のオプションを編集して、HQueueクライアントを再起動することで、そのHQueueクライアントの挙動を変更することができます。

Linux: Linuxのクライアントを再起動するには、以下のコマンドを実行します

cd /home/hquser/hqclient
./hqclientd restart

Mac: Mac OSのクライアントを再起動するには、以下のコマンドを実行します

sudo launchctl unload -F /Library/LaunchDaemons/com.sidefx.hqclient.plist
sudo launchctl load -F /Library/LaunchDaemons/com.sidefx.hqclient.plist

Windows: Windowsのクライアントを再起動するには、 Windowsスタートメニュー ▸ タスク スケジューラ に進みます。 タスク スケジューラから、HQueueClientタスクを探し、そのタスクをクリックして 終了 を選択します。 次に、再度そのタスクをクリックして 実行する を選択します。

Windowsのクライアントを再起動する別の方法として、 コマンド プロンプト を 管理者として実行 で開き、そこで以下のコマンドを実行します:

cd C:\HQueueClient
hqclientd.bat restart

他にも、Windows ファイル エクスプローラー を開き、C:\HQueueClientに進んで、hqclientd.batファイルをダブルクリックすることでWindowsのクライアントを再起動することができます。

クライアント設定オプション

以下は、利用可能なクライアント設定オプションのリストです。これらのオプションは、コンフィグファイル内の[main]セクション下になければなりません。

オプション

説明

auto_upgrade

(オプション) アップグレードが利用可能な場合に、クライアントを起動時に自動的にアップグレードさせるかどうかを制御します。 このオプションを0に設定すると自動アップグレードが無効になります。 1(デフォルト)に設定すると自動アップグレードが有効になります。

cpus

(オプション) クライアントがジョブを実行する時に利用可能なCPUの数。 このオプションを指定しなかった場合、オペレーティングシステムで報告されているCPUの数がクライアントで利用可能です。

name

クライアントの名前の指定は、同じマシン上に複数のクライアントを実行する予定がある場合にのみ必要です。 同じマシン上で実行するクライアントの名前は固有な名前にしてください。

port

HQueueサーバーがListenするポート番号。 このオプションは、serverオプションと併せて動作します。 クライアントは、serverとportのオプションを使用してHQueueサーバーの場所を特定して接続します。

server

クライアントの接続先となるHQueueサーバーのマシンの名前またはIPアドレス。 このオプションは、serverオプションと併せて動作します。 クライアントは、serverとportのオプションを使用してHQueueサーバーの場所を特定して接続します。

sharedNetwork.mount

(廃止) クライアント上のHQROOT共有ネットワークフォルダのマウントポイント。

ジョブ環境変数

クライアント設定ファイル内にはジョブ環境変数を指定することができます。 これらのジョブ環境変数は、クライアント上で実行されるすべてのジョブの環境内に定義されます。 ジョブ環境変数は、クライアント設定ファイル内の[job_environment]セクション下に必ず設定してください。

Note

ネットワークフォルダ設定をローカルに上書きするジョブ環境変数を設定することができます。 例えば、[job_environment]セクション下にHQROOT = /path/to/hqrootを追加すると、クライアントで実行されるジョブのHQROOTネットワークフォルダが/path/to/hqrootにマップされます。

マップされたネットワークドライブ(Windowsのみ)

Windowsクライアントの場合、[mapped_network_drives]セクションを追加することで、そのクライアントがジョブを実行する際にアクセスする必要のあるネットワークドライブのすべてのマッピングをリストすることができます。 HQueueクライアントは、クライアント起動前に必ずそのリストされたネットワークドライブをマッピングします。

以下は、hqnode.ini設定ファイル内の[mapped_network_drives]セクションの例です:

[mapped_network_drives]
H = \\myServer\sharename
P = \\myProjectServer\projectname

上記の例では、HQueueクライアントは、クライアント起動前にH:ドライブを\\myServer\sharenameに、P:ドライブを\\myProjectServer\projectnameにマッピングしてからジョブを実行します。

ネットワークフォルダ設定

ネットワークフォルダは、HQueueサーバー上の設定ファイル内で定義します。

Linux

/opt/hqueue/network_folders.ini

Mac

/Library/HQueueServer/network_folders.ini

Windows

C:/HQueueServer/network_folders.ini

ネットワークフォルダは、HQueueウェブサイトから、または、network_folders.ini設定ファイルを直接編集してHQueueサーバーを再起動することで管理することができます。

Linux

Linuxのサーバーを再起動するには、以下のコマンドを実行します:

cd /opt/hqueue
sudo ./scripts/hqserverd restart

Mac

MacOSのサーバーを再起動するには、以下のコマンドを実行します:

sudo launchctl unload -F /Library/LaunchDaemons/com.sidefx.hqserver.plist
sudo launchctl load -F /Library/LaunchDaemons/com.sidefx.hqserver.plis

Windows

Windowsのサーバーを再起動するには、 コントロールパネル ▸ 管理ツール ▸ サービス でHQueueServerサービスを再起動します。

ネットワークフォルダ設定セクション

ネットワークフォルダをHQueueに登録するには、network_folders.ini設定ファイルに新しくセクションを作成します。 セクション名は、英数字とアンダースコアのみで構成してください。 このセクション名がジョブの環境変数名になります。その環境変数がネットワークフォルダのパスに評価します。

複数のネットワークフォルダをHQueueに登録することができます。

Note

HQueueでは HQROOT ネットワークフォルダの設定が必須です。 HQROOTは、Houdini内のHQueue Render ROPやHQueue Simulation ROPなどのいくつかの場所で参照されます。

HQROOTの登録がない場合、HQueueサーバー起動時にHQROOTが作成されます。

以下は、Linuxファーム用の単純なネットワーク構成の例です:

[HQROOT]
linux = /mnt/hq

[PROJECT_PATH]
linux = /mnt/project

この構成では、2つのネットワークフォルダ(HQROOTとPROJECT_PATH)を登録しています。 Linuxマシンで実行されるジョブには$HQROOTと$PROJECT_PATHの環境変数が作成されます。 $HQROOTと$PROJECT_PATHの環境変数は、ジョブ内でそれぞれ/mnt/hq、/mnt/projectに評価します。

ネットワークフォルダ設定オプション

以下は、ネットワークフォルダセクション下に追加することができるネットワークフォルダ設定オプションのリストです。 ジョブの投入元のワークステーム上のオペレーティングシステムを含むファーム上であなたが使用するオペレーティングシステム(s)用のオプションだけを設定すれば良いです。

オプション

説明

linux

Linuxマシン上で追加されるネットワークフォルダのマウントポイントパス。

macos

Mac OSマシン上で追加されるネットワークフォルダのマウントポイントパス。

windows

Windowsマシン上のネットワークフォルダに接続されるマップドライブレター。他にも、このオプションにネットワークフォルダのUNCパスを設定することができます。

linux_host_path ( 廃止, 下位互換用 )

ネットワークフォルダのホストサーバーとパス。 このオプションは、Linuxマシン上にマウントポイントを作成するようにHQueueに要求する際に使用されていました。

macos_host_path ( 廃止, 下位互換用 )

ネットワークフォルダのホストサーバーとパス。 このオプションは、Mac OSマシン上にマウントポイントを作成するようにHQueueに要求する際に使用されていました。

windows_host_path ( 廃止, 下位互換用 )

UNCパスの形式のネットワークフォルダのサーバーとパス。 このオプションは、Windowsクライアントマシン上のネットワークフォルダパスを解決する際にHQueueで使用されていました。

これを指定した場合、このオプションはwindowsオプションよりも優先度が高いので、Windowsクライアントはこのオプションの値の方を使用してネットワークフォルダのパスを解決します。

以下は、WindowsマシンとMac OSマシンで構成されたファーム用のネットワークフォルダ構成の例です:

[HQROOT]
macos = /Users/Shared/HQShared
windows = H:

[JOB_FILES]
macos = /Users/Shared/job_files
windows = //server_storage/job_files

HQueue

はじめよう

  • HQueueについて

    HQueueは多目的なジョブスケジューリングシステムです。このシステムを利用することで、レンダリング、シミュレーション、他の処理をリモートクライアント上に分散させることができます。

  • インストール

    基本的なHQueueファームのセットアップ方法。

  • 設定

    HQueueサーバーとクライアントのオプションを設定する方法。

  • ジョブを投入する方法

    ファーム上にワークを配置する方法。

ファームの管理

  • ジョブの管理

    ファーム上のジョブを閲覧/管理する方法。

  • クライアントの管理

    ウェブインターフェースまたはローカルログインを使って、クライアントマシンを追加/削除/再起動/管理する方法。

  • クライアントグループの管理

    ウェブインターフェースまたはローカルログインを使って、クライアントマシンのグループを作成/管理する方法。

  • ネットワークフォルダ

    Network Folder管理ページの使い方。

  • リソース

    各クライアントで利用可能なリソース(例えば、ライセンス)を指定することができるので、そのジョブを実行可能なクライアントに対してそのジョブのスケジュールを組むことができます。

  • ノート

    各クライアントとジョブには、情報を記載したノートを添付することができます。

次のステップ

  • ログ

    HQueueサーバーはサーバーエラーとスケジュールイベントのログを別々に記録し、各クライアントもログを生成します。

  • アンインストールする方法

    HQueueサーバーまたはクライアントのソフトウェアをアンインストールする方法。

  • FAQs

    よくある質問の回答。

導師レベル

  • Remote API

    ネットワーク上のHQueueサーバーに接続して関数をコールすることで、ジョブや他の情報を制御したり照会することができます。

  • ジョブの仕様の詳細

    独自のジョブを投入したいユーザ向けに、ジョブの内部仕様に関する詳細を載せています。

  • 複数クライアント、単一マシン

    単一マシン上で複数のHQueueクライアントを走らせる方法を説明したガイド。