Versions Compared

    Key

    • This line was added.
    • This line was removed.
    • Formatting was changed.

    The goal of this section is to get you to install and run Qube! as quickly as possible. You will install a Supervisor, a Worker and a Client, and then submit a job from the Client to the Supervisor, which will hand it off to the Worker. All three of these roles can be played by the same machine, so if you want to investigate Qube! on a single laptop, you can do that. Or if your ambitions are larger, you can do that from here as well. Whatever your final goal, to install and start using Qube!, follow these steps.

    Before You Begin

    • The installer is designed to be run on a machine with a working internet connection, and we suggest saving the downloaded components to a network drive.
    • You must have administration privileges to install the software. 
      • For Windows users, you may want to right-click > "Run as Administrator" or just log in as the Administrator.
      • For Linux users, you must run as root or a sudoer. 
      • OS X users will be prompted to enter an admin password before installation begins.
    • Once components have been downloaded, the installer can be run again on other machines without accessing the internet by pointing it to the download location used by the previous install session.

     

    Install and Go 

    Follow these steps:

    Anchor
    start
    start
    1. Download the Install Wizard
    2. Launch the Install Wizard

    3. Install the Supervisor
    4. Install a Worker / Client
    5. Submit Test Jobs

    That's it! After you've got this far, you can submit jobs for hero applications such as Maya, 3dsMax, Nuke, and many others.

     

    Additional Possibilities

    Alternatively, you can continue with Qube! administration tasks. The Administrator's Guide explains how to keep building up your Qube! installation, including:

    Installing Licenses
    Adding Additional Workers
    Adding Additional Clients
    Tuning Qube! for Optimal Performance

     

    ...

     

    Anchor
    launch
    launch

    ...

    2. Launch the Install Wizard

    Windows

    Extract the contents of the installer zip file. Go into the folder created, right mouse click on the installer file, and run as administrator.

    ...

    $ cd /path/to/downloaded/installer
    $ tar xvzf qubeInstaller.CentOS_6.5.x86_64.tgz             # Note: of course the file name may differ depending on your Linux distribution
    $ cd qubeInstaller-2.1-2.CentOS_6.5.x86                    # move into the directory that was just created
    $ sudo ./qubeInstaller.2.1-2.CentOS_6.5                    # run the installer with sudo or as root

     

    ...


    All OSs

    In all cases, you will now see the opening screen, followed by a license agreement, which you should read and accept before continuing. 

    ...

    At this point you are ready to install one of the Qube! components. If this is your first install, keep reading and install a Supervisor. Otherwise, skip that and move to installing a Worker and Client, below

    Anchor
    supervisor
    supervisor
    3. Install the Supervisor

    The Supervisor controls and monitors the jobs that the Clients send to the Workers. There should be only one Supervisor on your network. For preliminary evaluation purposes, the Supervisor can be almost any machine, but for production use you should refer to the Supervisor guidelines on the Qube! Requirements page.

    ...

    <if you are on Windows, you get a desktop icon for Wrangler View>

     Back to Top

    Anchor
    worker
    worker
    4. Install a Worker & Client

    What's the difference? A Worker is going to render frames or run simulations or do whatever tasks you want to submit. You want one of those on every machine that you expect to be able to pick up and execute a task.

    ...

    Again, the installer will download the selected components, and then install them. When this completes, you will see buttons allowing you to submit some test jobs. We'll do that in the next section. So keep reading...

    Back to Top

    Anchor
    submit
    submit
    5. Submit Basic Test Jobs

    We assume you have a dialogue box on your screen similar to the above. To verify that the Qube! Supervisor is running and sees this Worker (and vice versa), click on "Submit basic test job". You should see it go to "Pending" and then "Running" and finally "Success!"

    ...

    At this point, your supervisor and worker are up and going. You can install more workers and/or clients by using the installer or by using the quickstart files. <need a link to that explanation> You can find help with submitting specific kinds of jobs, for example Maya or After Effects, in the Submitting Jobs section.

    Back to Top

    Licensing

    Right now Qube! is running 2 evaluation licenses (these are Designer licenses - see this page for an explanation of license types). You can use these licenses to evaluate Qube! indefinitely, but if you want to run more Workers you will need to purchase licenses. Instructions for installing additional licenses are on this page.

    ...