Backburner Monitor

The Backburner Monitor allows pausing, restarting, and reassigning jobs and tasks to different render nodes as well as creating and managing render node groups and verification that the servers are up and running. With the Windows version, it can be helpful to install the Backburner Monitor on the same workstation so you can start the manager and monitor and work out any connection configuration. Then each server can be observed from one central location.

The Backburner network can be monitored via a Windows-based or browser-based monitor.

The Web Monitor allows users to manage jobs and render nodes using a browser. Its advantage over the Windows Monitor is that it can run on any workstation with a web browser, and it has little impact on the Backburner Manager. Data from the Manager is served by a web server on the same machine.

By default, end-users have complete control over the jobs that they submit to Backburner. To control all jobs on the Backburner network, you must log on to the server with administrator privileges. Generally, the name used to log in to the workstation is associated with all jobs submitted to Backburner from that workstation. However, some applications pass on the account name used to start the application instead. In Smoke, for example, if the artist starts the application as user smoke, smoke owns the jobs. It is therefore necessary to create accounts on the web server with the same names. By matching the log in or application user names with the web server user names, you ensure the artist has control over the jobs he or she submits. To launch the Backburner Web Monitor:

  1. Point a web browser to http://<machinename>/Backburner where <machinename> is the name of the workstation running the web server.
  2. Enter a user name and password and then click OK. From the Manager drop-down list, select the Backburner Manager. You can update the display manually by clicking the Jobs tab Refresh button, or you can set a refresh rate from the Auto Refresh menu.
  3. To perform an operation on a job, select the job in the Jobs tab, then select the desired operation from the Action menu. To view job details, double-click the job of interest, or select a job and choose Settings from the Action menu.

Setup on Windows

Before users can access the Web Monitor, you must install the following software on the workstation running the Backburner Manager:

  • Apache HTTP server (Linux/Windows/OS X) or Microsoft Internet Information Services (IIS) (Windows only)
  • Backburner Web Server

Users without administrator privileges can fully manage their own jobs, but can only monitor the status of other jobs in the Web Monitor. Those with administrator privileges can manage all jobs and render nodes. To assign administrator privileges to a Web Monitor user account: Edit the Wiretap server configuration file, wiretap.cfg, located in the backburner directory of the application data directory. In the [SECURITY] section use the BackburnerAdministrators keyword to add users to the admin group. It can be a comma-separated list.

To configure the Web Server to connect to the Backburner Manager:

  1. Open for edit C:\Program Files\Apache Group\Apache2\cgi-bin\monitorCGI.cfg. Find <Manager>localhost</Manager> and replace localhost with the name of the workstation running Backburner Manager.
  2. If necessary update <Port>3234</Port>.
  3. Save and close the file. To test the Web Server, access http://<machinename>/backburner with a web browser. Enter a user name and password when prompted. By default these are both backburner. If you cannot connect to the Web Server, try restarting the Backburner service and/or the web server.

To set up access to the Web Monitor:

  1. Configure IIS to disable anonymous access, and enable integrated Windows authentication. These settings allow anyone who can log in to the Windows workstation to use the Web Server. If you want to provide access to users who do not have accounts on the Windows workstation, refer to the IIS documentation.
  2. Configure the Web Server itself to run in authenticated mode and then test this mode using the Web Monitor: open for editing C:\Inetpub\wwwrootIcgi-binmonitorCGI.cfg. Add this line to the file: <AuthorizedSite>monitorCGI.cgi</AuthorizedSite>. This requires all users connect through the Web Monitor to provide a username and password.

Configure IIS and set the security for the Web Server:

  1. Go to the Inetpub\wwwroot\backburner folder and edit its properties and enable sharing.
  2. Edit the properties of the folder C:\Inetpub\wwwroot\cgi-bin. In the Web Sharing panel, enable Share This Folder. You are prompted to set the security for the cgi-bin folder. From the dialog that appears, select Execute (including scripts).
  3. Set up the security for the shared backburner and cgi-bin folders in IIS with Computer Management Console > Services and Applications > Internet Information Services > Web Sites. IIS-managed Web sites appear in the right pane. If you just installed IIS, only one site (the Default Web Site) appears. Otherwise, all IIS-administered Web sites appear in the panel.
  4. Right-click Default Web Site and choose Properties. Open the Documents panel and then click Add. Enter index.html in the Add Default Document dialog.
  5. Click OK, and double-click Default Web Site. Icons for the shared backburner and cgi-bin folders appear in the right pane. Edit the properties of backburner and enable Anonymous Access. The backburner folder contains a file that connects the Web Monitor to the Web Server as well as the files that control the look of the Monitor. Allow anonymous access to this folder to: Redirect the Web Monitor to the Web Server, and permit any Web browser to load the Web Monitor page.
  6. In the Computer Management Console, edit the properties of cgi-bin to enable anonymous access.

Test the setup:

  1. In Backburner Monitor, from the Manager menu, select Connect.
  2. Enter the IP or hostname of the machine where you installed Backburner Manager, and verify that you can connect to the Manager.
  3. Once you are connected to the Manager, expand the Plugins branch in the lower-left panel of the Monitor window, and select MIO File Import. The Servers panel should list all the Backburner Servers where you installed the Media I/O Adapter.
  4. Expand the Global Groups branch in the lower-left panel of the Monitor window, and verify that the server groups you defined are listed there, and that the correct servers are listed under each group.

Setup on OS X

Setting up access to the Backburner Web Monitor requires that you create Backburner Web Monitor user accounts. The Backburner web server requires all users to provide a login name and password to access the Backburner Web Monitor. The default user account backburner is created during the installation of the Backburner Manager. The password associated with this account is backburner.

Create a Backburner Web Monitor user account:

  1. Check if /private/etc/apache2/auth/backburner.auth file is present. If not, copy /usr/discreet/backburner/WebMonitor/backburner.auth
  2. Add the account by running the commnad: htpasswd /private/etc/apache2/auth/backburner.auth. Enter a password when prompted. The Backburner Web Monitor can now be accessed with the account information you have entered.
  3. To delete an account, as root in a terminal run htpasswd -D /private/etc/apache2/auth/backburner.auth <username>

Users without administrator privileges can only monitor the status of Backburner jobs in the Backburner Web Monitor. Users with administrator privileges can actively manage all jobs and render nodes. The default user account backburner created during the installation of the Backburner Manager has administrator privileges by default. If you are creating new user accounts, you may wish to remove administrator privileges from the default account, for security. Alternately, change the password.

Give administrator privileges to a Backburner Web Monitor user account:

  1. In the Terminal open /usr/discreet/backburner/Network/wiretap.cfg.
  2. In the [SECURITY] section use the BackburnerAdministrators keyword to add users to the admin group. It can be a comma-separated list.

Managing and Modifying Jobs

The Jobs tab presents high-level information relating to all jobs associated with the selected Backburner Manager. Use it to view and control the jobs you submit to Backburner, as well as to view jobs submitted to Backburner by other Autodesk applications. Double-click any job in the list to view its details and settings.

All users can activate, suspend, and restart all jobs. Users can archive/restore, modify settings and delete their own jobs, while admin users can perform all actions on all users' jobs.

To find jobs and view their status:

  1. Launch a web browser, log in to the Backburner Web Monitor, and connect to a Backburner Manager.
  2. Click the Jobs tab. The Job list appears, showing all jobs on the system. Their status, progress, and other information is also displayed.
  3. To filter the list, type the word you want to match in the Filter by Name field.
  4. Contents of the interface.
    Name
    Job name
    Status
    State of the job
    % Done
    The number of tasks completed, expressed as a percentage.
    Tasks
    The number of tasks completed and total number of tasks
    Priority
    The job priority, from 0 to 100. Zero is the highest priority.
    Submitted
    The time at which the job was originally submitted.
    Started
    The time at which the job was started, in the following format: YYYY/MM/DD HH:MM:SS. If the job has not yet started, this field is blank.
    Elapsed
    The processing engine required to complete the job. For example:
    • Burn: The Burn renderer.
    • Command Line Tool: The Backburner cmdjob command-line plug-in allows you to submit batch, executable, or script files to Backburner as “custom” jobs.
    • mio: The MIO adapter is the processing engine responsible for carrying out transcoding jobs.
    • Wire: Installed with Stone and Wire. Can be used to import/export media, perform Wire transfers, etc. Also used by the Wiretap SDK’s background I/O tool, wiretap_bgio_tool.
    Owner
    The owner of the job, and the host from which it was submitted.
  5. Double-click on a job of interest to view its details and settings.
General Info tab
Description
Job description as entered when the job was submitted.
Submitted By
The owner of the job, and the host from which it was submitted.
State
The current state of the job.
Priority
The job priority, from 0 to 100. Zero is the highest priority. 100 means the job is suspended. Default is 50.
Email Notification
The address to which job progress, completion, or failure notifications are sent. When using this feature, be sure to set the location of the mailer daemon too.
Dependencies
List of jobs that must be completed before the selected job can be processed.
Last Task Error
The last error message for the most recent task (associated with the job) executed by the Backburner Manager.
Job Completion Handling Instructions
Jobs are submitted with instructions to delete a given number of days after completion. For Burn and Wire this is two days. For Cache and Proxy jobs it is three days. Export and Publish jobs are submitted with instructions to delete 1 day after completion. All of these can be changed with environment variables.
Tasks tab
ID
The task number.
Status
The state of the task (active, complete, waiting, error).
Server
The name of the server where the task is being executed.
Start Time
The time stamp at which the task was started (YYYY-MM-DD HH:MM:SS).
Elapsed Time
The time duration consumed by the task (HH:MM:SS).
Last Error
The last execution error message associated with this task.
Server Assignment tab
Assigned Server Group
Name of the server group to which the job was assigned. A server group is a collection of servers. Only servers in the specified group will work on the job.
Max Server Count
The maximum number of render nodes made available for the job, as specified when the job was submitted. Set to 0 (zero) to assign the job to all servers.
Assigned Servers
A comma-separated list of servers currently assigned to the job.
Filter on Job Type
Select this checkbox to list only the servers installed with the required adapter.
Name
Host name of the server.
Assigned to Job
A checkbox indicating whether or not the listed server is assigned to the job. To add a new server to the job, check a checkbox. Click the Save button to apply the changes.
Description
A description of the server.
Status
The current activity of the server.
Perf. Index
A value in the range [0–1] indicating the performance level of the server, relative to other servers on the same job. A score of 1 indicates this is the best-performing server.
Adapters
The adapters installed on the server, for example:
  • Burn: The Burn renderer.
  • Command Line Tool: The Backburner cmdjob command-line plug-in allows you to submit batch, executable, or script files to Backburner as “custom” jobs. See Submitting Jobs from a Command Line or Script.
  • mio: The MIO adapter engine is responsible for transcoding some streaming media formats (such as R3D and OpenEXR).
  • Wire: Installed with Stone and Wire. Can be used to import/export media, perform Wire transfers, etc. Used internally by Autodesk Visual Effects and Finishing applications.

Suspend a rendering job:

  1. Click the Jobs tab and select the job you want to suspend.
  2. From the Action menu, choose Suspend. The selected job is suspended. If the selected job is completed, the Suspend command has no effect.
  3. To reactivate a suspended rendering job: from the Action menu, choose Activate. The selected job is reactivated. If another job is already being processed, the selected job becomes pending.

Restart a job:

  1. Click the Jobs tab and select the job you want to restart.
  2. From the Action menu, choose Restart. The selected job is restarted from the beginning. If another job is already being processed, the selected job becomes pending. While the most common workflow is to suspend a job, change its settings, and then re-activate the job, restarting a job is another possibility. Re-activating a suspended job picks up processing from where it left off. That is, tasks already completed are not re-done. In contrast, restarting a job halts all processing for the job, clears the server of all job-related temporary files (including completed tasks), and restarts the job from its first task. It is identical to resubmitting the job from the creative application, without the need for that application to be running.

To delete a job:

  1. On the Jobs tab, select the job of interest and choose Delete from the Action menu.
  2. When prompted, click OK. The job is deleted from the system and removed from the Job list. Deleting a job completely removes it from the job queue and Backburner system. It does not, however, destroy source material or rendered results. Deleting cannot be undone. If you think you may need to run the job again in the future, or examine job details, consider archiving it instead.

To set email notifications for a job:

  1. On the Jobs tab, double-click the job of interest, or select a job and choose Settings from the Action menu. The Job Details page appears.
  2. Enter the information in the Email Notification area:
    • From: Return address used by the Backburner Manager when sending notification email.
    • To: Destination address.
    • Server: Server where the smtp mailer daemon is running. Leave this field blank to use the Backburner Manager’s default setting.
    • Notification: Turns on/off notifications for the job.
      • Failure: Enable to be notified on job failure.
      • Progress Every nth Task: Enable for email notification when each nth task is completed.
      • Completion: Enable for email notification on job completion.

Managing Render Nodes (Servers)

The Servers tab provides an overview of the general health of each render node, the adapters installed on it, and so on. It also provides access to server details, where you can set an availability schedule, for example.

Tasks related to render nodes (servers)
Server Task Admin User
Shift jobs between servers/server groups
Delete absent server
Set server availability schedule
Create server groups
Manage server group settings

View render node status:

  1. Launch a web browser, log in to the Backburner Web Monitor, and connect to a Backburner Manager.
  2. Click the Servers tab. If a server that is already known to the Backburner Manager subsequently fails to re-connect to it, the manager marks it as absent.
    Servers tab
    Name
    Server name (host name).
    Description
    A short description of the server.
    Status
    Current server activity:
    • absent: Server is no longer seen by the manager, possibly down.
    • active: Currently working on a job.
    • suspended: On hold.
    • idle: Inactive.
    • error: Problem on the server.
    Perf. Index
    A value in the range [0–1] indicating the performance level of the render node, relative to the other servers on the same job. A score of 1 indicates this is the best-performing server.
    Adapters
    The adapters installed on the server, for example:
    • Burn: The Burn renderer.
    • Command Line Tool: The Backburner cmdjob command-line plug-in allows you to submit batch, executable, or script files to Backburner as “custom” jobs. See Submitting Jobs from a Command Line or Script.
    • mio: The MIO adapter engine is responsible for transcoding some streaming media formats (such as R3D and OpenEXR).
    • Wire: Installed with Stone and Wire. Can be used to import/export media, perform Wire transfers, etc. Used internally by Autodesk Visual Effects and Finishing applications.
  3. Double-click on a render node of interest to view its details, as described in the following table.
    Manager tab
    Host
    The server's IP address. This is used by the Backburner Manager to communicate with the server.
    State
    A short description of the server.
    Current server activity:
    • absent: Server is no longer seen by the manager, possibly down.
    • active: Currently working on a job.
    • suspended: On hold.
    • idle: Inactive.
    • error: Problem on the server.
    Description
    A short description of the server.
    Perf. Index
    A value in the range [0–1] indicating the performance level of the render node, relative to the other servers on the same job. A score of 1 indicates this is the best-performing server.
    Current Job
    The current job as assigned by the Backburner Manager.
    Plugins
    Detailed information on the adapters installed on the render node.
  4. Click the Close button to return to the list of all render nodes.

Shift a render node:

  1. On the Jobs tab, select the job of interest, and choose Settings from the Action menu, or double-click the job.
  2. In the Job Details page, click on the Server Assignment tab.
    Server Assignment tab
    Assigned Server Group
    Name of the server group, if any, to which the job was assigned. A server group is a named collection of servers. Only servers in the specified group will work on the job.
    Max Server Count
    The maximum number of render nodes made available for the job, as specified when the job was submitted. Set to 0 (zero) to assign the job to all servers.
    Assigned Servers
    A comma-separated list of servers currently assigned to the job. If you make changes, be sure to save them, then click the Refresh button to ensure the list is up to date.
    Filter on Job Type
    Select this checkbox to list only the servers on which the required adapter is installed.
    Name
    Name of the server.
    Assigned to Job
    A checkbox indicating whether or not the listed server is assigned to the job. To add a new server to the job, check a checkbox. Notice the Assigned Servers list is updated automatically. Nevertheless, click the Save button, then the Refresh button to ensure the list is up to date.
    Description
    A description of the server.
    Status
    The current activity of the server:
    • absent: Server is no longer seen by the manager, possibly down.
    • active: Server is currently working on a job.
    • suspended: Server has been put on hold.
    • idle: Server is inactive.
    • error: Problem on the server.
    Perf. Index
    A value in the range [0–1] indicating the performance level of the server, relative to other servers on the same job. A score of 1 indicates this is the best-performing server.
    Adapters
    The adapters installed on the server, for example:
    • Burn: The Burn renderer.
    • Command Line Tool: The Backburner cmdjob command-line plug-in allows you to submit batch, executable, or script files to Backburner as “custom” jobs.
    • mio: The MIO adapter engine is responsible for transcoding some streaming media formats (such as R3D and OpenEXR).
    • Wire: Installed with Stone and Wire. Can be used to import/export media, perform Wire transfers, etc. Used internally by Autodesk Visual Effects and Finishing applications.
  3. Assign and/or remove servers, as desired, using the checkboxes.
  4. Apply the changes. The selected render nodes are assigned to the job. If a render node is already occupied, it completes its current task first.
  5. Verify the changes by clicking the Refresh button. This queries the Backburner Manager for the most up-to-date information. The Assigned Servers list is updated to reflect the changes.
  6. Click Close to return to the list of all servers.

Delete a render node:

  1. Before deleting a node, consider archiving jobs that made use of it, to preserve job details, including the nodes to which tasks were sent.
  2. On the Servers tab, select the node of interest, and click the Delete button. Only nodes marked by the system as absent can be deleted.
  3. Confirm the deletion in the dialog box that appears. The node is deleted and removed from the list. Deleting a render node removes its entry from the database maintained by the Backburner Manager. It does not delete any software from the node itself.

To help with network traffic, you can schedule the availability of a render node:

  1. On the Servers tab, select a node of interest and click the Settings button. Alternately, double-click the node of interest.
  2. In the Server Details page, click the Weekly Schedule tab. Periods of time that are green indicate the node is available to process jobs. By default, nodes are always available.
  3. Toggle render node availability as desired:
    • Toggle a single hour by clicking the hour of interest.
    • Toggle the same hour for each day with one click using the hour buttons.
    • Click and drag to toggle a number of hours at once.
    • Toggle a whole day using the days-of-the-week buttons.

Server groups

A server group is a named collection of render nodes that is treated like a single node. By default, jobs are submitted by creative applications to the Backburner network as a whole. The Backburner Manager determines to which render nodes they are sent. Some Autodesk applications can be configured to submit jobs to a server group. Server groups can be used to implement a job-processing strategy. For example with a render farm consisting of eight Burn nodes, four GPU-enabled, it would be useful to have two server groups, one each for the non-GPU and GPU-enabled Burn nodes.

Server groups do not restrict the ability to assign render nodes to particular jobs. When a creative application is configured to submit its jobs to a server group, additional nodes can be assigned to it, automatically, or manually, once the job is on the network. Conversely, you can always remove individual nodes from a job, regardless of their relationship to a server group.

To create a server group

  1. On the Server Groups tab, click the Create button.
  2. Enter a name for the new server group in the Group Name field.
  3. Add render nodes to the group by selecting them in the Available Servers list and moving them to the Servers in Group list.
  4. Click OK to commit the changes. Server groups created in the Backburner Web Monitor appear as global groups in Backburner Windows Monitor.

To assign a server group to a job:

  1. On the Jobs tab, select the job of interest and choose Settings from the Action menu, or double-click the job.
  2. In the Job Details page, click on the Server Assignment tab.
  3. Choose a server group from the Assigned Server Group menu.
  4. Apply the changes, then click Refresh to update the display. Compatible servers belonging to the group appear in the Assigned Servers list. If an expected server belonging to the chosen group does not appear in the list, it can indicate the server is absent, or does not have the correct adapter installed. The manager will only assign servers that are able to carry out the job. Changed settings apply to new tasks only. Completed tasks are not reprocessed. To reprocess completed tasks, restart the job from the beginning.

To delete a server group: On the Server Groups tab, select the server group of interest and click Delete.

Manager

Use the Manager tab to set options related to the Backburner network, such as logs, server assignments criteria, job retries, and the tasks performed when a job finishes, such as archiving.

Manager tab
Area Field Description
Logging and Notification Logging Level
  • Error: Fatal errors that halt the processing of a job.
  • Warning: Operations that complete with non-fatal errors.
  • Info: Successful operations, possibly with minor faults or caveats.
  • Debug and Debug Extended: Detailed state information, including TCP/IP packet information. Helpful in tracking down bugs.
  • Debug Extended: A more verbose listing than Debug.
  Default Mail Server The smtp mail server through which all email notifications for this manager are sent. This can be overridden for individual jobs.
Server Assignment Max Concurrent Jobs The maximum number of jobs Backburner will send out for processing on the render farm at the same time.
Task Failures Retry Count The number of times the Backburner Manager attempts to restart a job on a server that has failed to complete its processing. A failed job may be returned by Backburner to the job processing queue. Set to zero (0) to have job processing halted on the server after its first failure. Default is 3.
  Time Between Retries The time before the Backburner Manager attempts to re-start a job on a server that has failed. Works in conjunction with Retry Count. Default is 30 seconds.
Job Handling On Job Completion Specifies what happens to a job once it has successfully completed:
  • Leave: Job is left in the job list.
  • Archive After: Remove from the job list and place in the archive after the number of days specified.
  • Delete After: Permanently remove from the job list after the number of days specified.

Archive

The Archive tab presents information pertaining to all archived jobs. From here, you can delete and re-activate old jobs. Archiving removes completed jobs from the job queue. It reduces clutter. Its advantage over deleting completed jobs is in preserving all the information needed to re-submit the jobs at a later date. You can also restore an archived job to examine job details, such as the render nodes that processed it. This can assist in troubleshooting. Archiving can also be part of a facility backup strategy. The job archive contains metadata (job details) only—it does not contain source material or rendered frames. Archiving a job has no effect upon the associated media. Jobs can be archived automatically, when the manager has been configured to do so.

Archive a job:

  1. On the Jobs tab, begin by selecting the job of interest and choosing Suspend from the Action menu. Jobs are archived (and restored) with their original status intact. Suspending the job before archiving it minimizes the impact on the system if the job is restored later.
  2. Choose Archive from the Action menu. The job is archived and removed from the Job list. By default, archived jobs are saved to the Network\Archive folder where the Backburner Manager is installed.
  3. To view the list of archived jobs, click the Archive tab.
  4. To restore or delete a job from the archive: Click the Archive tab. The Job Archive appears, presenting information for all archived jobs. Find the job of interest, then do one of the following
    • Delete: Removes the job from the archive.
    • Activate: Restores a selected job to the job queue, removing it from the archive. You can then choose to modify its settings and restart the job. Jobs reappear in the job queue with the settings they had when archived. This includes job status. If a job was suspended or completed when it was archived, once restored, you must re-activate or restart it to start the processing again.
    • Refresh: Updates the display with the most recently archived jobs.

The Backburner Manager maintains a database, which it updates with every change of state of the render nodes. It then broadcasts the changes to every workstation running a Backburner Windows Monitor, whether the end-user is actively viewing it or not.

The Windows Monitor can be launched from any Windows workstation on the network where it has been installed.

The first Windows Monitor making the connection has full control over the job queue and Backburner network—that is, “queue control”. Subsequent connections by other Windows Monitors have more limited functionality. It is recommended to run Windows Monitor on not more than one or two workstations.

Run the Backburner Windows Monitor:

  1. From the Start menu, choose Programs, Autodesk, Backburner, and then Monitor. The Backburner Monitor appears. The first time the application is run, no network or job details are present, since it is not yet connected to a Backburner Manager.
  2. Connect to a Backburner Manager. From the Manager menu, choose Connect. In the Connect to Manager dialog that appears, uncheck the Automatic Search checkbox, and enter the host name or IP address of the Backburner Manager in the Enter Manager Name or IP Address text field. Automatic searching is not recommended, since it makes extensive use of network resources and can take some time. Click OK to initiate the connection. If the title bar displays “Read Only”, this indicates that another user has already connected to the manager via a Backburner Windows Monitor. To get control:
    1. From the Manager menu, choose Request Client List. A Client List dialog appears, showing the status of all users connected to the manager via the Backburner Windows Monitor. The Status column indicates the user with control of the queue.
    2. Dismiss the dialog, then from the Manager menu, choose Request Queue Control. The manager transmits the request to the user currently with queue control. A message similar to the following appears on the remote machine. The user has 10 seconds to actively refuse the request; otherwise, control of the queue passes over to you. You can now perform all operations on jobs and servers on the Backburner network.
  3. Verify the connection. From the Manager menu, choose Properties. Manager details appear in a dialog. If no connection was made, this option is greyed-out.
  4. Optional: Set the monitor to connect to its manager automatically at start-up. From the Manager menu, choose Autoconnect.
  5. When finished, end the session. From the Manager menu, choose Disconnect.

The first monitor establishing a connection to the manager is automatically granted queue control, and can perform all job-related activities, including stopping, restarting, or deleting jobs. Subsequently, other monitors connect in read-only mode, allowing them to observe the activity on the Backburner network only.

Managing and Modifying Jobs

Suspend and reactivate a job, select it, then do one of:

  • In the toolbar, click the Suspend button.
  • Tap Ctrl+S.
  • From the Jobs menu, choose Suspend.
  • Right-click a job in the Job list and choose Suspend.
  • To reactivate, select the job, then do one of:
    • In the toolbar, click the Activate button.
    • Tap Ctrl+A.
    • Right-click the job and choose Activate.
    • From the Jobs menu, choose Activate.

Modify job settings:

  • From the Jobs menu choose Edit Settings.
  • Right-click the job and choose Edit Settings.
  • Press Ctrl+J.
  1. Select the job of interest in the Job list.
  2. Display the current settings for the selected job:
  3. Double-click the field of interest, and modify it as desired. If the job setting can be modified, you are allowed to change it. Otherwise, the setting remains unchanged.
  4. Modify the Job properties as desired.
  5. The Backburner Manager can send job success, failure, and other notifications to the email addresses you specify in the Notifications area.
Job properties
Description
The description provided when the job was submitted to Backburner.
Priority
The job priority, from 0 to 100. Zero is the highest priority. 100 means the job is suspended.
Override Task Blocks Setting
Depending on how the system administrator has configured the Backburner Manager, it either i) assigns multiple tasks to each render node—that is, blocks of tasks (the default setting), or ii) assigns each render node one task at a time. Enable to override the manager's configuration, for this particular job.
Enable Task Blocks
Enable to cause the manager to send render nodes blocks of tasks, for this job. Disable if you want each render node to receive only one task at a time, for this job.

For example, enabling for frame-based render jobs results in each render node receiving a block of several frames to render at once. Disabling results in frames being sent one at a time.

For this setting to have an effect, you must also enable Override Task Blocks Setting.

Use All Available Servers
Overrides any Backburner Manager settings that restrict the maximum number of servers that can work on this job at any one time.
Server Limit
The maximum number of servers that can work on this job at any one time. Set this to zero to run on all servers.
Server Group
The server group to which the job is assigned.

Only servers in the specified server group will work on the given job, unless the group is set to use idle non-group servers.

Restarting a job halts all processing for the job, clears the server of all job-related temporary files (including completed tasks), and restarts the job from its first task. It is identical to resubmitting the job from the creative application, without the need for that application to be running.

  • From the Jobs menu, choose Restart Job.
  • Right-click the job and then choose Restart Job.

Cloning a job creates a 100% duplicate job that is independent of the original, but inherits all of its qualities, including its status and settings. Cloning is a convenient means for experimenting with changes to job settings or testing render nodes, since changes made to the clone do not affect the original. Cloning is allowed, but not generally recommended. For efficiency, the Visual Effects and Finishing applications pre-allocate space on the destination storage device for the frames resulting from all Burn and background I/O jobs. Since the clone is a duplicate of the original job, its results overwrite those of the original job.

Archiving conveniently removes completed jobs from the job queue. It is a practical means for keeping the job queue organized by reducing clutter. Its advantage over deleting completed jobs is in preserving all the information needed to re-submit the jobs at a later date. You can also restore an archived job simply to examine job details, such as the render nodes that processed it. This can assist in identifying problems—if unexpected or unsatisfactory results occurred, for example. Archiving can also be part of a facility backup strategy, since the archive represents a job history, in compact form. Note, however, that the job archive contains metadata (job details) only—it does not contain source material or rendered frames. Note that archiving a job has no effect upon the associated media. The job archive contains job metadata only; that is, it contains the information needed to restart a job, but not the source media.

By default, archived jobs are saved to the Network\Archive folder where the Backburner Manager is installed.

Archive a selected job:

  • From the Jobs menu, choose Archive Job.
  • Right-click the job and then choose Archive Job.
  • To restore or delete a job from the archive, from the Jobs menu, choose Job Archives. Click Refresh if you do not see all the jobs expected. Select a job (or jobs) and:
    • Delete: Removes the job from the archive.
    • Activate: Restores a selected job to the job queue, removing it from the archive. You can then choose to modify its settings and restart the job. Jobs reappear in the job queue with the settings they had when archived. This includes job status. If a job was suspended or completed when it was archived, once restored, you must re-activate or restart it to start the processing again.
    • Refresh: Updates the display with the most recently archived jobs.

Delete a selected job:

  • From the Jobs menu, choose Delete, or in the toolbar, click Delete, use the righ-click menu, or tap the Delete key.
  • Confirm the action. Deleting a job completely removes it from the job queue and Backburner system. It does not, however, destroy source material or rendered results. Deleting cannot be undone. If you think you may need to run the job again in the future, or examine job details, consider archiving it instead.

Managing Render Nodes

To view render node status:

  1. Start the Backburner Monitor and connect to a Backburner Manager. The Server List area occupies the lower panes in the monitor. This area shows nodes organized in a hierarchical tree view and as a list. The tree view presents a hierarchical list of all node groups, as well as the plug-ins available for the system. You can use this area to see which render nodes are available to render jobs, as well as manage groups of nodes. The list of render nodes shows all nodes assigned to the group selected in the tree view. If no group is selected, all render nodes on the system appear in this area. By default, this area shows the following information for each node:
    • The name and current status of the node.
    • The job the node is currently processing.
    • The most recent message sent by the node to the Backburner Manager.
    • The icon beside each server provides a visual indication of its state.
      • Green: OK
      • Yellow: idle
      • Grey: absent
      • Red: error
  2. Customize the information shown in the list of render nodes, as desired.
  3. To locate a render node, do any of the following:
    • Scroll through the entries using the scroll bars.
    • Reorder the list in ascending or descending order by clicking a column heading.
    • Filter the list by first clicking the square on the right side of each column in the Job list. Enter filtering criteria in the dialog that appears.
  4. Right-click a render node and choose Properties (or tap Ctrl+N). The Server Properties dialog appears, showing hardware and software information for the node.
    Server
    Server host name.
    User
    User account name under which the Backburner Server was launched.
    Current Job
    The current job as assigned by the Backburner Manager.
    Status
    Current server activity.
    Handle
    Server ID, used internally and in log files.
    Platform
    Operating system details.
    Memory
    Installed RAM.
    CPUs
    The total number of CPUs installed on the system.
    IP Address
    The server's IP address. This is used by the Backburner Manager to communicate with the server.
    Perf. Index
    A value in the range [0–1] indicating the performance level of the render node, relative to the other servers on the same job. A score of 1 indicates this is the best-performing server.
    Available Disk Space
    Disk space available for rendering.
    burn, mio, Command Line Tool, Wire, etc.
    A list of adapters installed on the render node, for example: burn: The Burn renderer mio: The Media I/O adapter used by WiretapCentral.Command Line Tool: The adapter associated with cmdjob.
    Server
    Backburner Server software version.
    Backburner API
    DSO version. Should match the Backburner software version.
    Plugin
    Backburner Adapter version and platform info.

Customize the render node list:

  1. To add a new column: from the Server menu choose Column Chooser, or right-click any node in the list and choose Column Chooser. The Server Columns dialog appears, presenting the columns that can be added.
  2. Drag and drop the column of interest to the column title bar in the Job list.
  3. To rearrange the columns, drag and drop.
  4. To remove a column, right-click the column title, and choose Remove Column. You cannot remove the Server column.

To shift a render node:

  1. Select the node in the server list, then click Remove Server on the toolbar. The node ends its current processing task and becomes available for other jobs.
  2. In the job list, select the job to which you want to assign the node.
  3. Assign the render node to the job: select the unassigned node and then, from the Servers menu, choose Assign To Selected Jobs, or right-click the unassigned node and choose Assign To Selected Jobs from the popup menu. The selected render node begins working on the new job. It remains assigned to the new job until the entire job is complete.

Use the following procedure to delete offline render nodes from the system. Deleting a render node removes its entry from the database maintained by the Backburner Manager. It does not delete any software from the node itself.

To delete a render node:

  1. Deleting a node can make it more difficult to troubleshoot jobs with problems, since it will be more difficult to determine which node carried out the flawed work. Before deleting a node, consider archiving jobs that made use of it, to preserve job details, including the nodes to which tasks were sent.
  2. Select the render node(s) of interest. Only nodes marked by the system as absent can be deleted.
  3. Choose Delete Server from the Servers menu, or by right clicking the node. The node is deleted and is removed from the list.

To help manage network traffic, schedule the availability of a render node:

  1. Select the render node(s) of interest and choose Week Schedule from the Servers menu or the righ-click menu. Periods of time that are green indicate the node is available to process jobs. By default, nodes are always available.
  2. Select the time of interest:
    • Select a single hour by clicking the hour of interest.
    • Select the same hour for each day with one click using the hour buttons.
    • Click and drag to select a number of hours at once.
    • Select a whole day using the days-of-the-week buttons.
    • Select the entire week by clicking the button at the top left. The selected time is shown in white.
  3. Click the Allow or Disallow buttons, as desired. Green indicates node availability. Red indicates processing is prohibited during this time.
  4. Click OK to update the schedule for the node and close the dialog.

Server groups

A server group is a named collection of render nodes that is treated, for the most part, as if it were a single node. By default, jobs are submitted by creative applications to the Backburner network as a whole. It is the Backburner Manager that determines the specific render nodes to which they are sent, based on job type and node availability. However, certain Autodesk applications can be configured to submit jobs to a specific server group.

Server groups can be used to implement a job-processing strategy. For example, consider a facility with two Visual Effects and Finishing applications, and a render farm consisting of eight Burn nodes, four of which are GPU-enabled. In such a situation, you might create two server groups, one each for the non-GPU and GPU-enabled Burn nodes. By assigning each Visual Effects and Finishing workstation to a different server group, you can reserve the GPU-enabled Burn nodes for the workstation with higher priority or more demanding jobs.

Server groups do not restrict the ability to assign render nodes to particular jobs as you see fit. When a creative application is configured to submit its jobs to a server group, additional nodes can be assigned to it, automatically, or manually, once the job is on the network. Conversely, you can always remove individual nodes from a job, regardless of their relationship to a server group.

Two kinds of server groups can be created, local groups and global groups. In almost all cases, you will want to create global server groups only. Local groups serve a particular purpose for 3ds Max, under a specific Backburner configuration.

For information on configuring a creative application to submit jobs to a server group, see the User Guide for the application of choice.

Create a server group:

  1. Right-click All Servers in the server list and choose Global Group from the popup menu. If the option is greyed-out, connect to a Backburner Manager, and then try again.
  2. Configure the behaviour of the group:
    Name
    The name of the server group as it will appear in the UI.
    Weight
    Adjusts the priority of jobs assigned to the server group. Jobs assigned to a high-weight server group are given higher priority than jobs assigned to lower-weight groups. In fact, a job assigned to a high-weight group may be rendered ahead of non-group jobs—even if the non-group jobs have higher priorities at the job level.
    Can Use Idle Non-group Servers
    Enable to allow the Backburner Manager to temporarily assign idle non-group render nodes to the group. Enabling this option increases the rendering power of the group.
    Suspend Non-Current Group Jobs
    Enable to allow the Backburner Manager to suspend the processing of non-group jobs running on group nodes, when a new job is submitted specifically to the group. Enabling this option allows a render node group to automatically switch from non-group jobs to new group jobs.
  3. Add render nodes to the group by selecting them in the Available list and clicking Add. The render nodes are added to the group. You can add render nodes directly from the Server list area by dragging and dropping them onto an already existing group.
  4. Click OK. The render node group is added to the Global Groups list.

Assign a server group to a job:

  1. Select the job(s) of interest in the Job list.
  2. In the Server list, right-click the server group and choose Assign Group to Selected Jobs. The server group is assigned to the job.
    • If nodes in the group are busy, they complete their currently-assigned jobs before working on the new job to which you have assigned them. Otherwise, they begin working on the new job immediately.
    • If the “Suspend current non-group jobs” option is enabled for the group, all nodes in the Server group drop their current rendering job and begin processing the assigned job immediately.

Shift a server group between two jobs:

  1. Select all jobs in the Job list.
  2. In the Global Groups list, right-click the render node group to be reassigned and choose Remove Group From Selected Jobs. Each render node in the group ends its current assignment and becomes available for other jobs. If "Suspend current non-group jobs" is enabled for the group, the jobs are dropped immediately. Server groups are subject to the same job assignment and completion rules and restrictions as individual render nodes.
  3. In the Job list, select the job to which you want to assign the group.
  4. In the Server list, right-click the server group and choose Assign Group to Selected Jobs. The render node group is assigned to the new job and begins rendering. If "Can use idle non-group servers" is enabled for the group, the Backburner Manager adds nodes to the group temporarily, as they become available from other jobs.

To delete a server group:

  1. In the Global Groups list, right-click the render node group of interest and choose Delete Group. Once the group is deleted from the Server list, the render nodes themselves remain untouched, and can be assigned to other groups, as needed.

Use the following procedures to create or delete a named collection of render nodes, called a server group, and to assign a server group to a job. Two kinds of server groups can be created, local and global. Apart from some special cases with 3dsMax, global server groups are used. To configure a Visual Effects and Finishing application to submit its jobs to a server group, set the BackburnerManagerGroup keyword in the application's init.cfg.

Server Group customization

By default the nodes in a server group are available to all jobs submitted to the Backburner network. A server group can be configured to make use of idle non-group render nodes. A server group can be configured to give priority to the jobs submitted to it specifically. Once configured, when the Backburner Manager receives a job for a server group, non-group jobs are immediately suspended, freeing up the nodes for the server group job.

To create a server group:

  1. Right-click All Servers in the server list and choose Global Group from the popup menu. If the option is greyed-out, connect to a Backburner Manager, and then try again.
  2. Configure the behaviour of the group:
    Name
    The name of the server group as it will appear in the UI.
    Weight
    Jobs assigned to a high-weight server group are given higher priority than jobs assigned to lower-weight groups. A job assigned to a high-weight group may be rendered ahead of non-group jobs, even if the non-group jobs have higher priorities at the job level.
    Can Use Idle Non-group Servers
    Allows the Backburner Manager to temporarily assign idle non-group render nodes to the group. Enabling this option increases the rendering power of the group.
    Suspend Non-Current Group Jobs
    Allows the Backburner Manager to suspend the processing of non-group jobs running on group nodes, when a new job is submitted specifically to the group. Allows a render node group to automatically switch from non-group jobs to new group jobs.
  3. Add render nodes to the group by selecting them in the Available list and clicking Add. You can add render nodes directly from the Server list area by dragging and dropping them onto an already existing group.

To assign a server group to a job:

  1. Select the job(s) of interest in the Job list.
  2. In the Server list, right-click the server group and choose Assign Group to Selected Jobs.
    • If nodes in the group are busy, they complete their currently-assigned jobs before working on the new job to which you have assigned them. Otherwise, they begin working on the new job immediately.
    • If the “Suspend current non-group jobs” option is enabled for the group, all nodes in the Server group drop their current rendering job and begin processing the assigned job immediately.

Shift a server group between two jobs:

  1. Select all jobs in the Job list.
  2. In the Global Groups list, right-click the render node group to be reassigned and choose Remove Group From Selected Jobs. Each render node in the group ends its current assignment and becomes available for other jobs. If "Suspend current non-group jobs" is enabled for the group, the jobs are dropped immediately. Server groups are subject to the same job assignment and completion rules and restrictions as individual render nodes.
  3. In the Job list, select the job to which you want to assign the group.
  4. In the Server list, right-click the server group and choose Assign Group to Selected Jobs. If "Can use idle non-group servers" is enabled for the group, the Backburner Manager adds nodes to the group temporarily, as they become available from other jobs.

To delete a server group, in the Global Groups list, right-click the render node group of interest and choose Delete Group. The render nodes themselves remain untouched, and can be assigned to other groups, as needed.