Omniverse Farm Agent and Farm Queue Configuration¶
Omniverse Farm Queue is responsible for receiving and collecting tasks from users and distributing those tasks to computers which are configured as Farm Agents.
Omniverse Farm Agents are responsible for executing a set of tasks based on the capabilities of the configured environment. Available Farm Agents query the Farm Queue for submitted tasks and processes them in the order they were received.
Designing your Omniverse Farm Infrastructure¶
The diagram below shows an example configuration of Omniverse Farm Infrastructure which includes a single Farm Queue with multiple Farm Agents.
Multiple Farm Queues with dedicated Farm Agents is supported, however a Farm Agent cannot be joined to multiple Farm Queues simultaneously.
To install and configure Omniverse Farm Queue and Agent(s) properly, the following requirements must be met:
Host Operating System can be Microsoft Windows or Linux.
Disable the local firewall on the host to allow full connectivity. Both Microsoft Windows and many Linux distributions enable the local firewall (ufw, iptables, etc.) by default.
The Omniverse Launcher must be installed on the computer which will be assigned as the Omniverse Farm Queue and Agents.
Installing the Omniverse Farm Queue¶
Omniverse Farm Queue is found within the Omniverse Launcher by navigating to the Exchange option on the menu, then selecting Farm Queue from the Apps section of the sidebar on the left. The software is installed by clicking “Install” within the interface.
Once the software is installed, click “Launch” to open the interface and start the service.
Settings for configuring the Omniverse Farm Queue¶
Queue URL and port - This is the IP Address and port that you will provide to the Farm Agents connecting to this Queue.
Open Dashboard - This launches the Farm Management interface in your web browser which can be used to track tasks/jobs and see the status of the connected Agents.
Open Docs - This launches a web browser and displays the latest Omniverse Farm documentation. Quit Queue - Closes the Farm Queue which will prevent the Agents from executing new tasks/jobs.
Installing the Omniverse Farm Agent¶
Omniverse Farm Agent is found within the Omniverse Launcher by navigating to the Exchange option on the menu, then selecting Farm Agent from the Apps section of the sidebar on the left. The software is installed by clicking “Install” within the interface.
Once the software is installed, click “Launch” to open the interface.
Settings for configuring the Omniverse Farm Agent¶
Queue address - This is the IP Address and port of the Farm Queue. Once entered, click “Test connection” to ensure that the Agent can reach the Queue without issue.
If the Queue can be reached, the following message will be displayed:
Once the success message is displayed, click “Connect” which will link this Agent to the Queue so that it can begin to process tasks/jobs.
Once connected, the Agent interface will display the following status:
The connected Agents will also appear in the Farm Queue Dashboard:
Configure jobs - If you have a need to customize any jobs, click “Configure or edit job definitions”. (For most configurations, keep the defaults.) Job check-in timeout (in seconds) - This is set to 3600 seconds (1 hour) by default. Job directories - This can be customized to a different path if there are requirements for larger storage or IOPS. (This is highly dependent on the capabilities of the Agent.)
If any changes are made, click “Apply settings” to save them.
If connections to your Omniverse Farm environment are failing, telnet to the port on the destination computer from the source computer. By default, telnet is not enabled within Windows and is sometimes not installed on Linux distributions.
If a “connection refused” or similar message is displayed, check the following:
Ensure that the service is running and that you have not customized the port that the service is using.
Ensure that the service is bound to the correct IP Address within the configuration.
Ensure that there is not a local firewall running on the server and/or a firewall blocking connections between the servers/computers.