On this page | |
Since | 17.5 |
-
このスケジューラは、Tractorで管理されたファーム上のワークアイテムを実行します。
-
Tractorクライアントがローカルマシン上にインストールしてセットアップされている必要があります。Pythonスクリプトが含まれている
site-packages
インストールディレクトリをPYTHONPATH
環境変数で指定してください。
Windows
C:\Program Files\Pixar\Tractor-2.3\lib\python2.7\Lib\site-packages
Mac
/Applications/Pixar/Tractor-2.3/...
Linux
/opt/pixar/Tractor-2.3/lib/python2.7/Lib/site-packages
クックモード
このスケジューラは、2種類のクックモードで動作させることができます。 通常のクックモードは、TOP UIのメニューまたはボタンのどれかから Cook を選択した時に使用されます。 これは、Tractorエンジンに接続して、ワークアイテムの実行の準備が整った時にそのワークアイテムのジョブを作成します。 次に、それらのジョブがステータスを変更させて投入マシンと通信します。 つまり、ジョブを投入するHoudiniセッションは、クック中に 必ず 開いたままでなければなりません。
別のクックモードとして、 Submit Graph As Job のボタンを使用することで、TOPネットワーク全体をスタンドアローンジョブとしてクックすることができます。
このモードでは、ジョブを投入するHoudiniセッションは、TOPネットワークのクックから切り離されます。
必要に応じて.hip
ファイルがコピーされ、通常ではHython Taskは、そのTOPネットワークのデフォルトスケジューラを使ってTOPネットワークを実行します。
このモードだと、現行Houdiniセッションの更新内容も反映 されなくなります 。
このモードを使用した時のジョブの進捗をチェックしたいのであれば、Tractorウェブポータルを使用する必要があります。
ネットワーク要件
クックの一部として、メッセージキュー(MQ)ジョブが投入されます。 このジョブは、実行中のジョブから投入マシンに情報を返すために使用されます。 このため、ファームマシンは、他のファームマシンのホスト名を解決できる必要があります。
Tip
これは、/etc/hosts
(Linux / MacOS)またはC:\Windows\System32\Drivers\etc\hosts
(Windows)を編集することと同じくらい簡単です。
さらに、ファームマシン間にファイアーウォールを設定 しない ようにするか、または、 Task Callback Port パラメータを使って、使用する開放ポートを指定する必要があります。
クックが開始されると、ジョブ投入マシンは、MQジョブを実行しているファームマシンに接続するので、そのジョブ投入マシンとファームマシン間にファイアーウォールを設定しないようにするか、または、 Relay Port パラメータを使って開放ポートを指定する必要があります。
Enable Server
有効にすると、ファーム上でクックするTOPジョブ用のデータレイヤーサーバーが有効になります。 これによって、PilotPDGまたは他のWebSocketクライアントは、クック中のジョブにリモートで接続して、PDGの状態を閲覧することができます。
Server Port
データレイヤーサーバーに使用するサーバーポートを決めます。
このパラメータは、 Enable Server が 有効 な時にのみ利用可能です。
Automatic
データレイヤーサーバーに使用するTCPの空きポートがこのノードによって選択されます。
Custom
データレイヤーサーバーに使用するTCPのカスタムポートをユーザ側で指定します。
これは、ファームマシンと監視マシン間にファイアーウォールが挟まれている時に役立ちます。
Auto Connect
有効にすると、このスケジューラはジョブが開始した時にコマンドを送信してリモートビジュアライザの作成を試みます。 成功すると、リモートグラフが作成され、ジョブを実行中のサーバーに自動的に接続します。 ジョブを投入するクライアントがそのジョブを実行するサーバー側で 必ず見えていないと 、接続が失敗します。
このパラメータは、 Enable Server が 有効 な時にのみ利用可能です。
When Finished
Determines what to do when the TOP Cook finishes. This allows the TOP Cook job to continue running after the graph cook completes so that it can be inspected by a wrangler using a Data Layer viewer. For example, with When Finished you can retry a failed work item without restarting its whole job.
Terminate
ジョブを通常通りに終了します。
Keep Open If Error
エラーが検知された場合にのみジョブの実行を続けます。そのジョブを手動でKillする必要があります。
Keep Open
ジョブの実行を続けます。そのジョブを手動でKillする必要があります。
Block on Failed Work Items
When on, if there are any failed work items on the scheduler, then the cook is blocked from completing and the PDG graph cook is prevented from ending. This allows you to manually retry your failed work items. You can cancel the scheduler’s cook when it is blocked by failed work items by pressing the ESC key, clicking the Cancels the current cook button in the TOP tasks bar, or by using the cancel API method.
Load Item Data From
このスケジューラで処理されるジョブがワークアイテムのアトリビュートとデータを読み込む方法を決めます。
Temporary JSON File
The scheduler writes out a .json
file for each work item to the PDG temporary file directory. This option is selected by default.
RPC Message
The scheduler’s running work items request attributes and data over RPC. If the scheduler is a farm scheduler, then the job scripts running on the farm will also request item data from the submitter when creating their out-of-process work item objects.
This parameter option removes the need to write data files to disk and is useful when your local and remote machines do not share a file system.
Compress Work Item Data
有効にすると、PDGはワークアイテムの.json
ファイルをディスクに書き出す時にそれらのファイルを圧縮します。
This parameter is only available when Load Item Data From is set to Temporary JSON File.
認証
Tractorにワークを投入するアーティストは、ログイン情報をPDGに渡す必要があります。 $TRACTOR_USERと$TRACTOR_PASSWORDの環境変数が存在すれば、Tractor APIはそれらの環境変数を使って認証を行ないます。 Job Owner パラメータはジョブの所有者を設定します。 しかし、$PDG_TRACTOR_USER環境変数が存在すれば、その所有者はその環境変数で上書きされます。 Submit Graph As Job ワークフローを使用する際にPDGは実際にTOP Cookジョブを実行するブレードからTractor APIにログインする必要があるので、この環境変数が役立ちます。 その場合には、Tractorクライアント環境で$PDG_TRACTOR_USERを設定してください。 Tractor Password パラメータは、暗号化されないので、デバッグする時にのみ使用し、HIPファイルには決して保存しないでください。
TOP Attributes
|
integer |
スケジューラがワークアイテムをTractorに投入する時、TractorのJob IDとTask IDを追跡できるように、このアトリビュートをそのワークアイテムに追加します。
1番目のエレメントがJob |
パラメータ
Schedulers
以下のパラメータは、このスケジューラを使ったすべてのワークアイテムのグローバルパラメータです。
Tractor Server
Tractorサーバーのアドレスを指定します。
Port
Tractorサーバーのポート番号を指定します。
Tractor User
Tractorサーバーログインのユーザ名を指定します。
このユーザには、ジョブの投入とそのジョブステータスの照会をする権限がなければなりません。
これは$PDG_TRACTOR_USER
を使ってオーバーライドすることができます。
Tractor Password
Tractorサーバーログインのパスワードを指定します。
これは便宜的にあるだけです。 HIPファイルが保存された時に、そのパスワードは暗号化されずにHIPファイルと一緒に保存されます。
別の方法として、Houdini環境変数の$TRACTOR_PASSWORD
を設定した方が良いです。
詳細は、環境変数の設定方法を参照してください。
Block on Failed Work Items
When on, if there are any failed work items on the scheduler, then the cook is blocked from completing and the PDG graph cook is prevented from ending. This allows you to manually retry your failed work items. You can cancel the scheduler’s cook when it is blocked by failed work items by pressing the ESC key, clicking the Cancels the current cook button in the TOP tasks bar, or by using the cancel API method.
Working Directory
ワークが中間ファイルや出力を生成する場所となる相対ディレクトリを指定します。
中間ファイルはサブディレクトリ下に配置されます。
ローカルスケジューラまたはHQueueスケジューラに関しては、通常では$HIP
を使用します。
他のスケジューラに関しては、ここには、Local Shared Root Path
やRemote Shared Root Path
の相対ディレクトリを指定してください。
そのパスは、それらのルートパスに追加されます。
Load Item Data From
このスケジューラで処理されるジョブがワークアイテムのアトリビュートとデータを読み込む方法を決めます。
Temporary JSON File
The scheduler writes out a .json
file for each work item to the PDG temporary file directory. This option is selected by default.
RPC Message
The scheduler’s running work items request attributes and data over RPC. If the scheduler is a farm scheduler, then the job scripts running on the farm will also request item data from the submitter when creating their out-of-process work item objects.
This parameter option removes the need to write data files to disk and is useful when your local and remote machines do not share a file system.
Compress Work Item Data
有効にすると、PDGはワークアイテムの.json
ファイルをディスクに書き出す時にそれらのファイルを圧縮します。
This parameter is only available when Load Item Data From is set to Temporary JSON File.
Python Executable
ファームマシン上のPython実行ファイルのフルパスを指定します。 これは、PDGワークアイテムのジョブラッパースクリプトを実行する際に使用されます。
Path Mapping
Global
PDG Path Mapが存在すれば、それがファイルパスに適用されます。
None
PDG_DIR
トークンを使ってパスを非ローカル化します。
Path Map Zone
有効にすると、このスケジューラで実行されるすべてのジョブに適用する独自マップゾーンを指定します。
無効な時、そのローカルプラットフォームはLINUX
、MAC
、WIN
のどれかです。
Validate Outputs When Recooking
When on, PDG validates the output files of the scheduler’s cooked work items when the graph is recooked to see if the files still exist on disk. Work items that are missing output files are then automatically dirtied and cooked again. If any work items are dirtied by parameter changes, then their cache files are also automatically invalidated. Validate Outputs When Recooking is on by default.
Check Expected Outputs on Disk
When on, PDG looks for any unexpected outputs (for example, like outputs that can result from custom output handling internal logic) that were not explicitly reported when the scheduler’s work items finished cooking. This check occurs immediately after the scheduler marks work items as cooked, and expected outputs that were reported normally are not checked. If PDG finds any files that are different from the expected outputs, then they are automatically added as real output files.
NFS
NFSゾーン内のファームマシンのHoudiniインストールディレクトリのパスを指定します。
UNC (Windows)
UNCゾーン内のファームマシンのHoudiniインストールディレクトリのパスを指定します。
Append PID
有効にすると、 Location パラメータで指定した場所にサブディレクトリを追加します。このサブディレクトリ名はHoudiniセッションのPID(プロセス識別子)の値です。 この値は典型的には3から5桁の数値です。
これは、複数のHoudiniセッションが同時にTOPグラフをクックする場合に必要になります。
Custom
カスタム一時ディレクトリのフルパス。 これは、ジョブを実行するすべてのブレードからアクセスできる必要があります。
Job Spec
Job Owner
ジョブの所有者のユーザ名を指定します。
Job Title
投入されたクックのトップレベルのジョブのタイトルを指定します。
Job Priority
クックジョブの優先度を指定します。
Tier
有効なサイトワイドのTierのリストを指定します。各Tierは特定のグローバルジョブ優先度とスケジューリング規則を表します。
Projects
このジョブのプロジェクト所属の名前を指定します。
Max Active Tasks
有効にすると、PDGクックジョブが並列で実行できるタスクの最大数を設定することができます。
After Jobs
ジョブの処理を開始できるように完了している必要があるジョブを指定します。 単一ジョブIDを指定したり、スペース区切りのリストで複数のジョブIDを指定することもできます。 一度スプールされると、このパラメータの設定で、指定されたジョブが完了するまでジョブの処理の開始を遅らせます。
Verbose Logging
有効にすると、バインドされているスケジューラからの詳細なメッセージがコンソールにプリントされます。
Use Session File
有効にすると、Tractor APIは1つのHoudiniセッション内でローカルユーザを何回も認証する必要がないように一時ファイルを生成します。
このファイルは$TEMP/.pdgtractor.{user}.{host}.session
として生成されます。
Submit As Job
Submit
TOP Network全体をスタンドアローンジョブとしてクックし、投入されたジョブのステータスURIを表示します。
デフォルトでは、投入されたジョブはTractorログインを使用し、$PDG_TRACTOR_USER
と$TRACTOR_PASSWORD
のジョブ環境変数を設定します。
それらの環境変数が存在しなかった場合、 Tractor User と Tractor Password のパラメータ値が使用されます。
Job Title
投入するジョブのタイトルを指定します。
Output Node
クックするノードのパスを指定します。 ノードを指定しなかった場合、このスケジューラを含んだネットワーク内のディスプレイノードが代わりにクックされます。
Job Service Keys
ファーム上のTOPグラフを実行するジョブのTractor Service Key表現を指定します。
TOPグラフの実行には別でタスクが必要になるものの、メモリやCPUを あまり消費しない ので、これには非力なスロットを使用すると良いでしょう。
Enable Server
有効にすると、ファーム上でクックするTOPジョブ用のデータレイヤーサーバーが有効になります。 これによって、PilotPDGまたは他のWebSocketクライアントは、クック中のジョブにリモートで接続して、PDGの状態を閲覧することができます。
Server Port
データレイヤーサーバーに使用するサーバーポートを決めます。
このパラメータは、 Enable Server が 有効 な時にのみ利用可能です。
Automatic
データレイヤーサーバーに使用するTCPの空きポートがこのノードによって選択されます。
Custom
データレイヤーサーバーに使用するTCPのカスタムポートをユーザ側で指定します。
これは、ファームマシンと監視マシン間にファイアーウォールが挟まれている時に役立ちます。
Auto Connect
有効にすると、このスケジューラはジョブが開始した時にコマンドを送信してリモートビジュアライザの作成を試みます。 成功すると、リモートグラフが作成され、ジョブを実行中のサーバーに自動的に接続します。 ジョブを投入するクライアントがそのジョブを実行するサーバー側で 必ず見えていないと 、接続が失敗します。
このパラメータは、 Enable Server が 有効 な時にのみ利用可能です。
When Finished
Determines what to do when the TOP Cook finishes. This allows the TOP Cook job to continue running after the graph cook completes so that it can be inspected by a wrangler using a Data Layer viewer. For example, with When Finished you can retry a failed work item without restarting its whole job.
Terminate
ジョブを通常通りに終了します。
Keep Open If Error
エラーが検知された場合にのみジョブの実行を続けます。そのジョブを手動でKillする必要があります。
Keep Open
ジョブの実行を続けます。そのジョブを手動でKillする必要があります。
Message Queue
Service Keys
Message Queue Serverを実行するタスクのTractor Service Key表現を指定します。
Message Queueの実行には別でタスクが必要になるものの、メモリやCPUを あまり消費しない ので、これには非力なスロットを使用すると良いでしょう。
Submit Graph As Job でTOPグラフをクックする場合、Message Queueタスクは生成されないことに注意してください。
Task Callback Port
有効にすると、Message Queue ServerのJobコールバックAPIで使用するTCP Portを設定することができます。 このポートはファームクライアント間でアクセスできなければなりません。
Relay Port
有効にすると、PDGとMessage Queue Commandを実行しているクライアントとの間のMessage Queue Server接続で使用するTCP Portを設定することができます。 このポートは、PDG/ユーザマシンからファームクライアントに到達できなければなりません。
Job Parms
以下のジョブ特有のパラメータは、投入されたすべてのジョブに影響を与えますが、各ノードによって上書きすることができます。 Scheduler Job Parms / Propertiesを参照してください。
Service Key Expression
ジョブサービスキーエクスプレッションを指定します。これは、このジョブの実行に対応しているブレードのタイプを指定する際に使用されます。
At Least Slots
このコマンドを実行するためにTractorブレードで必須の最低限の空きスロット数を設定します。
At Most Slots
有効な場合、このコマンドを実行する時に使用する最大の空きスロット数。 明示的に設定しない限りは、これが Houdini Max Threads のデフォルト値として使用されます。
Houdini Max Threads
有効にすると、HOUDINI_MAXTHREADS
環境変数に値を設定することができます。
デフォルトのHOUDINI_MAXTHREADS
は、 At Most Slots が有効になっていればその値が設定されます。
デフォルトの0は、利用可能なプロセッサすべてを使用することを意味します。
プラスの値は、利用可能なスレッド数を制限します。 1の値は、完全にマルチスレッド処理を無効にします(1スレッドのみに制限)。 プラスの値は、利用可能なCPUコア数で制限されます。
マイナスの値を指定すると、最大プロセッサ数からその値が引かれて、スレッド数が決定されます。 例えば、-1の値は全CPUコア数から1を引いたCPUコア数が使用されます。
Env Keys
Bladeプロファイルで定義された環境キーをスペースで区切ったリストを指定します。
Task Title
カスタムのTask Name接頭辞を指定します。 デフォルトでは、呼応するワークアイテム名が使用されます。 この名前の接尾辞は、PDGが簿記するのに内部的に使用する値です。
Maximum Run Time
タスクの最大時間制限(秒)を指定します。 最大時間制限を超えて実行されたタスクはKillされます。 デフォルト値の0は無制限を意味します。
Post Success Wait
成功したジョブを終了させる前に待機する秒数を指定します。 これは、PDGが依存関係のある高い優先度のジョブをスプールする前にTractorが即座にブレードへの再割り当てをしないようにします。
Metadata
タスク定義に追加する任意の文字列を指定します。
Preview Launch
Tractor UIから外部アプリケーションを実行する起動エクスプレッションを指定します。 これによって、外部アプリケーションを使用して、進行中のクックの結果を確認することができます。
Tip
TOPsは独自の内部ビューアレジストリを持っています。
Handle By
コマンドが失敗した(ゼロ以外のExitコードを返した)時の挙動をカスタマイズします。
Reporting Error
ワークアイテムが失敗します。
Reporting Warning
ワークアイテムが成功し、警告がノードに追加されます。
Retrying Task
Retries の回数だけTractorによってワークアイテムを再試行します。
Ignoring Exit Code
ワークアイテムが成功します。
Handle All Non Zero
無効にすると、特定のexitコードを指定することができます。
Exit Code
Handle By を使って制御したいexitコードを指定します。 ゼロ以外のすべてのexitコードは、通常では失敗として扱われます。
このパラメータは、 Handle All Non Zero が無効になっている時にのみ利用可能です。
Retries
コマンドが失敗した時にそのジョブを再試行する回数。
このパラメータは、 Handle By が Retrying Task に設定されている時にのみ利用可能です。
Pre Shell
コマンド実行前に実行/ソース化したいシェルスクリプトを指定します。
Post Shell
コマンド実行後に実行/ソース化したいシェルスクリプトを指定します。
Pre Python
コマンドプロセスを分岐させる前にラッパースクリプトで実行したいPythonスクリプトを指定します。
Post Python
コマンドプロセスが抜けた後にラッパースクリプトで実行したいPythonスクリプトを指定します。
Inherit Local Environment
有効にすると、PDGの現行セッション内の環境変数がジョブの環境変数にコピーされます。
Unset Variables
タスク環境でUnsetしたい環境変数をスペースで区切ったリスト。
Environment Environment
各タスクのカスタムキー値環境変数を追加することができるマルチパラメータ。
See also |