Icon

This is the documentation for an older version of Qube. The latest version of the documentation can be found here: Qube

Skip to end of metadata
Go to start of metadata

Below are instructions on your first steps submitting Nuke jobs with Qube!


Step 1 (First Time Only)

The Nuke Jobtype comes with the standard install of Qube! and does not require a specific jobtype to be installed 

InApp Installation:

File > Install App UI > Install Nuke (loadOnce) App UI...

Step 2

Once installed you should be able to locate the "Qube!" menu in Nuke

InApp Location:

File > Render > Qube >

Step 3

With a script loaded in Nuke choose "Render All...(cmdline)" or "Render...(loadOnce)" depending on your requirements

This will present a pre filled submission UI

 

Step 4

Ensure sections marked in red have the correct details

Click submit

For further details on the submission UI look in the right panel

Troubleshooting

If you find you are getting errors here are some useful links for troubleshooting

Troubleshooting Flowcharts 


Below Is an expandable view of the "Nuke (loadOnce) Job..." Jobtype Submission UI

Icon

Not all sections need to be filled in in order to render only the fields marked in red are required


Please click on the text below the section of interest

 

 Qube Job Basics

Name

Tooltip - Name of the job

Icon

This is the name of the job of the job so it can be easily identified in the Qube! UI

Priority

Tooltip - Numeric priority (

Icon

Every job in Qube is assigned a numeric priority. Priority 1 is higher than priority 100. This is similar to 1st place, 2nd place, 3rd place, etc. The default priority assigned to a job is 9999.

Instances

Tooltip -

Icon

Instances are the amount of times you would like to spawn a session of your application

Example:

On a 12 slot(core) machine running Maya if you set

"Instances" to 4

"Reservations" to "host.processors=3"

Qube! will open 4 sessions of Maya on the worker simultaneously consuming all slots/cores

if you set

"Instances" to 1

"Reservations" to "host.processors=1+"

Qube will open 1 session of Maya on the worker consuming all slots/cores ("host.processors=1+" is used for all slots/cores)

more on Instances & Reservations

 Qube Frame Range

Range

Tooltip - Frame range for the job (e.g 1-100, or 1-100x3, or 1,3,7,10)

Icon

Most jobs require a frame range in which to execute on the worker's you can set this range in a few different ways :

"1-100" will just render the range between 1 and 100

"1-100x3" will render the range 1 to 100 in chunks of 3

"1,3,7,10" will only render the selected frames 1,3,7,10

rangeOrdering

Tooltip - Order to render the items. (Ascending=1,2,3,4,5...,Descending=10,9,8...,Binary=first,middle,last...)

Icon

You can set the order in which your frames are rendered. The drop down options are:

"Ascending" this will render the frames counting upwards from your start frame

"Decending" this will render the frames counting backwards from your end frame

"Binary" Explanation needed

 Preview Frames Submission

Use Preview Frames

Tooltip - Submit high-priority preview frames for this job

Icon

Enabling preview frames will create 2 jobs:

A primary dependent job with a higher priority that will render the selected frames first

and a secondary job with lower priority that will render the remaining frames

This will return the selected frames faster so that you can troubleshoot your renders

Frame Numbers

Tooltip - Preview frames list for the job. Leave blank to use default (1st, last, middle) frames (e.g 1,2,10)

Icon

Choose the frames that you wish to render first.

If left blank "Default" is selected which renders the first frame , the last frame and the middle frame in that order.

You can select the frames by adding comma separated frame numbers e.g 1,2,10,15,75

Preview Priority

Tooltip - Preview Frame Priority

Icon

Choose the priority for the primary job.

Preview Subjobs

Tooltip - Number of subjobs to use for the preview frames

Icon

Choose the instances/subjobs for the primary job.

 Primary parameters

Nuke Version

Tooltip - Select version numbers and the worker platform to make an educated guess at where the Nuke executable is found on the remote worker.

Icon

Use the spinners to enter the required version of nuke

Nuke path

Tooltip - explicit path to Nuke executable

Icon

Browse or enter manually the location of Nuke executable on the workers

Important : Always double check the location of the workers executable. Be aware that if you are submitting cross platform the path will be different.

load NukeX

Tooltip - load NukeX

Icon

placeholder

script

Tooltip - nuke script to execute

Icon

Browse or enter manually the location of the nuke file to be rendered. This is a required field for submission

Important: Best practise is to ensure the nuke file and all of its dependant files such as textures are on network storage accessible by the workers.

 Render Nodes and Script Args

execute views

Tooltip - only execute these views (comma-separated list: e.g. 'left,right'

Icon

list comma seperated views to render. These are named in your nuke script

execute nodes

Tooltip - execute only this node

Icon

Execute on the specified node. These are named in your nuke script

script args

Tooltip - All words between the script name and the frame ranges can be used by [argv n] expressions to provide changing arguments to the script. Each must start with a non-digit to avoid confusion with frame ranges.

Icon

Explanation and example needed

 Optional Switches

anamorphic

Tooltip - formats default to anamorphic

Icon

Tick box to override scene anamorphic settings

cache size

Tooltip - limit cache memory usage. Size is in bytes, or append k, M, G or T

Icon

Enter the numeric value to override scene cache size settings

interactive

Tooltip - with -x or -t use interactive, not render, license

Icon

Tick box to override scene interactive settings

linear transfer

Tooltip - apply linear transfer to the file read in

Icon

Tick box to override scene linear transfer settings

threads

Tooltip - set threads to n

Icon

Enter the numeric value to override scene threads settings

proxy mode

Tooltip - turn on proxy mode

Icon

Tick box to override scene proxy mode settings

quiet

Tooltip - quiet (do not print stuff)

Icon

Tick box to override scene quiet settings

stack size

Tooltip - sets the minimum stack size for each thread in bytes, this defaults to 16777216 (16MB) the smallest allowed value is 1048576 (1MB)

Icon

explaination needed

verbose

Tooltip - verbosity (print more stuff)

Icon

Choose the level of detail you would like the logs to provide

 Qube Job Tags

Qube Job Tags

New in Qube 6.5

Icon

see page Job Tags

 Qube Worker Selection

Hosts

Tooltip - Explicit list of Worker hostnames to run the job on (comma-separated)

Icon

Click browse to choose from a list of workers that you want to run the job on

Groups

Tooltip - Explicit list of Worker groups to run the job on (comma-separated)

Icon

Click browse to choose from a list of groups that you want to run the job on

Omit Hosts

Tooltip - Explicit list of Worker hostnames to NOT run the job on (comma-separated)

Icon

Click browse to choose from a list of workers that you do NOT want to run the job on  

Omit Groups

Tooltip - Explicit list of Worker groups to NOT run the job on (comma-separated)

Icon

Click browse to choose from a list of groups that you NOT want to run the job on

Priority Cluster

Tooltip - Worker cluster that the job has elevated priority to run on

Icon

Click browse to choose from a list of Priority Clusters

 

Clusters are a way of distributing jobs across the farm with the ability to expand and shrink based on the submitted priority cluster

Example:

  • A job submitted to /root/ will run on all machines with /root/ assigned as a cluster. 

    • At a standard priority


  • A job submitted to /root/a will run on all machines with /root/a assigned as a cluster

    • At a higher priority than /root/ meaning that the job will pre-empt a job with the priority cluster

Host Order

Tooltip - Order to select Workers for running the job (comma-separated) [+ means ascending, - means descending]

Icon

Click browse to choose from a list of Host Order Options

Host Order is a way of telling the job how to select/order workers

    • "+host.processors.avail" means prefer workers which have more slots available

    • "+host.memory.avail" means prefer workers which have more memory available

    • "+host.memory.total" means prefer workers which have more total memory

    • "+host.processor_speed" means prefer workers with higher cpu speeds

    • "+host.cpus" means prefer workers with higher total cpu slots

Requirements

Tooltip - Worker requirements needed to be met for job to run on that Worker (comma-separated, expression-based)

Icon

Click browse to choose from a list of Host Order Options

Requirements is a way to tell the workers that this job needs specific requirements to be met in order to run

drop-down menu items:

  • "winnt" this will fill the field with "host.os=winnt" which means only run on Windows based workers

  • "linux" this will fill the field with "host.os=linux" which means only run on Linux based workers

  • "osx" this will fill the field with "host.os=osx" which means only run on OSX based workers

The above is not the limit of what "Requirements" can do see a list below of other alterable variants:

  • "host.processors.avail.=4" means only run this job on workers that have 4 or more slots available

  • "host.processors.used=0" means only run this job on workers with 0 slots in use

  • "host.memory.avail=400" means only run this job on workers that have 400 memory available

Reservations

Tooltip - Worker resources to reserve when running job (comma-separated, expression-based)

Icon

Click browse to choose from a list of Reservation Options

Reservations is a way to tell the workers that this job will reserve the specific resources for this job

Menu items:

  • "host.processors" this will fill the field with "host.processors=X" which means reserve X slots on the worker while running this job

  • "host.memory" this will fill the field with "host.memory=X" which means only reserve X memory on the worker while running this job

The above is not the limit of what "Reservations" can do see a list below of other alterable variants:


Restrictions

Tooltip - Restrict job to run only on specified clusters ("||"-separated) [+ means all below, * means at that level]

Icon

Click browse to choose from a list of Restrictions Options

Restrictions is a way to tell the workers that this job can only run on specific clusters

Example:

  • submit a job that will run only in /farm:

    "qbsub -cluster /root -restriction /root"


  • submit a job that will prefer to run in /farm/nuke, but could run in any host in /farm or in the first level below /farm

    "qbsub -cluster /root/a -restriction '/root or /root/*'"


  • submit a job that will prefer to run in /farm/nuke/workstations, but could run in any host at any level at /farm or below

    "qbsub -cluster /root/a/workstations -restriction '/root or /root/+' hostname"

See Also

 Qube Advanced Job Control

Flags

Tooltip - List of submission flag strings (comma separated)

 

Click browse to choose required job flags

Flag

Decimal Value

Hex Value

Description

auto_mount

80x8

Require automatic drive mounts on worker.

auto_wrangling

163840x4000

Enable auto-wrangling for this job.

convert_path1310720x20000Automatically convert paths on worker at runtime. New in 6.4-2

disable_auto_complete

81920x2000

Normally subjobs are automatically completed by the system when a job runs out of available agenda items. Setting this flag disables that.

disable_cpu_limit

40960x1000

Normally, if a job is submitted with the number of subjobs greater than there are agenda items, Qube automatically shrinks the number of subjobs to be equal to the number of agenda items. Setting this flag disables that.

disable_windows_job_object

20480x800

Disable Windows' process management mechanism called the "Job Object" that Qube normally uses to manage job processes-- some applications already use it internally, and job objects don't nest within another well, causing jobs to crash unexpectedly.

elite

5120x200

Submit job as an elite job, which will be started immediately regardless of how busy the farm is. Elite jobs are also protected from preemption. Must be admin.

export_environment

160x10

Use environment variables set in the submission environment, when running the job on the workers.

expand

32-x20

Automatically expand job to use as many subjobs as there are agenda items (limited by the total job slots in the farm).

grid

40x4

Make all subjobs start at once (useful for implementation of parallel jobs, such as satellite renders).

host_list

2560x100

Run job on all candidate hosts, as filtered by other options (such as "hosts" or "groups").

mail

10240x400

Send e-mail when job is done.

migrate_on_frame_retry

655360x10000

When an agenda item (frame) fails but is retried automatically because the retrywork option is set, setting this flag causes the subjob to be migrated to another worker host, preventing the frame from running on the same host.

p_agenda

327680x8000

Enable p-agenda for this job, so that some frames are processed at a higher priority.

uninterruptible

10x1

Prevent job from being preempted.

 

Dependency

Tooltip - Wait for specified jobs to complete before starting this job (comma-separated)

Click Add to create dependant jobs

you can link jobs states to each other by several factors

"complete" means only start this job after designated job completes

"failed" means only start this job if the designated job fails

"killed" means only start this job if the job has been killed

"done" means start this job if the job is killed/failed/complete


Email (job complete)

Tooltip - Send email on job completion (success or failure)

Icon

Sends mail to the designated user based on the status of the job being complete

Email (failed frames)

Tooltip - Send email on job completion (success or failure)

Icon

Sends mail to the designated user based on the status of the job being failed

Blocked

Tooltip - Set initial state of job to "blocked"

Icon

Enable this tickbox to ensure after submission this job is in a blocked state

Stderr->Stdout

Tooltip - Redirect and consolidate the job stderr stream to the stdout stream

Icon

Enable this if you would like to combine you logs

Job Label

Tooltip - Optional label to identify the job. Must be a unique within a Job Process Group (pgrp).

Icon

Legacy method of labelling jobs see Job Tags

Job Kind

Tooltip - Arbitrary typing information that can be used to identify the job. Common usage: it can be used to restrict only 1 of this "kind" of job from running on a worker at the same time by setting the job\'s requirements to include "not (job.kind in host.duty.kind)"

Process Group

Tooltip - Job Process Group (pgrp) for logically organizing dependent jobs. Defaults to the jobid. Combination of "label" and "Process Group" (pgrp) must be unique for a job.

Retry Frame/Instance

Tooltip - Number of times to retry a failed frame/job instance. Value of -1 means use the default for the studio.

Icon

Set this to retry any failed frames or instances automatically

Retry Work Delay

Tooltip - Number of seconds to wait before automatically retrying a failed frame/work.

Icon

Set this to create a delay in second between the frame/instance retries

Subjob Timeout

Tooltip - Kill the subjob process if running for the specified time (in seconds).  Value of -1 means disabled.

Icon

Use this if the acceptable instance/subjob spawn time is known.

Frame Timeout

Tooltip - Kill the agenda/frame if running for the specified time (in seconds).  Value of -1 means disabled.

Icon

Use this if the acceptable frame time is known.

 Qube Job Environment

Cwd

Tooltip - Current Working Directory to use when running the job

Icon

Explanation needed

Environment Variables

Tooltip - Environment variables override when running a job

Icon

You can specify key/value pairs of environment variables

This is useful when you might need different settings for your render applications based on different departments or projects

Impersonate User

Tooltip - Submit a job as a specific user. Default is current user. Format <optionladomain>\<username> (advanced --requires impersonate user permissions)

Icon

You can specify which user you would like to submit the job as

This is useful for troubleshooting a job that may fail sent from a specific user

Example:

Setting "qube\josh" would attempt to submit the job with the domain "qube" and the user "josh"

Note: "impersonate user" permissions need to be set on the user submitting this job

 Qube Job Run-time-OS-specific Environment Variables

Windows-only Environment Variables

Tooltip - Windows Environment variable overrides when running job

Icon

Used to provide OS specific environment variables for Windows

Linux-only Environment Variables

Tooltip - Linux Environment variable overrides when running job

Icon

Used to provide OS specific environment variables for Linux

Darwin-only Environment Variables

Tooltip - OSX Environment variable overrides when running job

Icon

Used to provide OS specific environment variables for OSX

 Qube job Validation & RegularExpression-based Output Parsing

Min File Size

Tooltip - Minimum size for identified outputPaths (in bytes).  [0 disables test]

Icon

Used to test the created output file to ensure that it is of minimum size specified

regex_highlights

Tooltip - Regular expression for highlighting information messages from stdout/stderr

Icon

Used to add highlights into logs

regex_errors

Tooltip - Regular expression for identifying fatal errors from stdout/stderr

Icon

Used to add errors for known problematic strings. If you enter for example "error: 2145" and this error was pressent in the logs the job would be marked as failed

regex_outputPaths

Tooltip - Regular expression for identifying outputPaths of images from stdout/stderr

Icon

Used to identify the output paths for the job. This is useful for returning information to the Qube GUI so they you can right click browse output.

regex_progress

Tooltip - Regular expression for identifying in-frame/chunk progress from stdout/stderr

Icon

Used to identify strings for relaying the progress of frames

regex_maxlines

Tooltip - Maximum number of lines to store for regex matched patterns for stdout/stderr

Icon

Used to truncate the size of your log files

 Qube Actions

GenerateMovie

Tooltip - Add linked job to generate movie from output images

Icon

Select this option to create a secondary job that will wait for the render to complete then combine the output files into a movie

Note: For this to work correctly the "Qube (ImagesToMovie) Job..." has to be setup to use your studios transcoding application

 Qube Notes

Account

Tooltip - Arbitrary accounting or project data (user-specified)

Icon

This can be used for creating tags for your job

The created tags can be searched in the "Performance Charts" Tab

You can add entries by typing in the drop-down window or select already created accounts from the drop-down

See also "Qube Job Tags"

Notes

Tooltip - Freeform text for making notes on this job

Icon

Add text about the job for future reference. Viewable in the Qube UI

  • No labels