Houdini 19.0 HQueue

インストール

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

On this page

始める前に

Note

このガイドは、サーバーとクライアントがどちらも同じオペレーティングシステム(Linux,MacOS,Windows)を使用していることを想定しています。 オペレーティングシステムが混在したHQueueファームをセットアップすることも可能ですが、このガイドでは説明しません。

HQueueファームをセットアップする前に、以下の項目が必須です:

ネットワーク接続

  • どのマシンもお互いにドメイン名(DNS)またはIPアドレスから“見えている”またはピングが通っていなければなりません。

  • クライアントマシンは5000ポート番号経由でサーバーマシンと接続できなければなりません。サーバーマシンは5001ポート番号経由でクライアントマシンに接続できなければなりません。ローカルのどのファイアーウォールでもそれらのポートが解放されている必要があります。

共有ネットワークフォルダ

  • サーバーとクライアントは共有ネットワークファイルシステム(例えば、SMB共有のNFSマウント)にアクセスできなければなりません。

  • 共有フォルダは、どのマシンでも同じ場所をマウントしていなければなりません。例えば、Linuxなら /nfs/storage/ 、Windowsなら \\bigdisk\hq です。

Houdini

  • すべてのクライアントマシンにはHoudiniを同じインストールディレクトリにインストールしてください。

    Mac

    MacOSでは、デフォルトのHoudiniインストールパスは /Applications/Houdini/HoudiniX.Y.ZZZ です。

    Windows

    Windowsでは、デフォルトのHoudiniインストールパスは C:/Program Files/Side Effects Software/Houdini X.Y.ZZZ です。

    Linux

    Linuxでは、デフォルトのHoudiniインストールパスは /opt/hfsX.Y.ZZZ です。

  • hythonmantraなどのライセンスを必要とする実行ファイルをクライアント側で実行できるように、各クライアントで正しくHoudiniライセンスが掴めるようにセットアップする必要があります。

HQueueのインストール方法

Setting up an HQueue farm involves installing the HQueue server, registering a network folder with HQueue and adding client machines to the farm.

Install the HQueue Server

  1. Choose a machine, say serverMachine, to run the HQueue Server.

  2. On the machine, download and run the Houdini Launcher.

  3. In the Launcher, select HQueue on the left-hand side and then click on the Install HQueue button on the right.

  4. When prompted to choose a version, select Choose Another Version.

  5. Select a version that has a py2 Build Type (i.e. Python 2) and then click Install.

    Note

    A Python 3 version of the HQueue Server is currently not available. You can submit jobs from a Houdini Python 3 build and run Houdini Python 3 in jobs on an HQueue Python 2 farm.

  6. In the HQueue Install Options dialog, check on the HQueue Server component and uncheck the HQueue Client component.

  7. Complete the installation in the Launcher.

    Mac

    On macOS, the Launcher installs the server to /Library/HQServer and creates a new com.sidefx.hqserver.plist service file in /Library/LaunchDaemons.

    Windows

    On Windows, the Launcher installs the server to C:/HQueueServer and creates a new HQueueServer service in Windows Services.

    Linux

    On Linux, the Launcher installs the server to /opt/hqueue.

  8. You can open a web browser and navigate to http://serverMachine:5000 to confirm that the HQueue server is running.

    Note

    If DNS is not configured for serverMachine then you can connect to HQueue using the server machine’s IP address.

    For example, http://X.X.X.X:5000.

Register the network folder with HQueue

  1. Open a web browser and go to the HQueue web interface. For example, http://serverMachine:5000.

  2. Hover the mouse over the “triple bars” icon in the top-right corner and then select Network Folders.

  3. In the Network Folder 1 box, set the fields that apply to the desired operating system.

    Mac

    For macOS, set the on macOS field to where the network folder is mounted on macOS machines (i.e. /Users/Shared/myShare). Leave all other fields at their default values.

    Windows

    For Windows, set the Host field to the machine name or IP address hosting the network folder. Then set the on Windows field to the network folder’s share name and finally set the Map to field to the drive letter that the network folder is mapped to on Windows machines.

    For example, suppose your network folder is served on a machine named myFileServer, its share name is myShare, and your machines map X: to \\myFileServer\myShare, then set Host to myFileServer, set on Windows to myShare and set Map to to X:.

    Leave all other fields at their default values.

    Linux

    For Linux, set the on Linux field to where the network folder is mounted on Linux machines (i.e. /mnt/myShare). Leave all other fields at their default values.

  4. Save the changes.

    Mac

    References to $HQROOT in HQueue jobs and Houdini parameters will now resolve to the value of the on macOS field on macOS machines.

    Windows

    References to $HQROOT in HQueue jobs and Houdini parameters will now resolve to either the drive letter specified by the “Map to” field or the UNC path produced by the Host and “on Windows” fields on Windows.

    Linux

    References to $HQROOT in HQueue jobs and Houdini parameters will now resolve to the value of the on Linux field on Linux machines.

Add a client machine

  1. Run the Houdini Launcher on the machine that you want to add.

  2. In the Launcher, select HQueue on the left-hand side and then click on the Install HQueue button on the right.

  3. When prompted to choose a version, select Choose Another Version.

  4. Select a version that has a py2 Build Type (i.e. Python 2) and then click Install.

    Note

    A Python 3 version of the HQueue Client is currently not available. You can submit jobs from a Houdini Python 3 build and run Houdini Python 3 in jobs on an HQueue Python 2 farm.

  5. In the HQueue Install Options dialog, check on the HQueue Client component and uncheck the HQueue Server component. Then set the HQueue Server URL field to point to your HQueue Server. For example, http://serverMachine:5000.

  6. (optional, Linux and macOS only) Change the user account that runs the HQueue Client and jobs by changing the Client User field. By default, the Launcher creates a new hquser account to run the HQueue Client.

  7. (optional) Change the HQueue Client install location by changing the Install Directory field. This is required on Linux if you also changed the user account. By default, the Launcher installs the HQueue Client into the hquser's home directory on Linux.

  8. Complete the installation in the Launcher.

    Mac

    On macOS, the Launcher installs the HQueue Client to /Library/HQClient and creates a new com.sidefx.hqclient.plist service file in /Library/LaunchDaemons.

    Windows

    On Windows, the Launcher installs the HQueue Client to C:/HQueueClient and creates a new HQueueClient service in Windows Services.

    Linux

    On Linux, the Launcher installs the HQueue Client to the client user’s home directory, $HOME/hqclient. For example, the HQueue Client is installed to /home/hquser/hqclient by default.

  9. HQueueウェブインターフェースのClientsページに進んで、そのマシンがファームに追加するのに成功したことを確認します。

Note

ファームに追加したいクライアントマシン毎に上記の手順を繰り返します。

Note

For macOS, if adding the machine failed with a “Connection Refused” error then check out this FAQ.

Note

Windowsの場合、デフォルトではHQueue Clientは汎用Windowsネットワークサービスアカウントを使って実行されます。 このアカウントは、ネットワークアクセスに制限がされているので、あなたのネットワークフォルダへのアクセスが許可されていない可能性があります。

ジョブがファイルアクセス権限の問題を引き起こさないように、HQueue Clientを実際のWindowsユーザアカウントで実行されるように変更することを推奨します。 HQueue Clientのユーザアカウントを変更するには、このFAQを参照してください。

ファームをテストする方法

HQueueファームが正しく設定されているかテストするために、単純なHoudiniレンダージョブを投入することができます。

以下にその方法を載せます:

  1. Houdiniを起動します。

  2. 単純なシーンを作成します。レンダリングするには、最低でも何かしらのジオメトリ、ライト、カメラ、Mantra ROPを配置します。

  3. /outノードネットワークに進んで、HQueue Render ROPを配置します。

  4. パラメータエディタで、Output DriverパラメータにMantra ROPを設定します。

  5. HQueue ServerパラメータにHQueueファーム(例えば、http://serverMachine:5000)を指定します。

    Note

    serverMachineにDNSが設定されていない場合は、代わりにそのURLにそのサーバーマシンのIPアドレスを入力しても構いません。 例えば、http://X.X.X.X:5000です。

  6. 次に、 Target HFS パラメータに、クライアントマシン上にインストールされているHoudiniの場所を設定します。

    Mac

    MacOSでは、 Target HFS を以下のように設定します:

    /Applications/Houdini/HoudiniX.Y.ZZZ/Frameworks/Houdini.framework/Versions/Current/Resources
    

    Windows

    Windowsでは、 Target HFS を以下のように設定します:

    C:/Program Files/Side Effects Software/Houdini X.Y.ZZZ
    

    Linux

    Linuxでは、 Target HFS を以下のように設定します:

    /opt/hfsX.Y.ZZZ
    
  7. ネットワークフォルダ内のどこかに.hipファイルを保存します。

    Mac

    MacOSでは、そのネットワークフォルダはHQueue Server設定ファイル内のhqserver.sharedNetwork.mount.macosxキーに定義されています。 例えば、.hipファイルを/Volumes/myShare/test.hipに保存します。

    Windows

    Windowsでは、そのネットワークフォルダはHQueue Server設定ファイル内のhqserver.sharedNetwork.mount.windowsキーに定義されています。 例えば、.hipファイルをX:/test.hipに保存します。

    Linux

    Linuxでは、そのネットワークフォルダはHQueue Server設定ファイル内のhqserver.sharedNetwork.mount.linuxキーに定義されています。 例えば、.hipファイルを/mnt/myShare/test.hipに保存します。

  8. パラメータエディタの上部にある Submit Job をクリックします。

    • 新しいジョブがHQueueウェブインターフェースに出現します。

    • そのジョブのID上をクリックすることで、そのジョブの中に入って詳細を確認することができます。

トラブルシューティング

ジョブが失敗した時、HQueueウェブインターフェース内でそのジョブのIDをクリックすることで、その原因を調べることができます。 これによって、そのジョブの中に入って、その詳細を確認することができます。 ジョブの子ジョブが失敗したら、その子ジョブのIDをクリックすることで、さらにその中に入ることができます。 最終的には、そのジョブの出力が入ったOutput Logフィールドを確認することになります。 この出力には、ジョブが失敗した原因を示したエラーメッセージが入っています。

よくあるジョブの失敗エラーと解決方法に関しては、トラブルシューティングのFAQsを参照してください。

Upgrading the HQueue Server

Before upgrading the HQueue Server, create backup copies of the HQueue Server database and configuratiion file.

Mac

On macOS, the HQueue Server database is located at /Library/HQServer/db/hqserver.db and the configuration file is located at /Library/HQServer/hqserver.ini.

Windows

On Windows, the HQueue Server database is located at C:/HQueueServer/db/hqserver.db and the configuration file is located at C:/HQueueServer/hqserver.ini.

Linux

On Linux, the HQueue Server database is located at /opt/hqueue/db/hqserver.db and the configuration file is located at /opt/hqueue/hqserver.ini.

To upgrade an HQueue Server previously installed by the old Houdini installers, perform a fresh HQueue Server installation with the Houdini Launcher. See Install the HQueue Server.

To upgrade an HQueue Server previously installed by the Launcher:

  1. In the Launcher, select HQueue on the left-hand side.

  2. Click on the gear icon menu button next to HQueue Server and then select Modify.

  3. In the Modifications dialog, change the Version drop-down menu to the desired version.

    Note

    Select a py2 (i.e. Python 2) version because an HQueue Server Python 3 version is currently not available.

  4. Click Modify to complete the upgrade.

Upgrading the HQueue Client

Before upgrading the HQueue Client, create a backup copy of the HQueue Client configuratiion file.

Mac

On macOS, the HQueue Client configuration file is located at /Library/HQClient/hqnode.ini.

Windows

On Windows, the HQueue Client configuration file is located at C:/HQueueClient/hqnode.ini.

Linux

On Linux, the HQueue Client configuration file is located at /home/hquser/hqclient/hqnode.ini.

To upgrade an HQueue Client previously installed by the old Houdini installers , perform a fresh HQueue Client installation with the Houdini Launcher. See Add a client machine.

To upgrade an HQueue Client previously installed by the Launcher:

  1. In the Launcher, select HQueue on the left-hand side.

  2. Click on the gear icon menu button next to HQueue Client and then select Modify.

  3. In the Modifications dialog, change the Version drop-down menu to the desired version.

    Note

    Select a py2 (i.e. Python 2) version because an HQueue Client Python 3 version is currently not available.

  4. Click Modify to complete the upgrade.

Scripted Installations

The Houdini Launcher supports scripted, or silent, installations of the HQueue Server and HQueue Client. The Houdini Launcher installation can also be scripted, see Scripting Launcher installations.

To install the HQueue Server from the command line:

Mac

Open a Terminal app and run:

cd /Applications/Houdini Launcher.app/Contents/MacOS
sudo ./houdini_installer install --product "HQueue Server" --version X.Y.ZZZ --settings-file /path/to/launcher_settings.ini --build-option py2 --accept-EULA=SideFX-20XX-XX-XX

Windows

Open a Windows command prompt and run:

cd C:/Program Files/Side Effects Software/Launcher
houdini_installer.exe install --product "HQueue Server" --version X.Y.ZZZ --settings-file C:/path/to/launcher_settings.ini --build-option py2 --accept-EULA=SideFX-20XX-XX-XX

Linux

Open a terminal and run:

cd /opt/sidefx/launcher/bin
sudo ./houdini_installer install --product "HQueue Server" --version X.Y.ZZZ --settings-file /path/to/launcher_settings.ini --build-option py2 --accept-EULA=SideFX-20XX-XX-XX

To install the HQueue Client from the command line:

Mac

Open a Terminal app and run:

cd /Applications/Houdini Launcher.app/Contents/MacOS
sudo ./houdini_installer install --product "HQueue Client" --version X.Y.ZZZ --settings-file /path/to/launcher_settings.ini --build-option py2 --accept-EULA=SideFX-20XX-XX-XX

Windows

Open a Windows command prompt and run:

cd C:/Program Files/Side Effects Software/Launcher
houdini_installer.exe install --product "HQueue Client" --version X.Y.ZZZ --settings-file C:/path/to/launcher_settings.ini --build-option py2 --accept-EULA=SideFX-20XX-XX-XX

Linux

Open a terminal and run:

cd /opt/sidefx/launcher/bin
sudo ./houdini_installer install --product "HQueue Client" --version X.Y.ZZZ --settings-file /path/to/launcher_settings.ini --build-option py2 --accept-EULA=SideFX-20XX-XX-XX

See Houdini Launcher - Scripting installations for more information on command line installations using the Houdini Launcher.

オプション: hquserアカウント

オプションで、クライアントマシン上でHQueueを実行するhquserユーザとhqgroupユーザグループをセットアップすることができます。 慣例では、そのユーザIDとそのグループのIDはどちらも601で、そのユーザのパスワードはhqpassですが、それらを変更しても構いません。

Linux

Linuxディストリビューションによっては、ユーザアカウントを作成するためのユーザインターフェースが用意されていますが、用意されていなければ、adduserコマンドを使用します。

Mac

システム環境設定の ユーザとグループ パネルで、ユーザとグループを作成することができます。

クライアント間でユーザアカウントを統一するメリットは以下のとおりです:

  • 特定のクライアントにログインする必要がある時に、別のクライアントマシンの別のユーザアカウントを気にする必要がありません。

  • クライアントソフトウェアで作成されたどのファイルも所有者が1人のユーザに統一されます。

ユーザとグループを作成したら、HQueueサーバー/クライアントをhquserとして起動してください。

HQueue

はじめよう

  • HQueueについて

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

  • インストール

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

  • 設定

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

  • ジョブを投入する方法

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

ファームの管理

  • クライアントの管理

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

  • ジョブの管理

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

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

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

  • ノート

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

  • リソース

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

  • ネットワークフォルダ

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

次のステップ

  • ログ

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

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

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

  • FAQs

    よくある質問の回答。

導師レベル

  • Remote API

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

  • ジョブの仕様の詳細

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

  • MySQLに切り替える方法(Linuxのみ)

    LinuxではSQLiteの代わりにオプションでMySQLを使用するようにHQueueを設定することができます。